Merge pull request #1811 from splunk/urbiz-DG24742-component-note

aurbiztondo-splunk · web-flow · commit f7b6632ba5c0 · 2024-03-04T06:53:36.000+01:00
[DG24742]: Component note update
diff --git a/gdi/opentelemetry/components/awss3-exporter.rst b/gdi/opentelemetry/components/awss3-exporter.rst
@@ -7,10 +7,8 @@ AWS S3 exporter
 .. meta::
       :description: This exporter targets to support proto/json format. 
 
-.. note:: Document coming soon!
+The Splunk Distribution of the OpenTelemetry Collector supports the AWS S3 exporter. Documentation is planned for a future release.
 
-The Splunk Distribution of the OpenTelemetry Collector supports the AWS S3 exporter, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`AWS S3 exporter <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/awss3exporter>`.
+To find information about this component in the meantime, see :new-page:`AWS S3 exporter <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/awss3exporter>` on GitHub.
 
 
diff --git a/gdi/opentelemetry/components/azureeventhub-receiver.rst b/gdi/opentelemetry/components/azureeventhub-receiver.rst
@@ -7,10 +7,6 @@ Azure event hub receiver
 .. meta::
       :description: Pulls logs from an Azure event hub.
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Azure event hub receiver, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Azure event hub receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/azureeventhubreceiver>`.
-
+The Splunk Distribution of the OpenTelemetry Collector supports the Azure event hub receiver. Documentation is planned for a future release. 
 
+To find information about this component in the meantime, see :new-page:`Azure event hub receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/azureeventhubreceiver>` on GitHub.
diff --git a/gdi/opentelemetry/components/carbon-receiver.rst b/gdi/opentelemetry/components/carbon-receiver.rst
@@ -7,10 +7,7 @@ Carbon receiver
 .. meta::
       :description: Receives metrics in Carbon plaintext protocol.
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Carbon receiver, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Carbon receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/carbonreceiver>`.
+The Splunk Distribution of the OpenTelemetry Collector supports the Carbon receiver. Documentation is planned for a future release. 
 
+To find information about this component in the meantime, see :new-page:`Carbon receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/carbonreceiver>` on GitHub.
 
diff --git a/gdi/opentelemetry/components/cloudfoundry-receiver.rst b/gdi/opentelemetry/components/cloudfoundry-receiver.rst
@@ -7,10 +7,7 @@ Cloudfoundry receiver
 .. meta::
       :description: Connects to the Reverse Log Proxy (RLP) gateway of Cloud Foundry to extract metrics.
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Cloudfoundry receiver, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Cloudfoundry receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/cloudfoundryreceiver>`.
+The Splunk Distribution of the OpenTelemetry Collector supports the Cloudfoundry receiver. Documentation is planned for a future release.  
 
+To find information about this component in the meantime, :new-page:`Cloudfoundry receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/cloudfoundryreceiver>` on GitHub.
 
diff --git a/gdi/opentelemetry/components/collectd-receiver.rst b/gdi/opentelemetry/components/collectd-receiver.rst
@@ -7,10 +7,6 @@ CollectD receiver
 .. meta::
       :description: Receives data exported through the CollectD ``write_http`` plugin. Only supports the JSON format.
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the CollectD receiver, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`CollectD receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/collectdreceiver>`.
-
+The Splunk Distribution of the OpenTelemetry Collector supports the CollectD receiver. Documentation is planned for a future release.  
 
+To find information about this component in the meantime, see :new-page:`CollectD receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/collectdreceiver>` on GitHub.
diff --git a/gdi/opentelemetry/components/discovery-receiver.rst b/gdi/opentelemetry/components/discovery-receiver.rst
@@ -7,12 +7,8 @@ Discovery receiver
 .. meta::
       :description: Wraps the receiver creator to facilitate the discovery of metric collection targets. 
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Discovery receiver, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Discovery receiver <https://github.com/signalfx/splunk-otel-collector/tree/main/internal/receiver/discoveryreceiver>`.
-
-You can also use the discovery mode of the Splunk Distribution of OpenTelemetry Collector to detect metric sources and collect metrics automatically. Learn more at :ref:`discovery_mode`. 
+The Splunk Distribution of the OpenTelemetry Collector supports the Discovery receiver. Documentation is planned for a future release.  
 
+To find information about this component in the meantime, see :new-page:`Discovery receiver <https://github.com/signalfx/splunk-otel-collector/tree/main/internal/receiver/discoveryreceiver>` on GitHub.
 
+.. note:: You can also use the discovery mode of the Splunk Distribution of OpenTelemetry Collector to detect metric sources and collect metrics automatically. Learn more at :ref:`discovery_mode`. 
diff --git a/gdi/opentelemetry/components/docker-observer-extension.rst b/gdi/opentelemetry/components/docker-observer-extension.rst
@@ -7,10 +7,6 @@ Docker Observer extension
 .. meta::
       :description: Use the basicauth extension to authenticate clients and servers using basic authentication. 
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Docker Observer extension, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Docker Observer extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/dockerobserver>`.
-
+The Splunk Distribution of the OpenTelemetry Collector supports the Docker Observer extension. Documentation is planned for a future release.   
 
+To find information about this component in the meantime, see :new-page:`Docker Observer extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/dockerobserver>` on GitHub.
diff --git a/gdi/opentelemetry/components/ecs-observer-extension.rst b/gdi/opentelemetry/components/ecs-observer-extension.rst
@@ -7,10 +7,9 @@ ECS Observer extension
 .. meta::
       :description: Uses the ECS and EC2 API to discover Prometheus scrape targets.
 
-.. note:: Document coming soon!
+The Splunk Distribution of the OpenTelemetry Collector supports the ECS Observer extension. Documentation is planned for a future release.   
 
-The Splunk Distribution of the OpenTelemetry Collector supports the ECS Observer extension, but it is not yet documented. 
+To find information about this component in the meantime, see :new-page:`ECS Observer extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/ecsobserver>` on GitHub.
 
-To find information about this component, see the documentation in the GitHub repository at :new-page:`ECS Observer extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/ecsobserver>`.
 
 
diff --git a/gdi/opentelemetry/components/file-exporter.rst b/gdi/opentelemetry/components/file-exporter.rst
@@ -7,10 +7,6 @@ File exporter
 .. meta::
       :description: Writes pipeline data to a JSON file in Protobuf JSON encoding using the OpenTelemetry protocol. 
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the File exporter, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`File exporter <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/fileexporter>`.
-
+The Splunk Distribution of the OpenTelemetry Collector supports the File exporter. Documentation is planned for a future release. 
 
+To find information about this component in the meantime, see :new-page:`File exporter <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/fileexporter>` on GitHub.
diff --git a/gdi/opentelemetry/components/file-storage-extension.rst b/gdi/opentelemetry/components/file-storage-extension.rst
@@ -7,10 +7,7 @@ File storage extension
 .. meta::
       :description: Uses the ECS and EC2 API to discover Prometheus scrape targets.
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the File storage extension, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`File storage extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/storage/filestorage>`.
+The Splunk Distribution of the OpenTelemetry Collector supports the File storage extension. Documentation is planned for a future release.
 
+To find information about this component in the meantime, see :new-page:`File storage extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/storage/filestorage>` on GitHub.
 
diff --git a/gdi/opentelemetry/components/host-observer-extension.rst b/gdi/opentelemetry/components/host-observer-extension.rst
@@ -7,10 +7,8 @@ Host observer extension
 .. meta::
       :description: Looks at the current host for listening network endpoints. 
 
-.. note:: Document coming soon!
+The Splunk Distribution of the OpenTelemetry Collector supports the Host observer extension. Documentation is planned for a future release.
 
-The Splunk Distribution of the OpenTelemetry Collector supports the Host observer extension, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Host observer extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/hostobserver>`.
+To find information about this component in the meantime, see :new-page:`Host observer extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/hostobserver>` on GitHub.
 
 
diff --git a/gdi/opentelemetry/components/http-forwarder-extension.rst b/gdi/opentelemetry/components/http-forwarder-extension.rst
@@ -7,10 +7,7 @@ HTTP forwarder extension
 .. meta::
       :description: Accepts HTTP requests and optionally adds headers and forwards them.
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the HTTP forwarder extension, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`HTTP forwarder extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/httpforwarder>`.
+The Splunk Distribution of the OpenTelemetry Collector supports the HTTP forwarder extension. Documentation is planned for a future release.
 
+To find information about this component in the meantime, see :new-page:`HTTP forwarder extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/httpforwarder>` on GitHub.
 
diff --git a/gdi/opentelemetry/components/journald-receiver.rst b/gdi/opentelemetry/components/journald-receiver.rst
@@ -7,10 +7,7 @@ Journald receiver
 .. meta::
       :description: Parses Journald events from the systemd journal.
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Journald receiver, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Journald receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/journaldreceiver>`.
+The Splunk Distribution of the OpenTelemetry Collector supports the Journald receiver. Documentation is planned for a future release.
 
+To find information about this component in the meantime, see :new-page:`Journald receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/journaldreceiver>` on GitHub.
 
diff --git a/gdi/opentelemetry/components/kafka-exporter.rst b/gdi/opentelemetry/components/kafka-exporter.rst
@@ -7,10 +7,7 @@ Kafka exporter
 .. meta::
       :description: Exports metrics, logs, and traces to Kafka using a synchronous producer. 
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Kafka exporter, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Kafka exporter <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/kafkaexporter>`.
+The Splunk Distribution of the OpenTelemetry Collector supports the Kafka exporter. Documentation is planned for a future release.
 
+To find information about this component in the meantime, see :new-page:`Kafka exporter <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/kafkaexporter>` on GitHub.
 
diff --git a/gdi/opentelemetry/components/kafka-receiver.rst b/gdi/opentelemetry/components/kafka-receiver.rst
@@ -7,10 +7,7 @@ Kafka receiver
 .. meta::
       :description: Receives metrics, logs, and traces from Kafka. Metrics and logs only support the OTLP format.
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Kafka receiver, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Kafka receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/kafkareceiver>`.
+The Splunk Distribution of the OpenTelemetry Collector supports the Kafka receiver. Documentation is planned for a future release. 
 
+To find information about this component in the meantime, see :new-page:`Kafka receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/kafkareceiver>` on GitHub.
 
diff --git a/gdi/opentelemetry/components/kafkametrics-receiver.rst b/gdi/opentelemetry/components/kafkametrics-receiver.rst
@@ -7,10 +7,8 @@ Kafka metrics receiver
 .. meta::
       :description: Collects Kafka metrics such as brokers, topics, partitions, and consumer groups from Kafka server, and converts them to OTLP format.
 
-.. note:: Document coming soon!
+The Splunk Distribution of the OpenTelemetry Collector supports the Kafka metrics receiver. Documentation is planned for a future release. 
 
-The Splunk Distribution of the OpenTelemetry Collector supports the Kafka metrics receiver, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Kafka metrics receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/kafkametricsreceiver>`.
+To find information about this component in the meantime, see :new-page:`Kafka metrics receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/kafkametricsreceiver>` on GitHub.
 
 
diff --git a/gdi/opentelemetry/components/kubernetes-events-receiver.rst b/gdi/opentelemetry/components/kubernetes-events-receiver.rst
@@ -7,10 +7,7 @@ Kubernetes events receiver
 .. meta::
       :description: Collects all new and updated events from the Kubernetes API server. Supports authentication through service accounts only.
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Kubernetes events receiver, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Kubernetes events receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/k8seventsreceiver>`.
+The Splunk Distribution of the OpenTelemetry Collector supports the Kubernetes events receiver. Documentation is planned for a future release. 
 
+To find information about this component in the meantime, see :new-page:`Kubernetes events receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/k8seventsreceiver>` on GitHub.
 
diff --git a/gdi/opentelemetry/components/kubernetes-objects-receiver.rst b/gdi/opentelemetry/components/kubernetes-objects-receiver.rst
@@ -7,10 +7,7 @@ Kubernetes objects receiver
 .. meta::
       :description: Collects objects from the Kubernetes API server. Supports authentication through service accounts only.
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Kubernetes objects receiver, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Kubernetes objects receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/k8sobjectsreceiver>`.
+The Splunk Distribution of the OpenTelemetry Collector supports the Kubernetes objects receiver. Documentation is planned for a future release. 
 
+To find information about this component in the meantime, see :new-page:`Kubernetes objects receiver <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/k8sobjectsreceiver>` on GitHub.
 
diff --git a/gdi/opentelemetry/components/kubernetes-observer-extension.rst b/gdi/opentelemetry/components/kubernetes-observer-extension.rst
@@ -7,10 +7,7 @@ Kubernetes observer extension
 .. meta::
       :description: Uses the Kubernetes API to discover pods running on the local node. 
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Kubernetes observer extension, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Kubernetes observer extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/k8sobserver>`.
+The Splunk Distribution of the OpenTelemetry Collector supports the Kubernetes observer extension. Documentation is planned for a future release.  
 
+To find information about this component in the meantime, see :new-page:`Kubernetes observer extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/k8sobserver>` on GitHub.
 
diff --git a/gdi/opentelemetry/components/metrics-transform-processor.rst b/gdi/opentelemetry/components/metrics-transform-processor.rst
@@ -7,10 +7,7 @@ Metrics transform processor
 .. meta::
       :description: Renames metrics, and adds, renames, or deletes label keys and values.
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Metrics transform processor, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Metrics transform processor <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/metricstransformprocessor>`.
+The Splunk Distribution of the OpenTelemetry Collector supports the Metrics transform processor. Documentation is planned for a future release.
 
+To find information about this component in the meantime, see :new-page:`Metrics transform processor <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/metricstransformprocessor>` on GitHub.
 
diff --git a/gdi/opentelemetry/components/pprof-extension.rst b/gdi/opentelemetry/components/pprof-extension.rst
@@ -7,10 +7,7 @@ Pprof observer extension
 .. meta::
       :description: Activates the golang ``net/http/pprof`` endpoint, which is used to collect performance profiles and investigate issues with a service.
 
-.. note:: Document coming soon!
-
-The Splunk Distribution of the OpenTelemetry Collector supports the Pprof extension, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Pprof extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/pprofextension>`.
+The Splunk Distribution of the OpenTelemetry Collector supports the Pprof extension. Documentation is planned for a future release.
 
+To find information about this component in the meantime, see :new-page:`Pprof extension <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/pprofextension>` on GitHub.
 
diff --git a/gdi/opentelemetry/components/probabilistic-sampler-processor.rst b/gdi/opentelemetry/components/probabilistic-sampler-processor.rst
@@ -7,10 +7,8 @@ Probabilistic sampler processor
 .. meta::
       :description: Provides samples based on hash values determined by trace IDs.
 
-.. note:: Document coming soon!
+The Splunk Distribution of the OpenTelemetry Collector supports the Probabilistic sampler processor. Documentation is planned for a future release. 
 
-The Splunk Distribution of the OpenTelemetry Collector supports the Probabilistic sampler processor, but it is not yet documented. 
-
-To find information about this component, see the documentation in the GitHub repository at :new-page:`Probabilistic sampler processor <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/probabilisticsamplerprocessor>`.
+To find information about this component in the meantime, see :new-page:`Probabilistic sampler processor <https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/probabilisticsamplerprocessor>` on GitHub.
 
 
diff --git a/gdi/opentelemetry/components/routing-processor.rst b/gdi/opentelemetry/components/routing-processor.rst
diff --git a/gdi/opentelemetry/components/sapm-receiver.rst b/gdi/opentelemetry/components/sapm-receiver.rst
diff --git a/gdi/opentelemetry/components/smartagent-extension.rst b/gdi/opentelemetry/components/smartagent-extension.rst
diff --git a/gdi/opentelemetry/components/statsd-receiver.rst b/gdi/opentelemetry/components/statsd-receiver.rst
diff --git a/gdi/opentelemetry/components/tail-sampling-processor.rst b/gdi/opentelemetry/components/tail-sampling-processor.rst
diff --git a/gdi/opentelemetry/components/windowseventlog-receiver.rst b/gdi/opentelemetry/components/windowseventlog-receiver.rst
