Apply PHP docs edits

theletterf · theletterf · commit d7e33b8bb38a · 2024-03-04T16:21:41.000+01:00
diff --git a/gdi/get-data-in/application/php/instrument-php-application.rst b/gdi/get-data-in/application/php/instrument-php-application.rst
@@ -1,15 +1,15 @@
 .. _instrument-php-otel-applications:
 
 *******************************************************************************
-Instrument your PHP application for Splunk Observability Cloud (OpenTelemetry)
+Instrument your PHP application for Splunk Observability Cloud
 *******************************************************************************
 
 .. meta::
    :description: The OpenTelemetry PHP extensions automatically instruments PHP applications using a PHP extension and available instrumentation libraries. Follow these steps to get started.
 
 The OpenTelemetry PHP extension automatically instruments PHP applications using a PHP extension and available instrumentation libraries. You can send telemetry to the Splunk Distribution of OpenTelemetry Collector or directly to the Splunk Observability Cloud ingest endpoint.
 
-To get started, use the guided setup or follow the instructions manually.
+To get started, use the guided setup or follow the instructions to install manually.
 
 Generate customized instructions using the guided setup
 ====================================================================
@@ -30,11 +30,11 @@ To generate all the basic installation commands for your environment and applica
 Install the Splunk Distribution of OpenTelemetry PHP manually
 ==================================================================
 
-Follow these steps to install and automatically instrument your PHP application:
+If you don't use the guided setup, follow these steps to manually install and automatically instrument your PHP application:
 
 1. Check that you meet the requirements. See :ref:`php-otel-requirements`.
 
-2. Install the OpenTelemetry PHP extension using PECL:
+2. Install the OpenTelemetry PHP extension using PECL in the command line:
 
    .. code-block:: bash
 
diff --git a/gdi/get-data-in/application/php/php-manual-instrumentation.rst b/gdi/get-data-in/application/php/php-manual-instrumentation.rst
@@ -11,12 +11,12 @@ The OpenTelemetry instrumentation for PHP provides a base you can build on by ad
 
 .. _custom-traces-otel-php:
 
-Create custom traces
+Create custom spans and traces
 ===============================
 
 To create custom spans and traces, follow these steps:
 
-1. Create a ``TracerProvider`` if you aren't using an instrumentation library:
+1. Create a ``TracerProvider`` entry point if you aren't using an instrumentation library:
 
    .. code-block:: php
 
@@ -50,7 +50,7 @@ To create custom spans and traces, follow these steps:
          return $result;
       }
 
-4. Optionally, set attributes:
+4. Optionally, set attributes to enrich your spans's metadata:
 
    .. code:: php
 
@@ -75,7 +75,7 @@ To create custom metrics, follow these steps:
 
       require 'vendor/autoload.php';
 
-2. Create a ``MeterProvider``:
+2. Create a ``MeterProvider`` entry point:
 
    .. code:: php
 
diff --git a/gdi/get-data-in/application/php/php-migration-guide.rst b/gdi/get-data-in/application/php/php-migration-guide.rst
@@ -33,13 +33,15 @@ To migrate from the SignalFx Tracing Library for PHP to the OpenTelemetry instru
 Uninstall the SignalFx Tracing Library for PHP
 ---------------------------------------------------
 
-To uninstall the SignalFx Tracing Library for PHP, run the following command:
+1. To uninstall the SignalFx Tracing Library for PHP, run the following command:
 
 .. code-block:: shell
 
    php signalfx-setup.php --uninstall
 
-Make sure that your .ini file doesn't contain references to ``signalfx-tracing.so`` and that the extension file has been removed. Optionally, you can delete the /opt/signalfx/signalfx-library directory.
+2. Make sure that your INI file doesn't contain references to ``signalfx-tracing.so`` and that the extension file is removed.
+
+3. Optionally, delete the /opt/signalfx/signalfx-library directory.
 
 .. _changes-functionality-php-otel:
 
diff --git a/gdi/get-data-in/application/php/php-otel-requirements.rst b/gdi/get-data-in/application/php/php-otel-requirements.rst
@@ -25,7 +25,7 @@ To send application traces and spans to Splunk Observability Cloud, install the
 Supported libraries and frameworks
 =================================================
 
-The SignalFx Tracing Library for PHP instruments the following libraries and frameworks:
+The OpenTelemetry instrumentation supports the following libraries:
 
 .. list-table::
    :widths: 60 40
diff --git a/gdi/get-data-in/application/php/sfx/configuration/advanced-php-configuration.rst b/gdi/get-data-in/application/php/sfx/configuration/advanced-php-configuration.rst
@@ -1,8 +1,8 @@
 .. caution::
 
-   The SignalFx Tracing Library for PHP is deprecated as of February 21, 2024 and will reach End of Support on February 21 2025. Until then, only critical security fixes and bug fixes will be provided. After the date, the library will be archived and no longer maintained.
+   The SignalFx Tracing Library for PHP is deprecated as of February 21, 2024 and will reach End of Support (EOS) on February 21 2025. Until then, only critical security fixes and bug fixes will be provided. After the EOS date, the library will be archived and no longer maintained.
 
-   If you want to instrument new or existing PHP applications, use :ref:`OpenTelemetry PHP instrumentation <get-started-php>`, which offers similar capabilities.
+   If you want to instrument new or existing PHP applications, use :ref:`OpenTelemetry PHP instrumentation <get-started-php>`, which offers similar functionalities.
 
 .. _advanced-php-configuration:
 
@@ -20,9 +20,9 @@ The following sections describe all available settings for configuring the Signa
 General settings
 =========================================================================
 
-The following settings are specific to the Splunk Distribution of OpenTelemetry Python:
+Use the following settings to configure the SignalFx Tracing Library for PHP:
 
-.. list-table:: 
+.. list-table::
    :header-rows: 1
 
    * - Environment variable
@@ -46,7 +46,7 @@ The following settings are specific to the Splunk Distribution of OpenTelemetry
    * - ``SIGNALFX_CAPTURE_REQUEST_HEADERS``
      - Comma-separated list of incoming request headers to turn into spans. For example, ``User-Agent`` is captured as ``http.request.headers.user_agent``.
    * - ``SIGNALFX_ACCESS_TOKEN``
-     - Splunk authentication token that lets the library send data directly to Splunk Observability Cloud. Unset by default. Not required unless you need to send data to the Splunk Observability Cloud ingest endpoint. See :ref:`export-directly-to-olly-cloud-php` for more information.
+     - Splunk Observability Cloud authentication token that lets the library send data directly to Splunk Observability Cloud. Unset by default. Not required unless you need to send data to the Splunk Observability Cloud ingest endpoint. See :ref:`export-directly-to-olly-cloud-php` for more information.
 
 .. _tracing-cli-sessions:
 
@@ -61,7 +61,7 @@ To trace the CLI SAPI functionality, you have to activate it manually using the
    php artisan migrate:fresh
    php myTracedCliScript.php
 
-.. caution:: This SAPI is deactivated by default to avoid undesired tracing of system activity.
+This SAPI is deactivated by default to avoid undesired tracing of system activity.
 
 .. _server-trace-information-php:
 
@@ -72,9 +72,9 @@ To connect Real User Monitoring (RUM) requests from mobile and web applications
 
 .. code-block::
 
-   Access-Control-Expose-Headers: Server-Timing 
+   Access-Control-Expose-Headers: Server-Timing
    Server-Timing: traceparent;desc="00-<serverTraceId>-<serverSpanId>-01"
 
-The ``Server-Timing`` header contains the ``traceId`` and ``spanId`` parameters in ``traceparent`` format. For more information, see the Server-Timing and traceparent documentation on the W3C website.
+The ``Server-Timing`` header contains the ``traceId`` and ``spanId`` parameters in ``traceparent`` format. For more information, see the ``Server-Timing`` and ``traceparent`` documentation on the W3C website.
 
 .. note:: If you need to deactivate trace response headers, set ``SIGNALFX_TRACE_RESPONSE_HEADER_ENABLED`` to ``false`` or set the ``signalfx.trace.response_header_enabled`` option in your INI file to ``false``.
diff --git a/gdi/get-data-in/application/php/sfx/instrumentation/instrument-php-application.rst b/gdi/get-data-in/application/php/sfx/instrumentation/instrument-php-application.rst
@@ -1,13 +1,13 @@
 .. caution::
 
-   The SignalFx Tracing Library for PHP is deprecated as of February 21, 2024 and will reach End of Support on February 21 2025. Until then, only critical security fixes and bug fixes will be provided. After the date, the library will be archived and no longer maintained.
+   The SignalFx Tracing Library for PHP is deprecated as of February 21, 2024 and will reach End of Support (EOS) on February 21 2025. Until then, only critical security fixes and bug fixes will be provided. After the EOS date, the library will be archived and no longer maintained.
 
-   If you want to instrument new or existing PHP applications, use :ref:`OpenTelemetry PHP instrumentation <get-started-php>`, which offers similar capabilities.
+   If you want to instrument new or existing PHP applications, use :ref:`OpenTelemetry PHP instrumentation <get-started-php>`, which offers similar functionalities.
 
 .. _instrument-php-applications:
 
 ***************************************************************************
-Instrument your PHP application for Splunk Observability Cloud
+Instrument your PHP application for Splunk Observability Cloud (deprecated)
 ***************************************************************************
 
 .. meta::
@@ -38,7 +38,7 @@ To generate all the basic installation commands for your environment and applica
 Install the SignalFx Tracing Library for PHP manually
 ==================================================================
 
-Follow these instructions to install the SignalFx Tracing Library for PHP:
+If you don't use the guided setup, follow these instructions to manually install the SignalFx Tracing Library for PHP:
 
 #. :ref:`install-php-instrumentation`
 #. :ref:`deploy-php`
@@ -54,7 +54,7 @@ Follow these steps to automatically instrument your application:
 #. Check that you meet the requirements. See :ref:`php-requirements`.
 
 #. Download the installation script from the following location:
-   
+
    .. code-block:: shell
 
       curl -LO  https://github.com/signalfx/signalfx-php-tracing/releases/latest/download/signalfx-setup.php
@@ -89,7 +89,7 @@ Follow these steps to automatically instrument your application:
             export SIGNALFX_ENDPOINT_URL='http://localhost:9080/v1/trace'
             export SIGNALFX_TRACE_GLOBAL_TAGS="deployment.environment:<my_environment>"
 
-         .. caution:: Set environment variables globally or using the start script of your PHP application.
+         Set environment variables globally or using the start script of your PHP application.
 
 #. Restart your server.
 
@@ -109,15 +109,19 @@ You can use the ``signalfx-setup.php`` script to set INI file options without ha
 .. code-block:: shell
 
    php signalfx-setup.php --update-config --signalfx.endpoint_url=http://172.17.0.1:9080/v1/trace
-   
+
 This is useful for options common to all PHP services running in the system, like endpoints.
 
 .. _deploy-php:
 
 Deploy the PHP instrumentation in your environment
 =====================================================
 
-You can deploy the PHP instrumentation in Docker, Kubernetes, or send data directly to Splunk Observability Cloud. See the following sections for more information.
+You can deploy the PHP instrumentation in Docker or, Kubernetes, or you can send data directly to Splunk Observability Cloud. See the following sections for instructions for your environment:
+
+* :ref:`docker_php`
+* :ref:`kubernetes_php`
+* :ref:`export-directly-to-olly-cloud-php`
 
 .. _docker_php:
 
@@ -140,17 +144,17 @@ You can deploy the PHP instrumentation using Docker. Follow these steps to get s
       php signalfx-setup.php --update-config --signalfx.access_token=<access_token>
       php signalfx-setup.php --update-config --signalfx.service_name=<service-name>
 
-#. Add a line to the script to start the application using ``supervisorctl``, ``supervisord``, ``systemd``, or similar. The following example uses ``supervisorctl``:
+#. Add a line to the script to start the application using the ``supervisorctl``, ``supervisord``, ``systemd``, or a similar command. The following example uses ``supervisorctl``:
 
    .. code-block:: shell
 
       supervisor start my-php-app
 
 #. Add a command to run the newly created shell script at the end of the Dockerfile.
 
-#. Rebuild the container using ``docker build``.
+#. Rebuild the container using the ``docker build`` command.
 
-Next, configure the PHP instrumentation for Splunk Observability Cloud. See :ref:`advanced-php-configuration` for more information.
+Next, configure the PHP instrumentation for Splunk Observability Cloud. See :ref:`advanced-php-configuration`.
 
 .. caution:: Make sure to deactivate the ``Xdebug`` extension, as it's not compatible with the PHP instrumentation.
 
@@ -193,12 +197,12 @@ The following example shows how to update a deployment to expose environment var
              - name: SIGNALFX_TRACE_GLOBAL_TAGS
                value: "deployment.environment:<my_environment>"
 
-Next, configure the PHP instrumentation for Splunk Observability Cloud. See :ref:`advanced-php-configuration` for more information.
+Next, configure the PHP instrumentation for Splunk Observability Cloud. See :ref:`advanced-php-configuration`.
 
 .. _export-directly-to-olly-cloud-php:
 
 Send data directly to Splunk Observability Cloud
-=====================================================
+-----------------------------------------------------
 
 By default, all telemetry is sent to the local instance of the Splunk Distribution of OpenTelemetry Collector.
 
@@ -216,15 +220,12 @@ To bypass the OTel Collector and send data directly to Splunk Observability Clou
       export SIGNALFX_ACCESS_TOKEN=<access_token>
       export SIGNALFX_ENDPOINT_URL=https://ingest.<realm>.signalfx.com/v2/trace/signalfxv1
 
+.. include:: /_includes/gdi/apm-api-define-host.rst
+
 To obtain an access token, see :ref:`admin-api-access-tokens`.
 
 To find your Splunk realm, see :ref:`Note about realms <about-realms>`.
 
 Next, configure the PHP instrumentation for Splunk Observability Cloud. See :ref:`advanced-php-configuration` for more information.
 
 .. note:: For more information on the ingest API endpoints, see :new-page:`Send APM traces <https://dev.splunk.com/observability/docs/apm/send_traces/>`.
-
-Specify the source host
------------------------------------------------
-
-.. include:: /_includes/gdi/apm-api-define-host.rst
diff --git a/gdi/get-data-in/application/php/sfx/instrumentation/php-manual-instrumentation.rst b/gdi/get-data-in/application/php/sfx/instrumentation/php-manual-instrumentation.rst
@@ -1,8 +1,8 @@
 .. caution::
 
-   The SignalFx Tracing Library for PHP is deprecated as of February 21, 2024 and will reach End of Support on February 21 2025. Until then, only critical security fixes and bug fixes will be provided. After the date, the library will be archived and no longer maintained.
+   The SignalFx Tracing Library for PHP is deprecated as of February 21, 2024 and will reach End of Support (EOS) on February 21 2025. Until then, only critical security fixes and bug fixes will be provided. After the EOS date, the library will be archived and no longer maintained.
 
-   If you want to instrument new or existing PHP applications, use :ref:`OpenTelemetry PHP instrumentation <get-started-php>`, which offers similar capabilities.
+   If you want to instrument new or existing PHP applications, use :ref:`OpenTelemetry PHP instrumentation <get-started-php>`, which offers similar functionalities.
 
 .. _php-manual-instrumentation:
 
diff --git a/gdi/get-data-in/application/php/sfx/php-requirements.rst b/gdi/get-data-in/application/php/sfx/php-requirements.rst
@@ -1,21 +1,21 @@
 .. caution::
 
-   The SignalFx Tracing Library for PHP is deprecated as of February 21, 2024 and will reach End of Support on February 21 2025. Until then, only critical security fixes and bug fixes will be provided. After the date, the library will be archived and no longer maintained.
+   The SignalFx Tracing Library for PHP is deprecated as of February 21, 2024 and will reach End of Support (EOS) on February 21 2025. Until then, only critical security fixes and bug fixes will be provided. After the EOS date, the library will be archived and no longer maintained.
 
-   If you want to instrument new or existing PHP applications, use :ref:`OpenTelemetry PHP instrumentation <get-started-php>`, which offers similar capabilities.
+   If you want to instrument new or existing PHP applications, use :ref:`OpenTelemetry PHP instrumentation <get-started-php>`, which offers similar functionalities.
 
 .. _php-requirements:
 
-*************************************************************
-PHP instrumentation compatibility and requirements
-*************************************************************
+***************************************************************
+PHP instrumentation compatibility and requirements (deprecated)
+***************************************************************
 
 .. meta::
     :description: This is what you need to instrument PHP applications for Splunk Observability Cloud.
 
 The SignalFx Tracing Library for PHP supports PHP version 7.0 or higher running on the Zend engine.
 
-Supported web servers are:
+PHP instrumentation is supported for these web servers:
 
 - Apache
 - php-fpm
@@ -30,7 +30,7 @@ Supported libraries and frameworks
 
 The SignalFx Tracing Library for PHP instruments the following libraries and frameworks:
 
-.. list-table:: 
+.. list-table::
    :widths: 60 40
    :width: 100%
    :header-rows: 1
@@ -40,7 +40,7 @@ The SignalFx Tracing Library for PHP instruments the following libraries and fra
    * - CakePHP
      - 2.x
    * - CodeIgniter
-     - 2.2 and higher 
+     - 2.2 and higher
    * - Curl
      - All supported PHP versions
    * - Drupal
@@ -72,7 +72,7 @@ The SignalFx Tracing Library for PHP instruments the following libraries and fra
    * - Symfony
      - 3.3, 3.4, 4.x, 5.x
    * - Wordpress
-     - 4.8, 5.5 and higher
+     - 4.8 or 5.5 and higher
    * - Yii
      - 2.0 
    * - Zend
diff --git a/gdi/get-data-in/application/php/sfx/sfx-instrumentation.rst b/gdi/get-data-in/application/php/sfx/sfx-instrumentation.rst
@@ -1,13 +1,13 @@
 .. caution::
 
-   The SignalFx Tracing Library for PHP is deprecated as of February 21, 2024 and will reach End of Support on February 21 2025. Until then, only critical security fixes and bug fixes will be provided. After the date, the library will be archived and no longer maintained.
+   The SignalFx Tracing Library for PHP is deprecated as of February 21, 2024 and will reach End of Support (EOS) on February 21 2025. Until then, only critical security fixes and bug fixes will be provided. After the EOS date, the library will be archived and no longer maintained.
 
-   If you want to instrument new or existing PHP applications, use :ref:`OpenTelemetry PHP instrumentation <get-started-php>`, which offers similar capabilities.
+   If you want to instrument new or existing PHP applications, use :ref:`OpenTelemetry PHP instrumentation <get-started-php>`, which offers similar functionalities.
 
 .. _sfx-php-deprecated:
 
 ***********************************************************
-SignalFx Tracing Library for PHP (Deprecated)
+SignalFx Tracing Library for PHP (deprecated)
 ***********************************************************
 
 .. meta::
