Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pulling refs/heads/main into main #1562

Merged
merged 5 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion admin/notif-services/splunkplatform.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Step 1: Create a Splunk platform integration in Splunk Observability Cloud
- Enter the HTTP Event Collector (HEC) URI for your Splunk platform instance. To learn more, see the :new-page:`Send data to HTTP Event Collector <https://docs.splunk.com/Documentation/SplunkCloud/9.1.2312/Data/UsetheHTTPEventCollector#Send_data_to_HTTP_Event_Collector>` section in the *Documentation for Splunk Cloud Platform*.

* - HEC token
- Enter the HTTP Event Collector token that allows access to your Splunk platform instance. To learn more, see :new-page:`Set up and use HTTP Event Collector in Splunk Web <https://docs.splunk.com/Documentation/SplunkCloud/9.2.2403/Data/UsetheHTTPEventCollector>`.
- Enter the HTTP Event Collector token that allows access to your Splunk platform instance. To learn more, see :new-page:`Set up and use HTTP Event Collector <https://docs.splunk.com/Documentation/SplunkCloud/9.2.2403/Data/UsetheHTTPEventCollector>` in Splunk Web .

.. note:: Splunk Observability Cloud doesn't support HEC indexer acknowledgement. To use the Splunk platform integration, don't activate indexer acknowledgement for HEC token in your Splunk Enterprise instance.

Expand Down
2 changes: 1 addition & 1 deletion admin/notif-services/webhook.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ the request to your webhook is secure and valid.

To learn more about the shared secret string, the cryptographic algorithm, and the message code, see the
:new-page:`Shared secret <https://dev.splunk.com/observability/docs/integrations/webhook_integration_overview/#Shared-secret>` section in
the :emphasis:`Splunk Observability Cloud Developers Guide`.
the :emphasis:`Splunk Observability Cloud Developers Guide` docs.

Your webhook must return a HTTP ``200 OK`` response code immediately after you receive the request.
If Splunk Observability Cloud does not receive a 200 response code within a certain time frame, it retries the request.
Expand Down
2 changes: 1 addition & 1 deletion gdi/get-data-in/application/cpp/get-started-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ To learn how to instrument your C++ applications, see :ref:`instrument-cpp`.

.. note::

The Splunk instrumentation for C++ has been deprecated as of March 15, 2024, and it will reach end of support on September 15, 2025. If you're using the Splunk instrumentation, you can migrate to the upstream OpenTelemetry C++ instrumentation. To learn how, see :ref:`migrate-from-splunk-cpp`.
The Splunk instrumentation for C++ has been deprecated as of March 15, 2024, and it will reach end of support on September 15, 2025. If you're using the Splunk instrumentation, you can migrate to the upstream OpenTelemetry C++ instrumentation. See :ref:`migrate-from-splunk-cpp` to learn how.
2 changes: 1 addition & 1 deletion gdi/get-data-in/application/go/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ To instrument your Go application, follow these steps:

For more information, see :ref:`splunk-go-otel-dist`.

.. note:: The SignalFx Tracing Library for Go is deprecated and will reach End of Support on June 8th, 2023. To migrate to the Splunk Distribution of OpenTelemetry Go, see :ref:`migrate-signalfx-go-to-otel`.
.. note:: The SignalFx Tracing Library for Go is deprecated and will reach End of Support on June 8th, 2023. See :ref:`migrate-signalfx-go-to-otel` to migrate to the Splunk Distribution of OpenTelemetry Go.
2 changes: 1 addition & 1 deletion gdi/get-data-in/application/java/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Instrument Java applications for Splunk Observability Cloud
Version 1.x (Deprecated) <version1x/get-started-1x>
About Splunk OTel Java <splunk-java-otel-distribution>

The Splunk Distribution of OpenTelemetry Java provides a Java Virtual Machine (JVM) agent that automatically adds APM instrumentation to your Java application or service. The instrumentation captures distributed traces and sends them to Splunk Observability Cloud. For more information, see :ref:`splunk-java-otel-dist`.
The Splunk Distribution of OpenTelemetry Java provides a Java Virtual Machine (JVM) agent that automatically adds APM instrumentation to your Java application or service. The instrumentation captures distributed traces and sends them to Splunk Observability Cloud. See :ref:`splunk-java-otel-dist` for more information.

To instrument your Java application, follow these steps:

Expand Down
2 changes: 1 addition & 1 deletion gdi/get-data-in/application/nodejs/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ To instrument your Node.js application, follow these steps:

For more information, see :ref:`splunk-nodejs-otel-dist`.

.. note:: The SignalFx Tracing Library for Node.js is deprecated and will reach End of Support on June 8th, 2023. To migrate to the Splunk Distribution of OpenTelemetry JS, see :ref:`migrate-signalfx-nodejs-agent-to-otel`.
.. note:: The SignalFx Tracing Library for Node.js is deprecated and will reach End of Support on June 8th, 2023. See :ref:`migrate-signalfx-nodejs-agent-to-otel` to migrate to the Splunk Distribution of OpenTelemetry JS.
2 changes: 1 addition & 1 deletion gdi/get-data-in/application/php/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ To instrument your PHP application, follow these steps:
#. Instrument your PHP application. See :ref:`instrument-php-otel-applications`.
#. Add custom instrumentation. See :ref:`manual-php-otel-instrumentation`.

.. note:: The SignalFx Tracing Library for PHP is deprecated. To migrate to the OpenTelemetry automatic instrumentation for PHP, see :ref:`php-migration-guide`.
.. note:: The SignalFx Tracing Library for PHP is deprecated. See :ref:`php-migration-guide` to migrate to the OpenTelemetry automatic instrumentation for PHP.
2 changes: 1 addition & 1 deletion gdi/get-data-in/application/python/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ To instrument your Python application, follow these steps:

For more information, see :ref:`splunk-python-otel-dist`.

.. note:: The SignalFx Python Agent is deprecated and will reach End of Support on December 17th, 2022. To migrate to the Splunk Distribution of OpenTelemetry Python, see :ref:`migrate-signalfx-python-agent-to-otel`.
.. 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.
2 changes: 1 addition & 1 deletion gdi/get-data-in/application/ruby/get-started-ruby.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ To instrument your Ruby application, follow these steps:
#. Check compatibility and requirements. See :ref:`ruby-otel-requirements`.
#. Instrument your Ruby application. See :ref:`instrument-ruby-applications`.

.. note:: The Splunk Distribution for OpenTelemetry Ruby has been deprecated as of March 15, 2024, and will reach end of support on March 15, 2025. To use the upstream OpenTelemetry instrumentation for Ruby, see :ref:`get-started-ruby`.
.. note:: The Splunk Distribution for OpenTelemetry Ruby has been deprecated as of March 15, 2024, and will reach end of support on March 15, 2025. See :ref:`get-started-ruby` to use the upstream OpenTelemetry instrumentation for Ruby.
2 changes: 1 addition & 1 deletion gdi/monitors-cloud/heroku.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ and runs the Splunk OpenTelemetry Connector on a Dyno to receive, process and ex
- Splunk APM through the ``sapm`` exporter. The ``otlphttp`` exporter can be used with a custom configuration.
- Splunk Infrastructure Monitoring through the ``signalfx`` exporter.

To learn more about the Splunk Distribution of the OpenTelemetry Collector, see :ref:`otel-intro`.
See :ref:`otel-intro` to learn more.

Prerequisites
----------------
Expand Down
4 changes: 2 additions & 2 deletions gdi/monitors-cloud/kong.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ In addition, the integration provides system-wide connection statistics, includi

To learn more:

* About the Kong metrics Prometheus endpoint, see the official :new-page:`Kong documentation on Prometheus <https://docs.konghq.com/hub/kong-inc/prometheus>`.
* About using the Prometheus receiver to monitor applications, see :ref:`prometheus-generic`.
* About the Kong metrics Prometheus endpoint, see the official :new-page:`Kong documentation <https://docs.konghq.com/hub/kong-inc/prometheus>` on Prometheus.
* About using the Prometheus receiver to monitor applications, see the :ref:`prometheus-generic` doc.

Benefits
--------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Cloud Foundry Loggregator Firehose

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the Cloud Foundry Loggregator Firehose monitor type to create a Cloud Foundry Firehose nozzle which connects to the Cloud Foundry Reverse Log Proxy (RLP) Gateway to extract metrics from Loggregator.

.. note:: To monitor Cloud Foundry with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`cloudfoundry-receiver`.
.. note:: To monitor Cloud Foundry with the OpenTelemetry Collector using native OpenTelemetry refer to the :ref:`cloudfoundry-receiver` component.

The following applies:

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-databases/microsoft-sql-server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent rece
Microsoft SQL Server monitor type to send metrics from Microsoft SQL
Server instances.

.. note:: To monitor Microsoft SQL server instances with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`mssql-server-receiver`.
.. note:: To monitor Microsoft SQL server instances with the OpenTelemetry Collector using native OpenTelemetry refer to the :ref:`mssql-server-receiver` component.

Benefits
=================
Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-databases/mongodb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ MongoDB (deprecated)

.. note:: The MongoDB monitor is deprecated and will reach end of support on January 15, 2025. During this period, only critical security and bug fixes are provided. When the monitor reaches end of support, you won't be able to use it to send data to Splunk Observability Cloud.

To monitor your MongoDB databases, you can instead use the native OpenTelemetry MongoDB receiver. To learn more, see :ref:`mongodb-receiver`.
To monitor your MongoDB databases, you can instead use the native OpenTelemetry MongoDB receiver. See :ref:`mongodb-receiver` to learn more.

The
:ref:`Splunk Distribution of the OpenTelemetry Collector <otel-intro>`
Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-databases/mysql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ MySQL (deprecated)

The MySQL monitor is now deprecated and will reach of End of Support on October 31st, 2024. During this period only critical security and bug fixes are provided. When End of Support is reached, the monitor will be removed and no longer be supported, and you won't be able to use it to send data to Splunk Observability Cloud.

To monitor your MySQL databases you can use the native OpenTelemetry MySQL receiver instead. See more at :ref:`MySQL receiver <mysql-receiver>`.
To monitor your MySQL databases you can use the native OpenTelemetry MySQL receiver instead. See :ref:`MySQL receiver <mysql-receiver>` to learn more.

The :ref:`Splunk Distribution of the OpenTelemetry Collector <otel-intro>` uses the :ref:`Smart Agent receiver <smartagent-receiver>` with the MySQL monitor type to retrieve metrics and logs from MySQL.

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-databases/postgresql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ PostgreSQL (deprecated)

The PostgreSQL monitor is now deprecated and will reach of End of Support on October 31st, 2024. During this period only critical security and bug fixes are provided. When End of Support is reached, the monitor will be removed and no longer be supported, and you won't be able to use it to send data to Splunk Observability Cloud.

To monitor your PostgreSQL databases you can use the native OpenTelemetry PostgreSQL receiver instead. See more at :ref:`postgresql-receiver`.
To monitor your PostgreSQL databases you can use the native OpenTelemetry PostgreSQL receiver instead. See :ref:`postgresql-receiver` to learn more.

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``postgresql`` monitor type to pull metrics from all PostgreSQL databases from a specific Postgres server instance using SQL queries.

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-databases/redis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Redis (deprecated)

.. note:: The Redis monitor is deprecated and will reach end of support on January 15, 2025. During this period, only critical security and bug fixes are provided. When the monitor reaches end of support, you won't be able to use it to send data to Splunk Observability Cloud.

To monitor your Redis databases, you can instead use the native OpenTelemetry Redis receiver. To learn more, see :ref:`redis-receiver`.
To monitor your Redis databases, you can instead use the native OpenTelemetry Redis receiver. See :ref:`redis-receiver` to learn more.

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``redis`` monitor type to capture the following metrics:

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-databases/sql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ SQL
.. meta::
:description: Use this Splunk Observability Cloud integration for the SQL monitor. See benefits, install, configuration, and metrics

.. note:: If you're using the Splunk Distribution of the OpenTelemetry Collector and want to collect SQL metrics, use the native OTel component :ref:`sqlquery-receiver`.
.. note:: If you're using the Splunk Distribution of the OpenTelemetry Collector and want to collect SQL metrics, use the native OTel :ref:`sqlquery-receiver` component.

The SQL monitor gathers database usage metrics from SQL queries on your databases. It's available for Kubernetes, Windows, and Linux.

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-hosts/apache-httpserver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Apache HTTP Server

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the Apache HTTP Server monitor type to monitor Apache web servers using information ``mod_status`` provides.

.. note:: To monitor Apache web server instances with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`apache-receiver`.
.. note:: Refer to the :ref:`apache-receiver` to monitor Apache web server instances with the OpenTelemetry Collector using native OpenTelemetry components.

Apache worker threads can be in one of the following states:

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-hosts/apache-tomcat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ integration:
- Specifies how to map JMX MBean values to metrics. If using a
specific service monitor such as Cassandra, Kafka, or ActiveMQ,
they come pre-loaded with a set of mappings, and any that you
add in this option are merged with those. To learn more, see the :new-page:`Collectd documentation <https://www.collectd.org/documentation/manpages/collectd-java.html>`.
add in this option are merged with those. See the :new-page:`Collectd documentation <https://www.collectd.org/documentation/manpages/collectd-java.html>` to learn more.

The **nested** ``mBeanDefinitions`` configuration object has the
following fields:
Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-hosts/jenkins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ hitting the following endpoints:

This integration is only available on Kubernetes and Linux.

.. note:: The Jenkins integration requires Jenkins version 1.580.3 or higher and the :new-page:`Jenkins Metrics plugin <https://plugins.jenkins.io/metrics/>`.
.. note:: The Jenkins integration requires Jenkins version 1.580.3 or higher and the :new-page:`Jenkins Metrics <https://plugins.jenkins.io/metrics/>` plugin.

Benefits
--------
Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-hosts/kafka-consumer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Kafka consumer

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``collectd/kafka_consumer`` monitor type to monitor a Java-based Kafka consumer.

.. note:: To monitor Kafka with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`kafkametrics-receiver`.
.. note:: To monitor Kafka with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`kafkametrics-receiver` component.

This integration has a set of built-in MBeans to pull metrics from the Kafka consumer's JMX endpoint. For more information, see :new-page:`Kafka consumer MBeans <https://github.com/signalfx/signalfx-agent/tree/main/pkg/monitors/collectd/kafkaconsumer/mbeans.go>` in GitHub.

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-hosts/kafka-producer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Kafka producer

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``collectd/kafka_producer`` monitor type to monitor a Java-based Kafka producer.

.. note:: To monitor Kafka with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`kafkametrics-receiver`.
.. note:: To monitor Kafka with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`kafkametrics-receiver` component.

This integration has a set of built-in MBeans to pull metrics from the Kafka producer's JMX endpoint. For more information, see :new-page:`Kafka producer MBeans <https://github.com/signalfx/signalfx-agent/tree/main/pkg/monitors/collectd/kafkaproducer/mbeans.go>` in GitHub.

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-hosts/nginx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent rece

This integration is available on Linux and Windows.

.. note:: To monitor NGINX instances with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`nginx-receiver`.
.. note:: To monitor NGINX instances with the OpenTelemetry Collector using native OpenTelemetry refer to the :ref:`nginx-receiver` component.

Benefits
--------
Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-languages/expvar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Expvar (Go)
.. meta::
:description: Use this Splunk Observability Cloud integration for the Golang Expvar monitor. See benefits, install, configuration, and metrics".

The :ref:`Splunk Distribution of OpenTelemetry Collector <otel-intro>` uses the :ref:`Smart Agent receiver <smartagent-receiver>` with the ``expvar`` monitor type to scrape metrics exposed by :new-page:`expvar <https://golang.org/pkg/expvar/>`.
The :ref:`Splunk Distribution of OpenTelemetry Collector <otel-intro>` uses the :ref:`Smart Agent receiver <smartagent-receiver>` with the ``expvar`` monitor type to scrape metrics exposed Expvar. See :new-page:`expvar <https://golang.org/pkg/expvar/>` to learn more.

The integration uses configured paths to get metric and dimension values from fetched JSON objects at an HTTP endpoint. The Metrics section in this document shows metrics derived from expvar variable :new-page:`memstats <https://golang.org/pkg/runtime/>`, which is exposed by default. These ``memstat`` metrics are referred to as standard or default metrics.

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-messaging/rabbitmq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ RabbitMQ

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``rabbitmq`` monitor type to keep track of an instance of RabbitMQ.

.. note:: To monitor RabbitMQ instances with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`rabbitmq-receiver`.
.. note:: To monitor RabbitMQ instances with the OpenTelemetry Collector using native OpenTelemetry refer to the :ref:`rabbitmq-receiver` component.

The integration uses the RabbitMQ Python plugin and the RabbitMQ
Management HTTP API to poll for statistics on a RabbitMQ server, then
Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-prometheus/prometheus-generic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Configure applications with Prometheus metrics
.. meta::
:description: Use the Prometheus receiver to retrieve metrics in Prometheus format from any compatible service.

The Prometheus receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect metrics from any source exposing telemetry in Prometheus format. See more at :ref:`prometheus-receiver`.
The Prometheus receiver allows the Splunk Distribution of the OpenTelemetry Collector to collect metrics from any source exposing telemetry in Prometheus format. See :ref:`prometheus-receiver` to learn more.

Benefits
========================
Expand Down
Loading