From 6961696b9f81595467d8fd03fcb9c2d94b6a47a1 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Tue, 4 Feb 2025 17:55:51 +0100 Subject: [PATCH] OBSDOCS-1670: Add TOC links to OTel Collector component-listing pages --- .../otel-collector-connectors.adoc | 7 +++++++ .../otel-collector-exporters.adoc | 10 ++++++++++ .../otel-collector-extensions.adoc | 11 +++++++++++ .../otel-collector-processors.adoc | 15 +++++++++++++++ .../otel-collector-receivers.adoc | 17 +++++++++++++++++ 5 files changed, 60 insertions(+) diff --git a/observability/otel/otel-collector/otel-collector-connectors.adoc b/observability/otel/otel-collector/otel-collector-connectors.adoc index 713766c250..545305f3ee 100644 --- a/observability/otel/otel-collector/otel-collector-connectors.adoc +++ b/observability/otel/otel-collector/otel-collector-connectors.adoc @@ -8,6 +8,13 @@ toc::[] A connector connects two pipelines. It consumes data as an exporter at the end of one pipeline and emits data as a receiver at the start of another pipeline. It can consume and emit data of the same or different data type. It can generate and emit data to summarize the consumed data, or it can merely replicate or route data. +Currently, the following General Availability and Technology Preview connectors are available for the {OTELShortName}: + +- xref:../../../observability/otel/otel-collector/otel-collector-connectors.adoc#count-connector_otel-collector-connectors[Count Connector] +- xref:../../../observability/otel/otel-collector/otel-collector-connectors.adoc#routing-connector_otel-collector-connectors[Routing Connector] +- xref:../../../observability/otel/otel-collector/otel-collector-connectors.adoc#forward-connector_otel-collector-connectors[Forward Connector] +- xref:../../../observability/otel/otel-collector/otel-collector-connectors.adoc#spanmetrics-connector_otel-collector-connectors[Spanmetrics Connector] + [id="count-connector_{context}"] == Count Connector diff --git a/observability/otel/otel-collector/otel-collector-exporters.adoc b/observability/otel/otel-collector/otel-collector-exporters.adoc index 9bfcfbc907..76bd455151 100644 --- a/observability/otel/otel-collector/otel-collector-exporters.adoc +++ b/observability/otel/otel-collector/otel-collector-exporters.adoc @@ -8,6 +8,16 @@ toc::[] Exporters send data to one or more back ends or destinations. An exporter can be push or pull based. By default, no exporters are configured. One or more exporters must be configured. Exporters can support one or more data sources. Exporters might be used with their default settings, but many exporters require configuration to specify at least the destination and security settings. +Currently, the following General Availability and Technology Preview exporters are available for the {OTELShortName}: + +- xref:../../../observability/otel/otel-collector/otel-collector-exporters.adoc#otlp-exporter_otel-collector-exporters[OTLP Exporter] +- xref:../../../observability/otel/otel-collector/otel-collector-exporters.adoc#otlp-http-exporter_otel-collector-exporters[OTLP HTTP Exporter] +- xref:../../../observability/otel/otel-collector/otel-collector-exporters.adoc#debug-exporter_otel-collector-exporters[Debug Exporter] +- xref:../../../observability/otel/otel-collector/otel-collector-exporters.adoc#load-balancing-exporter_otel-collector-exporters[Load Balancing Exporter] +- xref:../../../observability/otel/otel-collector/otel-collector-exporters.adoc#prometheus-exporter_otel-collector-exporters[Prometheus Exporter] +- xref:../../../observability/otel/otel-collector/otel-collector-exporters.adoc#prometheus-remote-write-exporter_otel-collector-exporters[Prometheus Remote Write Exporter] +- xref:../../../observability/otel/otel-collector/otel-collector-exporters.adoc#kafka-exporter_otel-collector-exporters[Kafka Exporter] + [id="otlp-exporter_{context}"] == OTLP Exporter diff --git a/observability/otel/otel-collector/otel-collector-extensions.adoc b/observability/otel/otel-collector/otel-collector-extensions.adoc index 07c71497d4..0e76ed3de4 100644 --- a/observability/otel/otel-collector/otel-collector-extensions.adoc +++ b/observability/otel/otel-collector/otel-collector-extensions.adoc @@ -8,6 +8,17 @@ toc::[] Extensions add capabilities to the Collector. For example, authentication can be added to the receivers and exporters automatically. +Currently, the following General Availability and Technology Preview extensions are available for the {OTELShortName}: + +- xref:../../../observability/otel/otel-collector/otel-collector-extensions.adoc#bearertokenauth-extension_otel-collector-extensions[BearerTokenAuth Extension] +- xref:../../../observability/otel/otel-collector/otel-collector-extensions.adoc#oauth2client-extension_otel-collector-extensions[OAuth2Client Extension] +- xref:../../../observability/otel/otel-collector/otel-collector-extensions.adoc#filestorage-extension_otel-collector-extensions[File Storage Extension] +- xref:../../../observability/otel/otel-collector/otel-collector-extensions.adoc#oidcauth-extension_otel-collector-extensions[OIDC Auth Extension] +- xref:../../../observability/otel/otel-collector/otel-collector-extensions.adoc#jaegerremotesampling-extension_otel-collector-extensions[Jaeger Remote Sampling Extension] +- xref:../../../observability/otel/otel-collector/otel-collector-extensions.adoc#pprof-extension_otel-collector-extensions[Performance Profiler Extension] +- xref:../../../observability/otel/otel-collector/otel-collector-extensions.adoc#healthcheck-extension_otel-collector-extensions[Health Check Extension] +- xref:../../../observability/otel/otel-collector/otel-collector-extensions.adoc#zpages-extension_otel-collector-extensions[zPages Extension] + [id="bearertokenauth-extension_{context}"] == BearerTokenAuth Extension diff --git a/observability/otel/otel-collector/otel-collector-processors.adoc b/observability/otel/otel-collector/otel-collector-processors.adoc index 29bb641b18..36e80aa2ba 100644 --- a/observability/otel/otel-collector/otel-collector-processors.adoc +++ b/observability/otel/otel-collector/otel-collector-processors.adoc @@ -8,6 +8,21 @@ toc::[] Processors process the data between it is received and exported. Processors are optional. By default, no processors are enabled. Processors must be enabled for every data source. Not all processors support all data sources. Depending on the data source, multiple processors might be enabled. Note that the order of processors matters. +Currently, the following General Availability and Technology Preview processors are available for the {OTELShortName}: + +- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#batch-processor_otel-collector-processors[Batch Processor] +- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#memorylimiter-processor_otel-collector-processors[Memory Limiter Processor] +- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#resource-detection-processor_otel-collector-processors[Resource Detection Processor] +- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#attributes-processor_otel-collector-processors[Attributes Processor] +- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#resource-processor_otel-collector-processors[Resource Processor] +- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#span-processor_otel-collector-processors[Span Processor] +- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#kubernetes-attributes-processor_otel-collector-processors[Kubernetes Attributes Processor] +- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#filter-processor_otel-collector-processors[Filter Processor] +- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#routing-processor_otel-collector-processors[Routing Processor] +- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#cumulativetodelta-processor_otel-collector-processors[Cumulative-to-Delta Processor] +- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#groupbyattrsprocessor-processor_otel-collector-processors[Group-by-Attributes Processor] +- xref:../../../observability/otel/otel-collector/otel-collector-processors.adoc#transform-processor_otel-collector-processors[Transform Processor] + [id="batch-processor_{context}"] == Batch Processor diff --git a/observability/otel/otel-collector/otel-collector-receivers.adoc b/observability/otel/otel-collector/otel-collector-receivers.adoc index 26e78ecaa1..176fcab4bf 100644 --- a/observability/otel/otel-collector/otel-collector-receivers.adoc +++ b/observability/otel/otel-collector/otel-collector-receivers.adoc @@ -8,6 +8,23 @@ toc::[] Receivers get data into the Collector. A receiver can be push or pull based. Generally, a receiver accepts data in a specified format, translates it into the internal format, and passes it to processors and exporters defined in the applicable pipelines. By default, no receivers are configured. One or more receivers must be configured. Receivers may support one or more data sources. +Currently, the following General Availability and Technology Preview receivers are available for the {OTELShortName}: + +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#otlp-receiver_otel-collector-receivers[OTLP Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#jaeger-receiver_otel-collector-receivers[Jaeger Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#hostmetrics-receiver_otel-collector-receivers[Host Metrics Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#k8sobjectsreceiver-receiver_otel-collector-receivers[Kubernetes Objects Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#kubeletstats-receiver_otel-collector-receivers[Kubelet Stats Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#prometheus-receiver_otel-collector-receivers[Prometheus Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#otlpjsonfile-receiver_otel-collector-receivers[OTLP JSON File Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#zipkin-receiver_otel-collector-receivers[Zipkin Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#kafka-receiver_otel-collector-receivers[Kafka Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#k8scluster-receiver_otel-collector-receivers[Kubernetes Cluster Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#opencensus-receiver_otel-collector-receivers[OpenCensus Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#filelog-receiver_otel-collector-receivers[Filelog Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#journald-receiver_otel-collector-receivers[Journald Receiver] +- xref:../../../observability/otel/otel-collector/otel-collector-receivers.adoc#kubernetesevents-receiver_otel-collector-receivers[Kubernetes Events Receiver] + [id="otlp-receiver_{context}"] == OTLP Receiver