[DOCS-6867] Restructure OTel Collector Datadog Exporter docs (#21002)

* first 2 pages * otlp * host metrics * add docker metrics * add logs and health * add health, trace, and batch * tech review feedback * fix nav * Apply suggestions from code review Co-authored-by: cecilia saixue watt <[email protected]> * simplify page titles * review feedback * missed one * another * add back missing steps for DS and GW * fix links * fix more links * review feedback --------- Co-authored-by: cecilia saixue watt <[email protected]>
DataDog · Jan 17, 2024 · 10f80a0 · 10f80a0
1 parent e49bebf
commit 10f80a0
Show file tree

Hide file tree

Showing 16 changed files with 1,723 additions and 3 deletions.
diff --git a/config/_default/menus/menus.en.yaml b/config/_default/menus/menus.en.yaml
@@ -736,11 +736,51 @@ main:
     pre: open-telemetry
     parent: essentials_heading
     weight: 46000
-  - name: OpenTelemetry Collector Datadog Exporter
-    url: opentelemetry/otel_collector_datadog_exporter/
-    identifier: otel_dd_exporter
+  - name: Set Up the Collector
+    url: opentelemetry/collector_exporter/
+    identifier: otel_gs_collector
     parent: opentelemetry_top_level
     weight: 1
+  - name: Hostnames and Tagging
+    url: opentelemetry/collector_exporter/hostname_tagging/
+    identifier: otel_gs_tagging
+    parent: otel_gs_collector
+    weight: 101
+  - name: OTLP Receiver
+    url: opentelemetry/collector_exporter/otlp_receiver/
+    identifier: otel_gs_otlp_receiver
+    parent: otel_gs_collector
+    weight: 102
+  - name: Host Metrics
+    url: opentelemetry/collector_exporter/host_metrics/
+    identifier: otel_gs_host_metrics
+    parent: otel_gs_collector
+    weight: 103
+  - name: Docker Metrics
+    url: opentelemetry/collector_exporter/docker_metrics/
+    identifier: otel_gs_docker_metrics
+    parent: otel_gs_collector
+    weight: 104
+  - name: Log Collection
+    url: opentelemetry/collector_exporter/log_collection/
+    identifier: otel_gs_log_collection
+    parent: otel_gs_collector
+    weight: 105
+  - name: Collector Health Metrics
+    url: opentelemetry/collector_exporter/collector_health_metrics/
+    identifier: otel_gs_coll_health
+    parent: otel_gs_collector
+    weight: 106
+  - name: Trace Metrics
+    url: opentelemetry/collector_exporter/trace_metrics/
+    identifier: otel_gs_trace_metrics
+    parent: otel_gs_collector
+    weight: 107
+  - name: Batch and Memory Settings
+    url: opentelemetry/collector_exporter/collector_batch_memory/
+    identifier: otel_gs_batch_memory
+    parent: otel_gs_collector
+    weight: 108
   - name: OTLP Ingestion by the Datadog Agent
     url: opentelemetry/otlp_ingest_in_the_agent/
     identifier: otel_ingest_agent

diff --git a/content/en/opentelemetry/collector_exporter/_index.md b/content/en/opentelemetry/collector_exporter/_index.md
diff --git a/content/en/opentelemetry/collector_exporter/collector_batch_memory.md b/content/en/opentelemetry/collector_exporter/collector_batch_memory.md
@@ -0,0 +1,82 @@
+---
+title: Batch and Memory Settings
+further_reading:
+- link: "/opentelemetry/collector_exporter/"
+  tag: "Documentation"
+  text: "Setting Up the OpenTelemetry Collector"
+---
+
+## Overview
+
+To edit your OpenTelemetry Collector batch and memory settings, configure the [batch processor][1] in your Datadog Exporter.
+
+For more information, see the OpenTelemetry project documentation for the [batch processor][1].
+
+## Setup
+
+{{< tabs >}}
+{{% tab "Host" %}}
+Add the following lines to your Collector configuration:
+
+```yaml
+processors:
+  batch:
+    # Datadog APM Intake limit is 3.2MB.    
+    send_batch_max_size: 1000
+    send_batch_size: 100
+    timeout: 10s
+  memory_limiter:
+    check_interval: 1s
+    limit_mib: 1000
+```
+
+{{% /tab %}}
+
+{{% tab "Kubernetes" %}}
+
+Add the following lines to `values.yaml`:
+
+```yaml
+resources:
+  limits:
+    cpu: 512m
+    memory: 1Gi
+```
+
+Add the following in the Collector configuration:
+
+```yaml
+processors:
+  batch:
+    # Datadog APM Intake limit is 3.2MB.    
+    send_batch_max_size: 1000
+    send_batch_size: 100
+    timeout: 10s
+```
+
+{{% /tab %}}
+{{< /tabs >}}
+
+
+## Data collected
+
+None.
+
+## Full example configuration
+
+For a full working example configuration with the Datadog exporter, see [`batch-memory.yaml`][2].
+
+## Example logging output
+
+```
+2023-12-05T09:52:58.568Z	warn	[email protected]/memorylimiter.go:276	
+Memory usage is above hard limit. Forcing a GC.	
+{"kind": "processor", "name": "memory_limiter", "pipeline": "traces", "cur_mem_mib": 44}
+2023-12-05T09:52:58.590Z	info	[email protected]/memorylimiter.go:266	
+Memory usage after GC.	
+{"kind": "processor", "name": "memory_limiter", "pipeline": "traces", "cur_mem_mib": 34}
+```
+
+
+[1]: https://github.com/open-telemetry/opentelemetry-collector/tree/main/processor/batchprocessor
+[2]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/datadogexporter/examples/batch-memory.yaml
diff --git a/content/en/opentelemetry/collector_exporter/collector_health_metrics.md b/content/en/opentelemetry/collector_exporter/collector_health_metrics.md
@@ -0,0 +1,131 @@
+---
+title: Health Metrics
+further_reading:
+- link: "/opentelemetry/collector_exporter/"
+  tag: "Documentation"
+  text: "Setting Up the OpenTelemetry Collector"
+---
+
+## Overview
+
+{{< img src="/opentelemetry/collector_exporter/collector_health_metrics.png" alt="OpenTelemetry Collector health metrics dashboard" style="width:100%;" >}}
+
+To collect health metrics from the OpenTelemetry Collector itself, configure the [Prometheus receiver][1] in your Datadog Exporter.
+
+For more information, see the OpenTelemetry project documentation for the [Prometheus receiver][1].
+
+## Setup
+
+Add the following lines to your Collector configuration:
+
+```yaml
+receivers:
+  prometheus:
+    config:
+      scrape_configs:
+      - job_name: 'otelcol'
+        scrape_interval: 10s
+        static_configs:
+        - targets: ['0.0.0.0:8888']
+```
+
+## Data collected
+
+| OpenTelemetry Metric | Description |
+|---|---|
+| `otelcol_process_uptime` | Uptime of the process |
+| `otelcol_process_memory_rss` | Total physical memory (resident set size) |
+| `otelcol_exporter_queue_size` | Current size of the retry queue (in batches) |
+| `otelcol_exporter_sent_spans` | Number of spans successfully sent to destination |
+| `otelcol_exporter_send_failed_metric_points` | Number of metric points in failed attempts to send to destination |
+| `otelcol_exporter_send_failed_spans` | Number of spans in failed attempts to send to destination |
+| `otelcol_process_cpu_seconds` | Total CPU user and system time in seconds |
+| `otelcol_receiver_refused_spans` | Number of spans that could not be pushed into the pipeline |
+| `otelcol_exporter_queue_capacity` | Fixed capacity of the retry queue (in batches) |
+| `otelcol_receiver_accepted_spans` | Number of spans successfully pushed into the pipeline |
+| `otelcol_exporter_sent_metric_points` | Number of metric points successfully sent to destination |
+| `otelcol_exporter_enqueue_failed_spans` | Number of spans failed to be added to the sending queue |
+| `otelcol_scraper_errored_metric_points` | Number of metric points that were unable to be scraped |
+| `otelcol_scraper_scraped_metric_points` | Number of metric points successfully scraped |
+| `otelcol_receiver_refused_metric_points` | Number of metric points that could not be pushed into the pipeline |
+| `otelcol_receiver_accepted_metric_points` | Number of metric points successfully pushed into the pipeline |
+| `otelcol_process_runtime_heap_alloc_bytes` | Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc') |
+| `otelcol_process_runtime_total_alloc_bytes` | Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc') |
+| `otelcol_exporter_enqueue_failed_log_records` | Number of log records failed to be added to the sending queue |
+| `otelcol_processor_batch_timeout_trigger_send` | Number of times the batch was sent due to a timeout trigger |
+| `otelcol_exporter_enqueue_failed_metric_points` | Number of metric points failed to be added to the sending queue |
+| `otelcol_process_runtime_total_sys_memory_bytes` | Total bytes of memory obtained from the OS (see [the Go docs for `runtime.MemStats.Sys`][3]) |
+| `otelcol_processor_batch_batch_size_trigger_send` | Number of times the batch was sent due to a size trigger |
+| `otelcol_exporter_sent_log_records` | Number of log records successfully sent to destination |
+| `otelcol_receiver_refused_log_records` | Number of log records that could not be pushed into the pipeline |
+| `otelcol_receiver_accepted_log_records` | Number of log records successfully pushed into the pipeline |
+
+
+## Full example configuration
+
+For a full working example configuration with the Datadog exporter, see [`collector-metrics.yaml`][2].
+
+## Example logging output
+
+```
+ResourceMetrics #0
+Resource SchemaURL: https://opentelemetry.io/schemas/1.6.1
+Resource attributes:
+     -> service.name: Str(opentelemetry-collector)
+     -> net.host.name: Str(192.168.55.78)
+     -> service.instance.id: Str(192.168.55.78:8888)
+     -> net.host.port: Str(8888)
+     -> http.scheme: Str(http)
+     -> k8s.pod.ip: Str(192.168.55.78)
+     -> cloud.provider: Str(aws)
+     -> cloud.platform: Str(aws_ec2)
+     -> cloud.region: Str(us-east-1)
+     -> cloud.account.id: Str(XXXXXXXXX)
+     -> cloud.availability_zone: Str(us-east-1c)
+     -> host.id: Str(i-0368add8e328c28f7)
+     -> host.image.id: Str(ami-08a2e6a8e82737230)
+     -> host.type: Str(m5.large)
+     -> host.name: Str(ip-192-168-53-115.ec2.internal)
+     -> os.type: Str(linux)
+     -> k8s.pod.name: Str(opentelemetry-collector-agent-gqwm8)
+     -> k8s.daemonset.name: Str(opentelemetry-collector-agent)
+     -> k8s.daemonset.uid: Str(6d6fef61-d4c7-4226-9b7b-7d6b893cb31d)
+     -> k8s.node.name: Str(ip-192-168-53-115.ec2.internal)
+     -> kube_app_name: Str(opentelemetry-collector)
+     -> kube_app_instance: Str(opentelemetry-collector)
+     -> k8s.namespace.name: Str(otel-staging)
+     -> k8s.pod.start_time: Str(2023-11-20T12:53:23Z)
+     -> k8s.pod.uid: Str(988d1bdc-5baf-4e98-942f-ab026a371daf)
+ScopeMetrics #0
+ScopeMetrics SchemaURL: 
+InstrumentationScope otelcol/prometheusreceiver 0.88.0-dev
+Metric #0
+Descriptor:
+     -> Name: otelcol_otelsvc_k8s_namespace_added
+     -> Description: Number of namespace add events received
+     -> Unit: 
+     -> DataType: Sum
+     -> IsMonotonic: true
+     -> AggregationTemporality: Cumulative
+NumberDataPoints #0
+Data point attributes:
+     -> service_instance_id: Str(d80d11f9-aa84-4e16-818d-3e7d868c0cfe)
+     -> service_name: Str(otelcontribcol)
+     -> service_version: Str(0.88.0-dev)
+StartTimestamp: 1970-01-01 00:00:00 +0000 UTC
+Timestamp: 2023-11-20 13:17:36.881 +0000 UTC
+Value: 194151496.000000
+Metric #9
+Descriptor:
+     -> Name: otelcol_receiver_accepted_spans
+     -> Description: Number of spans successfully pushed into the pipeline.
+     -> Unit: 
+     -> DataType: Sum
+     -> IsMonotonic: true
+     -> AggregationTemporality: Cumulative
+```
+
+
+[1]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/prometheusreceiver
+[2]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/datadogexporter/examples/collector-metrics.yaml
+[3]: https://pkg.go.dev/runtime#MemStats.Sys