Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 2015da7

Browse files
authored
Merge pull request #1219 from splunk/repo-sync
Pulling refs/heads/main into main
2 parents 85bf72f + 3048b04 commit 2015da7

File tree

18 files changed

+71
-68
lines changed

18 files changed

+71
-68
lines changed

gdi/get-data-in/application/go/instrumentation/instrument-go-application.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To generate all the basic installation commands for your environment and applica
3030
Install the Splunk Distribution of OpenTelemetry Go manually
3131
==================================================================
3232

33-
Follow these instructions to install the Splunk Distribution of OpenTelemetry Go.
33+
If you don't use the guided setup, follow these instructions to manually install the Splunk Distribution of OpenTelemetry Go.
3434

3535
.. _install-enable-go-instrumentation:
3636

gdi/get-data-in/application/java/instrumentation/instrument-java-application.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To generate all the basic installation commands for your environment and applica
3030
Install the Splunk Distribution of OpenTelemetry Java manually
3131
==================================================================
3232

33-
Follow these instructions to install the Splunk Distribution of OpenTelemetry Java:
33+
If you don't use the guided setup, follow these instructions to manually install the Splunk Distribution of OpenTelemetry Java:
3434

3535
- :ref:`install-enable-jvm-agent`
3636
- :ref:`enable_profiling_java`

gdi/get-data-in/application/nodejs/instrumentation/instrument-nodejs-application.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To generate all the basic installation commands for your environment and applica
3333
Install the Splunk Distribution of OpenTelemetry JS manually
3434
==================================================================
3535

36-
Follow these instructions to install the Splunk Distribution of OpenTelemetry JS:
36+
If you don't use the guided setup, follow these instructions to manually install the Splunk Distribution of OpenTelemetry JS:
3737

3838
- :ref:`install-enable-nodejs-agent`
3939
- :ref:`enable_profiling_nodejs`

gdi/get-data-in/application/otel-dotnet/instrumentation/instrument-dotnet-application.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ To generate all the basic installation commands for your environment and applica
2828
Install the Splunk Distribution of OpenTelemetry .NET manually
2929
==================================================================
3030

31-
Follow these instructions to install the Splunk Distribution of OpenTelemetry .NET:
31+
If you don't use the guided setup, follow these instructions to manually install the Splunk Distribution of OpenTelemetry .NET:
3232

3333
- :ref:`install-dotnet-otel-instrumentation`
3434
- :ref:`configure-otel-dotnet`

gdi/get-data-in/application/otel-dotnet/sfx/instrumentation/instrument-dotnet-application.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To generate all the basic installation commands for your environment and applica
3838
Install the SignalFx Instrumentation for .NET manually
3939
==================================================================
4040

41-
Follow these instructions to install the SignalFx Instrumentation for .NET:
41+
If you don't use the guided setup, follow these instructions to manually install the SignalFx Instrumentation for .NET:
4242

4343
- :ref:`install-dotnet-instrumentation`
4444
- :ref:`instrument-windows-service`

gdi/get-data-in/application/php/instrument-php-application.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
.. _instrument-php-otel-applications:
22

33
*******************************************************************************
4-
Instrument your PHP application for Splunk Observability Cloud (OpenTelemetry)
4+
Instrument your PHP application for Splunk Observability Cloud
55
*******************************************************************************
66

77
.. meta::
88
:description: The OpenTelemetry PHP extensions automatically instruments PHP applications using a PHP extension and available instrumentation libraries. Follow these steps to get started.
99

1010
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.
1111

12-
To get started, use the guided setup or follow the instructions manually.
12+
To get started, use the guided setup or follow the instructions to install manually.
1313

1414
Generate customized instructions using the guided setup
1515
====================================================================
@@ -30,11 +30,11 @@ To generate all the basic installation commands for your environment and applica
3030
Install the Splunk Distribution of OpenTelemetry PHP manually
3131
==================================================================
3232

33-
Follow these steps to install and automatically instrument your PHP application:
33+
If you don't use the guided setup, follow these steps to manually install and automatically instrument your PHP application:
3434

3535
1. Check that you meet the requirements. See :ref:`php-otel-requirements`.
3636

37-
2. Install the OpenTelemetry PHP extension using PECL:
37+
2. Install the OpenTelemetry PHP extension using PECL in the command line:
3838

3939
.. code-block:: bash
4040

gdi/get-data-in/application/php/php-manual-instrumentation.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ The OpenTelemetry instrumentation for PHP provides a base you can build on by ad
1111

1212
.. _custom-traces-otel-php:
1313

14-
Create custom traces
14+
Create custom spans and traces
1515
===============================
1616

1717
To create custom spans and traces, follow these steps:
1818

19-
1. Create a ``TracerProvider`` if you aren't using an instrumentation library:
19+
1. Create a ``TracerProvider`` entry point if you aren't using an instrumentation library:
2020

2121
.. code-block:: php
2222
@@ -50,7 +50,7 @@ To create custom spans and traces, follow these steps:
5050
return $result;
5151
}
5252
53-
4. Optionally, set attributes:
53+
4. Optionally, set attributes to enrich your spans's metadata:
5454

5555
.. code:: php
5656
@@ -75,7 +75,7 @@ To create custom metrics, follow these steps:
7575
7676
require 'vendor/autoload.php';
7777
78-
2. Create a ``MeterProvider``:
78+
2. Create a ``MeterProvider`` entry point:
7979

8080
.. code:: php
8181

gdi/get-data-in/application/php/php-migration-guide.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,15 @@ To migrate from the SignalFx Tracing Library for PHP to the OpenTelemetry instru
3333
Uninstall the SignalFx Tracing Library for PHP
3434
---------------------------------------------------
3535

36-
To uninstall the SignalFx Tracing Library for PHP, run the following command:
36+
1. To uninstall the SignalFx Tracing Library for PHP, run the following command:
3737

3838
.. code-block:: shell
3939
4040
php signalfx-setup.php --uninstall
4141
42-
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.
42+
2. Make sure that your INI file doesn't contain references to ``signalfx-tracing.so`` and that the extension file is removed.
43+
44+
3. Optionally, delete the /opt/signalfx/signalfx-library directory.
4345

4446
.. _changes-functionality-php-otel:
4547

gdi/get-data-in/application/php/php-otel-requirements.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To send application traces and spans to Splunk Observability Cloud, install the
2525
Supported libraries and frameworks
2626
=================================================
2727

28-
The SignalFx Tracing Library for PHP instruments the following libraries and frameworks:
28+
The OpenTelemetry instrumentation supports the following libraries:
2929

3030
.. list-table::
3131
:widths: 60 40

gdi/get-data-in/application/php/sfx/configuration/advanced-php-configuration.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. caution::
22

3-
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.
3+
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.
44

5-
If you want to instrument new or existing PHP applications, use :ref:`OpenTelemetry PHP instrumentation <get-started-php>`, which offers similar capabilities.
5+
If you want to instrument new or existing PHP applications, use :ref:`OpenTelemetry PHP instrumentation <get-started-php>`, which offers similar functionalities.
66

77
.. _advanced-php-configuration:
88

@@ -20,9 +20,9 @@ The following sections describe all available settings for configuring the Signa
2020
General settings
2121
=========================================================================
2222

23-
The following settings are specific to the Splunk Distribution of OpenTelemetry Python:
23+
Use the following settings to configure the SignalFx Tracing Library for PHP:
2424

25-
.. list-table::
25+
.. list-table::
2626
:header-rows: 1
2727

2828
* - Environment variable
@@ -46,7 +46,7 @@ The following settings are specific to the Splunk Distribution of OpenTelemetry
4646
* - ``SIGNALFX_CAPTURE_REQUEST_HEADERS``
4747
- Comma-separated list of incoming request headers to turn into spans. For example, ``User-Agent`` is captured as ``http.request.headers.user_agent``.
4848
* - ``SIGNALFX_ACCESS_TOKEN``
49-
- 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.
49+
- 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.
5050

5151
.. _tracing-cli-sessions:
5252

@@ -61,7 +61,7 @@ To trace the CLI SAPI functionality, you have to activate it manually using the
6161
php artisan migrate:fresh
6262
php myTracedCliScript.php
6363
64-
.. caution:: This SAPI is deactivated by default to avoid undesired tracing of system activity.
64+
This SAPI is deactivated by default to avoid undesired tracing of system activity.
6565

6666
.. _server-trace-information-php:
6767

@@ -72,9 +72,9 @@ To connect Real User Monitoring (RUM) requests from mobile and web applications
7272

7373
.. code-block::
7474
75-
Access-Control-Expose-Headers: Server-Timing
75+
Access-Control-Expose-Headers: Server-Timing
7676
Server-Timing: traceparent;desc="00-<serverTraceId>-<serverSpanId>-01"
7777
78-
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.
78+
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.
7979

8080
.. 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``.

0 commit comments

Comments
 (0)