diff --git a/admin/notif-services/splunkplatform.rst b/admin/notif-services/splunkplatform.rst index aa2e23f16..a71f458d2 100644 --- a/admin/notif-services/splunkplatform.rst +++ b/admin/notif-services/splunkplatform.rst @@ -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 ` 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 `. + - 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 . .. 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. diff --git a/admin/notif-services/webhook.rst b/admin/notif-services/webhook.rst index d09288d8c..7225bb9f3 100644 --- a/admin/notif-services/webhook.rst +++ b/admin/notif-services/webhook.rst @@ -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 ` 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. diff --git a/gdi/get-data-in/application/cpp/get-started-cpp.rst b/gdi/get-data-in/application/cpp/get-started-cpp.rst index 353cbb76f..90c9ebb33 100644 --- a/gdi/get-data-in/application/cpp/get-started-cpp.rst +++ b/gdi/get-data-in/application/cpp/get-started-cpp.rst @@ -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`. \ No newline at end of file + 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. \ No newline at end of file diff --git a/gdi/get-data-in/application/go/get-started.rst b/gdi/get-data-in/application/go/get-started.rst index 69fad3d2a..f6a32b229 100644 --- a/gdi/get-data-in/application/go/get-started.rst +++ b/gdi/get-data-in/application/go/get-started.rst @@ -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. diff --git a/gdi/get-data-in/application/java/get-started.rst b/gdi/get-data-in/application/java/get-started.rst index 2120f3417..e0f11d48b 100644 --- a/gdi/get-data-in/application/java/get-started.rst +++ b/gdi/get-data-in/application/java/get-started.rst @@ -24,7 +24,7 @@ Instrument Java applications for Splunk Observability Cloud Version 1.x (Deprecated) About Splunk OTel Java -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: diff --git a/gdi/get-data-in/application/nodejs/get-started.rst b/gdi/get-data-in/application/nodejs/get-started.rst index c81b826eb..7ee49ebfc 100644 --- a/gdi/get-data-in/application/nodejs/get-started.rst +++ b/gdi/get-data-in/application/nodejs/get-started.rst @@ -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. diff --git a/gdi/get-data-in/application/php/get-started.rst b/gdi/get-data-in/application/php/get-started.rst index ee15c34e3..5158b3551 100644 --- a/gdi/get-data-in/application/php/get-started.rst +++ b/gdi/get-data-in/application/php/get-started.rst @@ -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. diff --git a/gdi/get-data-in/application/python/get-started.rst b/gdi/get-data-in/application/python/get-started.rst index 0306d5a27..7977c3b05 100644 --- a/gdi/get-data-in/application/python/get-started.rst +++ b/gdi/get-data-in/application/python/get-started.rst @@ -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. diff --git a/gdi/get-data-in/application/ruby/get-started-ruby.rst b/gdi/get-data-in/application/ruby/get-started-ruby.rst index 26cbaeb34..2a335f89f 100644 --- a/gdi/get-data-in/application/ruby/get-started-ruby.rst +++ b/gdi/get-data-in/application/ruby/get-started-ruby.rst @@ -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. diff --git a/gdi/monitors-cloud/heroku.rst b/gdi/monitors-cloud/heroku.rst index 5bee14ca2..ea8c5c3e1 100644 --- a/gdi/monitors-cloud/heroku.rst +++ b/gdi/monitors-cloud/heroku.rst @@ -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 ---------------- diff --git a/gdi/monitors-cloud/kong.rst b/gdi/monitors-cloud/kong.rst index 07b5dc91f..4d2f3453d 100644 --- a/gdi/monitors-cloud/kong.rst +++ b/gdi/monitors-cloud/kong.rst @@ -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 `. -* 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 ` on Prometheus. +* About using the Prometheus receiver to monitor applications, see the :ref:`prometheus-generic` doc. Benefits -------- diff --git a/gdi/monitors-cloudfoundry/cloudfoundry-firehose-nozzle.rst b/gdi/monitors-cloudfoundry/cloudfoundry-firehose-nozzle.rst index b4957b578..05f331f34 100644 --- a/gdi/monitors-cloudfoundry/cloudfoundry-firehose-nozzle.rst +++ b/gdi/monitors-cloudfoundry/cloudfoundry-firehose-nozzle.rst @@ -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: diff --git a/gdi/monitors-databases/microsoft-sql-server.rst b/gdi/monitors-databases/microsoft-sql-server.rst index 044db5903..7f6a4eae5 100644 --- a/gdi/monitors-databases/microsoft-sql-server.rst +++ b/gdi/monitors-databases/microsoft-sql-server.rst @@ -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 ================= diff --git a/gdi/monitors-databases/mongodb.rst b/gdi/monitors-databases/mongodb.rst index 752d93dec..3bc0c9ad8 100644 --- a/gdi/monitors-databases/mongodb.rst +++ b/gdi/monitors-databases/mongodb.rst @@ -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 ` diff --git a/gdi/monitors-databases/mysql.rst b/gdi/monitors-databases/mysql.rst index b8544924a..e9b5b712a 100644 --- a/gdi/monitors-databases/mysql.rst +++ b/gdi/monitors-databases/mysql.rst @@ -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 `. + To monitor your MySQL databases you can use the native OpenTelemetry MySQL receiver instead. See :ref:`MySQL receiver ` to learn more. The :ref:`Splunk Distribution of the OpenTelemetry Collector ` uses the :ref:`Smart Agent receiver ` with the MySQL monitor type to retrieve metrics and logs from MySQL. diff --git a/gdi/monitors-databases/postgresql.rst b/gdi/monitors-databases/postgresql.rst index 1245241ef..c07d5806a 100644 --- a/gdi/monitors-databases/postgresql.rst +++ b/gdi/monitors-databases/postgresql.rst @@ -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. diff --git a/gdi/monitors-databases/redis.rst b/gdi/monitors-databases/redis.rst index a4c8a32bf..586feb9cd 100644 --- a/gdi/monitors-databases/redis.rst +++ b/gdi/monitors-databases/redis.rst @@ -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: diff --git a/gdi/monitors-databases/sql.rst b/gdi/monitors-databases/sql.rst index 1cf52887f..49b5b5788 100644 --- a/gdi/monitors-databases/sql.rst +++ b/gdi/monitors-databases/sql.rst @@ -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. diff --git a/gdi/monitors-hosts/apache-httpserver.rst b/gdi/monitors-hosts/apache-httpserver.rst index 1777a4a4f..f59d8678e 100644 --- a/gdi/monitors-hosts/apache-httpserver.rst +++ b/gdi/monitors-hosts/apache-httpserver.rst @@ -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: diff --git a/gdi/monitors-hosts/apache-tomcat.rst b/gdi/monitors-hosts/apache-tomcat.rst index 8401d3cdb..f9cb9ebd1 100644 --- a/gdi/monitors-hosts/apache-tomcat.rst +++ b/gdi/monitors-hosts/apache-tomcat.rst @@ -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 `. + add in this option are merged with those. See the :new-page:`Collectd documentation ` to learn more. The **nested** ``mBeanDefinitions`` configuration object has the following fields: diff --git a/gdi/monitors-hosts/jenkins.rst b/gdi/monitors-hosts/jenkins.rst index 9f8a2137b..fd3eb32aa 100644 --- a/gdi/monitors-hosts/jenkins.rst +++ b/gdi/monitors-hosts/jenkins.rst @@ -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 `. +.. note:: The Jenkins integration requires Jenkins version 1.580.3 or higher and the :new-page:`Jenkins Metrics ` plugin. Benefits -------- diff --git a/gdi/monitors-hosts/kafka-consumer.rst b/gdi/monitors-hosts/kafka-consumer.rst index b8a8aeaf1..a39ed1665 100644 --- a/gdi/monitors-hosts/kafka-consumer.rst +++ b/gdi/monitors-hosts/kafka-consumer.rst @@ -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 ` in GitHub. diff --git a/gdi/monitors-hosts/kafka-producer.rst b/gdi/monitors-hosts/kafka-producer.rst index 97668f20b..24f5bcebf 100644 --- a/gdi/monitors-hosts/kafka-producer.rst +++ b/gdi/monitors-hosts/kafka-producer.rst @@ -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 ` in GitHub. diff --git a/gdi/monitors-hosts/nginx.rst b/gdi/monitors-hosts/nginx.rst index b3bc117de..e8a06c498 100644 --- a/gdi/monitors-hosts/nginx.rst +++ b/gdi/monitors-hosts/nginx.rst @@ -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 -------- diff --git a/gdi/monitors-languages/expvar.rst b/gdi/monitors-languages/expvar.rst index 5622e5f45..e2c6f503d 100644 --- a/gdi/monitors-languages/expvar.rst +++ b/gdi/monitors-languages/expvar.rst @@ -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 ` uses the :ref:`Smart Agent receiver ` with the ``expvar`` monitor type to scrape metrics exposed by :new-page:`expvar `. +The :ref:`Splunk Distribution of OpenTelemetry Collector ` uses the :ref:`Smart Agent receiver ` with the ``expvar`` monitor type to scrape metrics exposed Expvar. See :new-page:`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 `, which is exposed by default. These ``memstat`` metrics are referred to as standard or default metrics. diff --git a/gdi/monitors-messaging/rabbitmq.rst b/gdi/monitors-messaging/rabbitmq.rst index 938d235ed..38fae4fa0 100644 --- a/gdi/monitors-messaging/rabbitmq.rst +++ b/gdi/monitors-messaging/rabbitmq.rst @@ -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 diff --git a/gdi/monitors-prometheus/prometheus-generic.rst b/gdi/monitors-prometheus/prometheus-generic.rst index 39ce6f32a..39f35e7c9 100644 --- a/gdi/monitors-prometheus/prometheus-generic.rst +++ b/gdi/monitors-prometheus/prometheus-generic.rst @@ -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 ========================