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

Commit 380fb01

Browse files
authored
Merge pull request #1779 from splunk/theletterf-o11ydocs-5991-php-otel-docs
Add OTel PHP docs
2 parents fbfa7d6 + f8a88ea commit 380fb01

File tree

49 files changed

+444
-171
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+444
-171
lines changed

_includes/gdi/zero-conf-reqs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66

77
- To get an access token, see :ref:`admin-api-access-tokens`.
88

9-
- To find the realm name of your account, open the navigation menu in Splunk Observability Cloud. Select :menuselection:`Settings`, and then select your username. The realm name appears in the :guilabel:`Organizations` section.
9+
- To find the realm name of your account, see :ref:`Note about realms <about-realms>`.
1010

_includes/realm-note.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
.. note:: Note about realms
22

3-
A realm is a self-contained deployment of Splunk Observability Cloud in which your organization is hosted. Different realms have different API endpoints. For example, the endpoint for sending data in the ``us1`` realm is ``https://ingest.us1.signalfx.com``, while the endpoint for sending data in the ``eu0`` realm is
4-
``https://ingest.eu0.signalfx.com``.
3+
A realm is a self-contained deployment of Splunk Observability Cloud in which your organization is hosted. Different realms have different API endpoints. For example, the endpoint for sending data in the ``us1`` realm is ``https://ingest.us1.signalfx.com``, while the endpoint for sending data in the ``eu0`` realm is ``https://ingest.eu0.signalfx.com``.
54

6-
When you see a placeholder realm name in the documentation, such as ``<YOUR_REALM>``, replace it with your actual realm name. To find your realm name, open the left navigation menu in Observability Cloud, select :menuselection:`Settings`, and select your username. The realm name appears in the :guilabel:`Organizations` section. If you don't include the realm name when specifying an endpoint, Observability Cloud defaults to the ``us0`` realm.
5+
When you see a placeholder realm name in the documentation, such as ``<YOUR_REALM>``, replace it with your actual realm name. To find your realm name, open the navigation menu in Splunk Observability Cloud, select :menuselection:`Settings`, and select your username. The realm name appears in the :guilabel:`Organizations` section. If you don't include the realm name when specifying an endpoint, Splunk Observability Cloud defaults to the ``us0`` realm.

_includes/requirements/php.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
The SignalFx Tracing Library for PHP supports PHP version 7.0 or higher running on the Zend engine.
1+
The OpenTelemetry instrumentation for PHP supports PHP version 8.0 or higher.
22

3-
Supported web servers are:
4-
5-
- Apache
6-
- php-fpm
7-
- php-cli
8-
9-
.. note:: The library is not compatible with Windows environments.
3+
.. note:: The library is not supported for Windows environments.

admin/authentication/SSO/sso.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Configure SSO integrations for Splunk Observability Cloud
1212
Splunk Observability Cloud provides SSO login service integrations that let your users log in using a third-party
1313
identity provider (IdP) that uses SAML SSO. Observability Cloud supports SSO initiated by the IdP.
1414

15-
Observability Cloud also supports SSO initiated by Observability Cloud, and this option lets your users log in to Infrastructure Monitoring using a custom URL you specify.
15+
Splunk Observability Cloud also supports SSO initiated by Observability Cloud, and this option lets your users log in to Infrastructure Monitoring using a custom URL you specify.
1616

17-
Observability Cloud supports the following SSO integrations:
17+
Splunk Observability Cloud supports the following SSO integrations:
1818

1919
- :ref:`Splunk Cloud Platform<unified-id-unified-identity>`
2020
- :ref:`Microsoft Active Directory Federation Services (ADFS)<sso-adfs>`

apm/set-up-apm/apm-gdi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ In the following table, follow the instrumentation steps for the language that e
119119
- :ref:`get-started-ruby`
120120

121121
* - PHP
122-
- SignalFx Tracing Library for PHP
122+
- OpenTelemetry instrumentation for PHP
123123
- :ref:`get-started-php`
124124

125125
After you instrument your applications, you're ready to verify that your data is coming in.

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

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -174,13 +174,7 @@ If you need to send data directly to Splunk Observability Cloud, set the followi
174174

175175
To obtain an access token, see :ref:`admin-api-access-tokens`.
176176

177-
In the ingest endpoint URL, ``realm`` is the Splunk Observability Cloud realm, for example, ``us0``. To find the realm name of your account, follow these steps:
178-
179-
#. Open the navigation menu in Splunk Observability Cloud.
180-
#. Select :menuselection:`Settings`.
181-
#. Select your username.
182-
183-
The realm name appears in the :guilabel:`Organizations` section.
177+
To find your Splunk realm, see :ref:`Note about realms <about-realms>`.
184178

185179
For more information on the ingest API endpoints, see :new-page:`Send APM traces <https://dev.splunk.com/observability/docs/apm/send_traces/>` and :new-page:`Send data points <https://dev.splunk.com/observability/docs/datamodel/ingest#Send-data-points>`.
186180

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

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -262,13 +262,7 @@ If you need to send data directly to Splunk Observability Cloud, set the followi
262262

263263
To obtain an access token, see :ref:`admin-api-access-tokens`.
264264

265-
In the ingest endpoint URL, ``realm`` is the Splunk Observability Cloud realm, for example, ``us0``. To find the realm name of your account, follow these steps:
266-
267-
#. Open the navigation menu in Splunk Observability Cloud.
268-
#. Select :menuselection:`Settings`.
269-
#. Select your username.
270-
271-
The realm name appears in the :guilabel:`Organizations` section.
265+
To find your Splunk realm, see :ref:`Note about realms <about-realms>`.
272266

273267
For more information on the ingest API endpoints, see :new-page:`Send APM traces <https://dev.splunk.com/observability/docs/apm/send_traces/>`.
274268

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

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -280,13 +280,7 @@ If you need to send data directly to Splunk Observability Cloud, set the followi
280280

281281
To obtain an access token, see :ref:`admin-api-access-tokens`.
282282

283-
In the ingest endpoint URL, ``realm`` is the Splunk Observability Cloud realm, for example, ``us0``. To find the realm name of your account, follow these steps:
284-
285-
#. Open the navigation menu in Splunk Observability Cloud.
286-
#. Select :menuselection:`Settings`.
287-
#. Select your username.
288-
289-
The realm name appears in the :guilabel:`Organizations` section.
283+
To find your Splunk realm, see :ref:`Note about realms <about-realms>`.
290284

291285
For more information on the ingest API endpoints, see :new-page:`Send APM traces <https://dev.splunk.com/observability/docs/apm/send_traces/>`.
292286

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

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -343,13 +343,7 @@ To bypass the OTel Collector and send data directly to Splunk Observability Clou
343343

344344
To obtain an access token, see :ref:`admin-api-access-tokens`.
345345

346-
In the ingest endpoint URL, ``realm`` is the Splunk Observability Cloud realm, for example, ``us0``. To find the realm name of your account, follow these steps:
347-
348-
#. Open the navigation menu in Splunk Observability Cloud.
349-
#. Select :menuselection:`Settings`.
350-
#. Select your username.
351-
352-
The realm name appears in the :guilabel:`Organizations` section.
346+
To find your Splunk realm, see :ref:`Note about realms <about-realms>`.
353347

354348
Specify the source host
355349
----------------------------------------------

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ To create custom spans and traces, follow these steps:
4343
4444
4. Register your ``ActivitySource`` by setting the ``OTEL_DOTNET_AUTO_TRACES_ADDITIONAL_SOURCES`` environmental variable. You can set the value to either ``Examples.ManualInstrumentations.Registered`` or to ``Examples.ManualInstrumentations.*``, which registers the entire prefix.
4545

46+
See the :new-page:`OpenTelemetry official documentation <https://opentelemetry.io/docs/languages/net/instrumentation/#traces>` for additional information and examples.
47+
4648
.. _custom-metrics-otel-dotnet:
4749

4850
Create custom metrics
@@ -79,3 +81,5 @@ To create custom metrics, follow these steps:
7981
.. code:: bash
8082
8183
OTEL_DOTNET_AUTO_METRICS_ADDITIONAL_SOURCES=My.Application
84+
85+
See the :new-page:`OpenTelemetry official documentation <https://opentelemetry.io/docs/languages/net/instrumentation/#metrics` for additional information and examples.

0 commit comments

Comments
 (0)