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

Commit b2c1cfd

Browse files
Merge pull request #1678 from splunk/repo-sync
Pulling refs/heads/main into main
2 parents ee05451 + 71f7a4e commit b2c1cfd

File tree

13 files changed

+255
-118
lines changed

13 files changed

+255
-118
lines changed

gdi/get-data-in/application/python/get-started.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,12 @@ Instrument Python applications for Splunk Observability Cloud
2424
Migrate to Splunk Python 2.X <migration-guide>
2525
Version 1.X (deprecated) <version1x/get-started-1x>
2626

27-
The Splunk Distribution of OpenTelemetry Python provides a Python agent that automatically adds APM instrumentation to your Python application. The instrumentation captures distributed traces and metrics and sends them to Splunk Observability Cloud.
27+
The Splunk Distribution of OpenTelemetry Python provides a Python agent that automatically adds APM instrumentation to your Python application. The instrumentation captures distributed traces and metrics and sends them to Splunk Observability Cloud. For more information, see :ref:`splunk-python-otel-dist`.
2828

2929
To instrument your Python application, follow these steps:
3030

3131
#. Check compatibility and requirements. See :ref:`python-otel-requirements`.
3232
#. Instrument your Python application. See :ref:`instrument-python-applications`.
3333
#. Configure your instrumentation. See :ref:`configure-python-instrumentation`.
3434

35-
For more information, see :ref:`splunk-python-otel-dist`.
36-
37-
.. note:: The SignalFx Python Agent is deprecated and will reach End of Support on December 17th, 2022. See :ref:`migrate-signalfx-python-agent-to-otel` to migrate to the Splunk Distribution of OpenTelemetry Python.
35+
.. note:: The SignalFx Python Agent is deprecated and has reached End of Support. See :ref:`migrate-signalfx-python-agent-to-otel` to migrate to the Splunk Distribution of OpenTelemetry Python.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ The following example shows how to update a deployment to expose environment var
214214
Send data directly to Splunk Observability Cloud
215215
==========================================================
216216

217-
By default, the agent sends all telemetry to the local instance of the Splunk Distribution of OpenTelemetry Collector.
217+
By default, the agent sends all telemetry to the local instance of the Splunk Distribution of the OpenTelemetry Collector.
218218

219219
To send data directly to Splunk Observability Cloud, set the following environment variables:
220220

gdi/opentelemetry/automatic-discovery/k8s/k8s-advanced-config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _k8s-advanced-auto-discovery-config:
22

33
********************************************************************************
4-
Advanced customization for automatic discovery and instrumtenation in Kubernetes
4+
Advanced customization for automatic discovery and instrumentation in Kubernetes
55
********************************************************************************
66

77
.. meta::

gdi/opentelemetry/automatic-discovery/k8s/k8s-java-traces-tutorial/deploy-collector-k8s-java.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,12 @@ Deploy the Spring Petclinic Java application in your Kubernetes cluster:
9696
annotations:
9797
# Activates zero-code instrumentation for the Java application
9898
instrumentation.opentelemetry.io/inject-java: "true"
99-
spec:
100-
containers:
101-
- name: petclinic-app
102-
# Java application to instrument
103-
image: ghcr.io/pavolloffay/spring-petclinic:latest
104-
imagePullPolicy: Always
99+
spec:
100+
containers:
101+
- name: petclinic-app
102+
# Java application to instrument
103+
image: ghcr.io/pavolloffay/spring-petclinic:latest
104+
imagePullPolicy: Always
105105
106106
#. Run the following command to start the application deployment:
107107

gdi/opentelemetry/collector-kubernetes/collector-kubernetes-intro.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,6 @@ To install the Splunk Distribution of the OpenTelemetry Collector for Kubernetes
4343
* :ref:`kubernetes-helm-architecture`
4444
* :ref:`kubernetes-helm-releases`
4545

46-
.. note:: By default you'll obtain these :ref:`Kubernetes metrics <ootb-metrics-k8s>`.
47-
4846
Optionally, you can also:
4947

5048
* :ref:`otel-install-k8s-manifests`
@@ -66,8 +64,6 @@ To configure the Collector see:
6664
* :ref:`kubernetes-config-logs`
6765
* :ref:`otel-kubernetes-config-advanced`
6866

69-
70-
7167
.. raw:: html
7268

7369
<div class="include-start" id="gdi/collector-common-options.rst"></div>
@@ -78,8 +74,18 @@ To configure the Collector see:
7874

7975
<div class="include-stop" id="gdi/collector-common-options.rst"></div>
8076

77+
.. raw:: html
78+
79+
<embed>
80+
<h2>Metrics and other telemetry<a name="k8s-metrics" class="headerlink" href="#k8s-metrics" title="Permalink to this headline">¶</a></h2>
81+
</embed>
82+
83+
If you use the default configuration for the Splunk Distribution of the Collector you'll obtain these :ref:`Kubernetes metrics <ootb-metrics-k8s>`.
8184

85+
To obtain additional telemetry from other sources see:
8286

87+
* :ref:`kubernetes-config-add`
88+
* :ref:`receiver-creator-receiver` to create new receivers at runtime
8389

8490
.. raw:: html
8591

gdi/opentelemetry/collector-kubernetes/kubernetes-config-add.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ Configure the Collector for Kubernetes with Helm: Add components and data source
77
.. meta::
88
:description: Optional configurations for the Splunk Distribution of OpenTelemetry Collector for Kubernetes: Add components or new data sources.
99

10-
Read on to learn how to add additional components or data sources to your Collector for Kubernetes config.
10+
Read on to learn how to add additional components or data sources to your Collector for Kubernetes config. To create new receivers at runtime see :ref:`receiver-creator-receiver`.
1111

1212
For other config options, see:
1313

1414
* :ref:`otel-kubernetes-config`
1515
* :ref:`discovery-mode-k8s`
1616
* :ref:`kubernetes-config-logs`
1717
* :ref:`otel-kubernetes-config-advanced`
18-
18+
1919
For a practical example of how to configure the Collector for Kubernetes see :ref:`about-collector-configuration-tutorial-k8s`.
2020

2121
.. _otel-kubernetes-config-add-components:

gdi/opentelemetry/data-processing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Connect pipelines with connectors
4545

4646
You can use connectors to connect two pipelines. Connectors consume data as an exporter at the end of one pipeline and emit data as a receiver at the start of another pipeline. They can consume and emit data of the same data type, or of different data types. Use connectors to generate and emit data which summarizes the data you've already consumed, or to simply replicate or route data.
4747

48-
Learn more at:ref:`otel-components-connectors`.
48+
Learn more at :ref:`otel-components-connectors`.
4949

5050
Example of a pipeline configuration
5151
--------------------------------------------------------------------

gdi/opentelemetry/deployments/otel-deployments.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,5 @@ See also the install options available for each platform:
3535
* :ref:`collector-kubernetes-intro` and :ref:`otel-install-k8s`
3636
* :ref:`collector-linux-intro` and :ref:`otel-install-linux`, including instructions on how to deploy using Ansible, Chef, Puppet and Salt
3737
* :ref:`collector-windows-intro` and :ref:`otel-install-windows`, including instructions on how to deploy using Ansible, Chef and Puppet
38+
39+
.. note:: To install the Collector in a Mac environment refer to the :new-page:`binary available in the Splunk Distribution of the OpenTelemetry Collector GitHub repo <https://github.com/signalfx/splunk-otel-collector/releases>`.

gdi/opentelemetry/install-the-collector.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Get started with the available options to install, deploy, and configure the Spl
3838
<h2>Install the Collector using packages and deployment tools<a name="collector-package-install" class="headerlink" href="#collector-package-install" title="Permalink to this headline">¶</a></h2>
3939
</embed>
4040

41-
The Splunk Distribution of the OpenTelemetry Collector is supported on Kubernetes, Linux, Windows, and Mac. Use one of the following packages to gather data for Splunk Observability Cloud:
41+
The Splunk Distribution of the OpenTelemetry Collector is supported on Kubernetes, Linux, and Windows. Use one of the following packages to gather data for Splunk Observability Cloud:
4242

4343
* :ref:`collector-kubernetes-intro`
4444
* :ref:`collector-linux-intro`

gdi/opentelemetry/opentelemetry.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The Splunk Distribution of the OpenTelemetry Collector is a distribution of the
7171
Splunk officially supports the Splunk Distribution of the OpenTelemetry Collector.
7272
Splunk only provides best-effort support for the upstream OpenTelemetry Collector. See :ref:`using-upstream-otel` for more information.
7373

74-
While Splunk Observability Cloud would work with any of the Collector versions as it's native OTel, Splunk can provide better support response for the Splunk distribution. Any changes to the Contrib or Base OpenTelemetry Collector are required to go through the open-source vetting process, which can take some time. If you use the Splunk version, updates and hot fixes are under Splunk control. Note that all major additions to the Splunk version of the Collector do eventually make their way into the Contrib version.
74+
Splunk Observability Cloud is OTel native and works with any of the Collector versions. However, Splunk can provide better support response for the Splunk distribution. Any changes to the Contrib or Base OpenTelemetry Collector are required to go through the open-source vetting process, which can take some time. If you use the Splunk version, updates and hot fixes are under Splunk control. Note that all major additions to the Splunk version of the Collector do eventually make their way into the Contrib version.
7575

7676
Also, the customizations in the Splunk distribution include these additional features:
7777

@@ -80,6 +80,8 @@ Also, the customizations in the Splunk distribution include these additional fea
8080
* Automatic discovery and configuration
8181
* Fluentd for log capture, deactivated by default
8282

83+
.. note:: Check out the :new-page:`Splunk Distribution of the OpenTelemetry Collector repo in GitHub <https://github.com/signalfx/splunk-otel-collector>` for more details.
84+
8385
.. raw:: html
8486

8587
<embed>

0 commit comments

Comments
 (0)