Merge pull request #1212 from splunk/repo-sync

Pulling refs/heads/main into main

Author: aurbiztondo-splunk

_images/splunkplatform/pairingID.png

@@ -8,55 +8,13 @@ Collector components
     :description: Learn about the components that make up the Splunk Observability Cloud OpenTelemetry Collector.
 
 .. toctree::
-    :maxdepth: 4
     :titlesonly:
     :hidden:
 
-    components/attributes-processor
-    components/basic-auth-extension
-    components/batch-processor
-    components/databricks-receiver
-    components/filelog-receiver   
-    components/filter-processor
-    components/fluentd-receiver
-    components/groupbyattrs-processor    
-    components/health-check-extension
-    components/host-metrics-receiver
-    components/jaeger-receiver    
-    components/jmx-receiver    
-    components/kubelet-stats-receiver
-    components/kubernetes-attributes-processor
-    components/kubernetes-cluster-receiver
-    components/logging-exporter
-    components/memory-ballast-extension
-    components/memory-limiter-processor          
-    components/mongodb-atlas-receiver
-    components/mysql-receiver
-    components/oracledb-receiver
-    components/otlp-exporter
-    components/otlp-receiver         
-    components/otlphttp-exporter            
-    components/postgresql-receiver
-    components/prometheus-receiver
-    components/receiver-creator-receiver
-    components/resource-processor
-    components/resourcedetection-processor
-    components/simple-prometheus-receiver
-    components/signalfx-exporter
-    components/signalfx-receiver
-    components/smartagent-receiver
-    components/span-processor
-    components/splunk-apm-exporter
-    components/splunk-hec-exporter
-    components/splunk-hec-receiver
-    components/sqlquery-receiver     
-    components/syslog-receiver 
-    components/tcp-receiver     
-    components/transform-processor
-    components/udp-receiver
-    components/windowsperfcounters-receiver
-    components/zipkin-receiver 
-    components/zpages-extension    
+    Receivers <components/a-components-receivers.rst>
+    Processors <components/a-components-processors.rst>
+    Exporters <components/a-components-exporters.rst>
+    Extensions <components/a-components-extensions.rst>        
 
 The OpenTelemetry Collector includes the following component types:
 
@@ -87,22 +45,22 @@ The Splunk Distribution of OpenTelemetry Collector includes and supports the com
    * - Name
      - Description
      - Pipeline types
-   * - ``azureeventhub``
+   * - :ref:`azureeventhub-receiver` (``azureeventhub``) 
      - Pulls logs from an Azure event hub.
      - Logs
-   * - ``carbon``
+   * - :ref:`carbon-receiver` (``carbon``)
      - Receives metrics in Carbon plaintext protocol.
      - Metrics
-   * - ``cloudfoundry``
+   * - :ref:`cloudfoundry-receiver` (``cloudfoundry``)
      - Connects to the Reverse Log Proxy (RLP) gateway of Cloud Foundry to extract metrics.
      - Metrics
-   * - ``collectd``
+   * - :ref:`collectd-receiver` (``collectd``)
      - Receives data exported through the CollectD ``write_http`` plugin. Only supports the JSON format.
      - Metrics
    * - :ref:`databricks_receiver` (``databricks``)
      - Uses the Databricks API to generate metrics about the operation of a Databricks instance.
      - Metrics
-   * - ``discovery``
+   * - :ref:`discovery-receiver` (``discovery``)
      - Wraps the receiver creator to facilitate the discovery of metric collection targets. See :ref:`discovery_mode`.
      - Logs
    * - :ref:`filelog-receiver` (``filelog``)
@@ -120,22 +78,22 @@ The Splunk Distribution of OpenTelemetry Collector includes and supports the com
    * - :ref:`jmx-receiver` (``jmx``)
      - Works in conjunction with the :new-page:`OpenTelemetry JMX Metric Gatherer <https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/README.md>` to report metrics from an MBean server.
      - Metrics
-   * - ``journald``
+   * - :ref:`journald-receiver` (``journald``)
      - Parses Journald events from the systemd journal. The ``journalctl`` binary must be in the same ``$PATH`` of the agent.
      - Logs
-   * - ``kafkametrics``
-     - Collects Kafka metrics such as brokers, topics, partitions, and consumer groups from Kafka server, and converts them to OTLP format.
-     - Metrics
-   * - ``kafka``
+   * - :ref:`kafka-receiver` (``kafka``)
      - Receives metrics, logs, and traces from Kafka. Metrics and logs only support the OTLP format.
      - Metrics, logs, traces
+   * - :ref:`kafkametrics-receiver` (``kafkametrics``)
+     - Collects Kafka metrics such as brokers, topics, partitions, and consumer groups from Kafka server, and converts them to OTLP format.
+     - Metrics
    * - :ref:`kubernetes-cluster-receiver` (``k8s_cluster``)
      - Collects cluster-level metrics from the Kubernetes API server. It uses the Kubernetes API to listen for updates. You can use a single instance of this receiver to monitor a cluster.
      - Metrics
-   * - ``k8s_events``
+   * - :ref:`kubernetes-events-receiver` (``k8s_events``)
      - Collects all new and updated events from the Kubernetes API server. Supports authentication through service accounts only.
      - Logs
-   * - ``k8sobjects``
+   * - :ref:`kubernetes-objects-receiver` (``k8sobjects``)
      - Collects objects from the Kubernetes API server. Supports authentication through service accounts only.
      - Logs
    * - :ref:`kubelet-stats-receiver` (``kubeletstats``)
@@ -165,10 +123,10 @@ The Splunk Distribution of OpenTelemetry Collector includes and supports the com
    * - :ref:`receiver-creator-receiver` (``receiver_creator``)
      - Instantiates other receivers at runtime based on whether observed endpoints match a configured rule. To use the receiver creator, configure one or more observer extensions to discover networked endpoints.
      - N/A
-   * - ``redis``
+   * - :ref:`redis-receiver` (``redis``)
      - Retrieves Redis ``INFO`` data from a specific Redis instance and builds metrics from it.
      - Metrics
-   * - ``sapm``
+   * - :ref:`sapm-receiver` (``sapm``)
      - Receives traces from other collectors or from the SignalFx Smart Agent.
      - Traces
    * - :ref:`signalfx-receiver` (``signalfx``)
@@ -183,7 +141,7 @@ The Splunk Distribution of OpenTelemetry Collector includes and supports the com
    * - :ref:`sqlquery-receiver` (``sqlquery``)
      - Runs custom SQL queries to generate metrics from a database connection.
      - Metrics
-   * - ``statsd``
+   * - :ref:`statsd-receiver` (``statsd``)
      - Collects StatsD messages to generate metrics.
      - Metrics
    * - :ref:`syslog-receiver` (``syslog``)
@@ -195,7 +153,7 @@ The Splunk Distribution of OpenTelemetry Collector includes and supports the com
    * - :ref:`udp-logs-receiver` (``udplog``) 
      - Receives logs over UDP.
      - Logs
-   * - ``windowseventlog``
+   * - :ref:`windowseventlog-receiver` (``windowseventlog``)
      - Tails and parses logs from the Windows Event log API.
      - Logs
    * - :ref:`windowsperfcounters-receiver` (``windowsperfcounters``) (Windows only)
@@ -240,10 +198,10 @@ The Splunk Distribution of OpenTelemetry Collector includes and supports the com
    * - :ref:`memory-limiter-processor` (``memory_limiter``) 
      - Prevents out of memory situations on the Splunk Distribution of OpenTelemetry Collector.
      - Metrics, logs, traces
-   * - ``metricstransform``
+   * - :ref:`metrics-transform-processor` (``metricstransform``) 
      - Renames metrics, and adds, renames, or deletes label keys and values.
      - Metrics
-   * - ``probabilisticsampler``
+   * - :ref:`probabilistic-sampler-processor` (``probabilisticsampler``) 
      - Provides samples based on hash values determined by trace IDs.
      - Traces
    * - :ref:`resource-processor` (``resource``)
@@ -252,13 +210,13 @@ The Splunk Distribution of OpenTelemetry Collector includes and supports the com
    * - :ref:`resourcedetection-processor` (``resourcedetection``)
      - Detects resource information from the host, in a format that conforms to the OpenTelemetry resource semantic conventions, and appends or overrides the resource value in telemetry data with this information.
      - Metrics, logs, traces
-   * - ``routing``
+   * - :ref:`routing-processor` (``routing``) 
      - Reads a header from the incoming HTTP request or reads a resource attribute, and then directs the trace information to specific exporters based on the value.
      - Metrics, logs, traces
    * - :ref:`span-processor` (``span``)
      - Modifies either the span name or attributes of a span based on the span name.
      - Traces
-   * - ``tail_sampling``
+   * - :ref:`tail-sampling-processor` (``tail_sampling``) 
      - Samples traces based on a set of defined policies. All spans for a given trace must be received by the same Collector instance for effective sampling decisions.
      - Traces
    * - :ref:`transform-processor` (``transform``)
@@ -283,10 +241,13 @@ The Splunk Distribution of OpenTelemetry Collector includes and supports the com
    * - Name
      - Description
      - Pipeline types
-   * - ``file``
+   * - :ref:`awss3-exporter` (``awss3``) 
+     - This exporter targets to support proto/json format. 
+     - Metrics, logs, traces
+   * - :ref:`file-exporter` (``file``)
      - Writes pipeline data to a JSON file in Protobuf JSON encoding using the OpenTelemetry protocol. 
      - Metrics, logs, traces
-   * - ``kafka``
+   * - :ref:`kafka-exporter` (``kafka``)
      - Exports metrics, logs, and traces to Kafka using a synchronous producer. 
      - Metrics, logs, traces
    * - :ref:`logging-exporter` (``logging``)
@@ -298,9 +259,6 @@ The Splunk Distribution of OpenTelemetry Collector includes and supports the com
    * - :ref:`otlphttp-exporter` (``otlphttp``)
      - Exports data in OTLP format over the HTTP protocol. 
      - Metrics, logs, traces
-   * - :ref:`splunk-apm-exporter` (``sapm``)
-     - Allows the Splunk Distribution of OpenTelemetry Collector to export traces from multiple nodes or services in a single batch. 
-     - Traces  
    * - :ref:`signalfx-exporter` (``signalfx``)
      - Sends metrics, events, and trace correlation to Splunk Observability Cloud. 
      - Logs (events), metrics, traces (trace to metric correlation only)
@@ -328,25 +286,25 @@ The Splunk Distribution of OpenTelemetry Collector includes and supports the com
      - Description
    * - :ref:`basic-auth-extension` (``basicauth``)
      - Implements both ``configauth.ServerAuthenticator`` and ``configauth.ClientAuthenticator`` to authenticate clients and servers using basic authentication. The authenticator type has to be set to ``basicauth``.      
-   * - ``docker_observer``
+   * - :ref:`docker-observer-extension` (``docker_observer``)
      - Detects and reports container endpoints discovered through the Docker API. Only containers that are in the state of ``Running`` and not ``Paused`` emit endpoints.
-   * - ``ecs_observer``
+   * - :ref:`ecs-observer-extension` (``ecs_observer``)
      - Uses the ECS and EC2 API to discover Prometheus scrape targets from all running tasks and filter them based on service names, task definitions, and container labels. Only compatible with the Prometheus receiver.
-   * - ``file_storage``
+   * - :ref:`file-storage-extension` (``file_storage``)
      - Persists state to the local file system. Requires read and write access to a diectory.
    * - :ref:`health-check-extension` (``health_check``)
      - Activates an HTTP URL that can be probed to check the status of the OpenTelemetry Collector. You can also use this extension as a liveness or readiness probe on Kubernetes.
-   * - ``http_forwarder``
+   * - :ref:`http-forwarder-extension` (``http_forwarder``)
      - Accepts HTTP requests and optionally adds headers and forwards them. The RequestURIs of the original requests are preserved by the extension. 
-   * - ``host_observer``
+   * - :ref:`host-observer-extension` (``host_observer``) 
      - Looks at the current host for listening network endpoints. Uses the /proc file system and requires the ``SYS_PTRACE`` and ``DAC_READ_SEARCH`` capabilities so that it can determine what processes own the listening sockets. See :ref:`receiver-creator-receiver` for more information.
-   * - ``k8s_observer``
+   * - :ref:`kubernetes-observer-extension` (``k8s_observer``)
      - Uses the Kubernetes API to discover pods running on the local node. See :ref:`receiver-creator-receiver` for more information.
    * - :ref:`memory-ballast-extension` (``memory_ballast``)
      - Configures the memory ballast for the Collector process, either as a size in megabytes or as a size expressed as a percentage of the total memory. Sufficient ballast enhances the stability of Collector deployments.
-   * - ``pprof``
+   * - :ref:`pprof-extension` (``pprof``)
      - Activates the golang ``net/http/pprof`` endpoint, which is used to collect performance profiles and investigate issues with a service.
-   * - ``smartagent``
+   * - :ref:`smartagent-extension` (``smartagent``) 
      - Provides a mechanism to set configuration options that are applicable to all instances of the Smart Agent receiver. Allows to migrate your existing Smart Agent configuration to the Splunk Distribution of OpenTelemetry Collector. 
    * - :ref:`zpages-extension` (``zpages``) 
      - Activates an extension that serves zPages, an HTTP endpoint that provides live data for debugging different components.
@@ -357,7 +315,7 @@ The Splunk Distribution of OpenTelemetry Collector includes and supports the com
     <h2>Next steps<a name="next-steps" class="headerlink" href="#next-steps" title="Permalink to this headline">¶</a></h2>
   </embed>
 
-Read on to learn how to:
+See the following docs:
 
-* :ref:`otel-install-platform`.
-* :ref:`otel-configuration`.
+* :ref:`otel-install-platform`
+* :ref:`collector-how-to`

_images/splunkplatform/unifiedID-pairingSuccess.png

@@ -0,0 +1,37 @@
+.. _otel-components-exporters:
+
+******************************************
+Collector components: Exporters
+******************************************
+
+.. meta::
+    :description: Learn about the components that make up the Splunk Observability Cloud OpenTelemetry Collector.
+
+.. toctree::
+    :maxdepth: 4
+    :titlesonly:
+    :hidden:
+
+    awss3-exporter
+    file-exporter
+    kafka-exporter    
+    logging-exporter
+    otlp-exporter
+    otlphttp-exporter            
+    signalfx-exporter
+    splunk-apm-exporter
+    splunk-hec-exporter
+
+The following exporters are available in the Splunk Distribution of OpenTelemetry Collector:
+
+* :ref:`awss3-exporter`
+* :ref:`file-exporter`
+* :ref:`kafka-exporter`
+* :ref:`logging-exporter`
+* :ref:`otlp-exporter`
+* :ref:`otlphttp-exporter`            
+* :ref:`signalfx-exporter`
+* :ref:`splunk-apm-exporter`
+* :ref:`splunk-hec-exporter`
+
+To see other components, refer to :ref:`otel-components`.

gdi/opentelemetry/collector-linux/install-linux-manual.rst

@@ -0,0 +1,47 @@
+.. _otel-components-extensions:
+
+******************************************
+Collector components: Extensions
+******************************************
+
+.. meta::
+    :description: Learn about the components that make up the Splunk Observability Cloud OpenTelemetry Collector.
+
+.. toctree::
+    :maxdepth: 4
+    :titlesonly:
+    :hidden:
+
+    basic-auth-extension
+    docker-observer-extension
+    ecs-observer-extension
+    file-storage-extension
+    health-check-extension
+    host-observer-extension
+    http-forwarder-extension
+    kubernetes-observer-extension
+    memory-ballast-extension
+    pprof-extension
+    smartagent-extension
+    zpages-extension    
+
+The Splunk Distribution of the OpenTelemetry Collector includes and supports the extensions listed on this doc. To see other components, refer to :ref:`otel-components`.
+
+.. note:: The following list might not contain all the latest additions. For a complete list of Collector components, including components that aren't included in the Splunk Distribution of OpenTelemetry Collector, see the ``opentelemetry-contrib`` repository in GitHub.
+
+The following extensions are available:
+
+* :ref:`basic-auth-extension`
+* :ref:`docker-observer-extension`
+* :ref:`ecs-observer-extension`
+* :ref:`file-storage-extension`
+* :ref:`health-check-extension`
+* :ref:`host-observer-extension`
+* :ref:`http-forwarder-extension`
+* :ref:`kubernetes-observer-extension` 
+* :ref:`memory-ballast-extension`
+* :ref:`pprof-extension`
+* :ref:`smartagent-extension`
+* :ref:`zpages-extension`    
+
+

gdi/opentelemetry/components.rst

@@ -0,0 +1,46 @@
+.. _otel-components-processors:
+
+******************************************
+Collector components: Processors
+******************************************
+
+.. meta::
+    :description: Learn about the components that make up the Splunk Observability Cloud OpenTelemetry Collector.
+
+.. toctree::
+    :titlesonly:
+    :hidden:
+
+    attributes-processor
+    batch-processor
+    filter-processor
+    groupbyattrs-processor    
+    kubernetes-attributes-processor
+    memory-limiter-processor          
+    metrics-transform-processor 
+    probabilistic-sampler-processor
+    resource-processor
+    resourcedetection-processor
+    routing-processor
+    span-processor
+    tail-sampling-processor
+    transform-processor
+
+The following processors are available:
+
+* :ref:`attributes-processor`
+* :ref:`batch-processor`
+* :ref:`filter-processor`
+* :ref:`groupbyattrs-processor`    
+* :ref:`kubernetes-attributes-processor`
+* :ref:`memory-limiter-processor`    
+* :ref:`metrics-transform-processor`  
+* :ref:`probabilistic-sampler-processor`    
+* :ref:`resource-processor`
+* :ref:`resourcedetection-processor`
+* :ref:`routing-processor`
+* :ref:`span-processor`
+* :ref:`tail-sampling-processor`
+* :ref:`transform-processor`
+
+To see other components, refer to :ref:`otel-components`.