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

kayayarai · 2023-12-12T22:46:47Z

What does this PR do? What is the motivation?

DOCS-6867

Merge instructions

Please merge after reviewing

Additional notes

github-actions · 2023-12-12T22:49:07Z

Preview links (active after the `build_preview` check completes)

New or renamed files

cswatt

My biggest concern is that I'm unclear on how the Datadog Exporter is related to the OpenTelemetry Collector. Is the exporter a component of the collector? And most critically—how does this play out wrt configuration? Do they share the same configuration? Is there a distinction between "configure the Exporter" and "configure the Collector"?

Other key points:

The setup codeblocks on the component pages need some context ("add this to your config file") / explicit direction as to what exactly to do with the codeblocks provided
On the Hostname and Tagging page, I can't really make sense of the Kubernetes DaemonSet->Gateway setup
I'm dubious about the page titles... I made some suggestions but I am really not sure about them

And then some regular spag stuff.

content/en/opentelemetry/collector_exporter/_index.md

cswatt · 2023-12-15T18:01:32Z

content/en/opentelemetry/collector_exporter/log_collection.md

@@ -0,0 +1,141 @@
+---
+title: Datadog Exporter Docker Stats Receiver Configuration


Suggested change

title: Datadog Exporter Docker Stats Receiver Configuration

title: Datadog Exporter Collector Log Collection

cswatt · 2023-12-15T18:01:47Z

content/en/opentelemetry/collector_exporter/otlp_receiver.md

@@ -0,0 +1,189 @@
+---
+title: Datadog Exporter OTLP Receiver


Suggested change

title: Datadog Exporter OTLP Receiver

title: Datadog Exporter Collector OTLP Receiver

cswatt · 2023-12-15T18:01:59Z

content/en/opentelemetry/collector_exporter/trace_metrics.md

@@ -0,0 +1,59 @@
+---
+title: Datadog Exporter Trace Metrics


Suggested change

title: Datadog Exporter Trace Metrics

title: Datadog Exporter Collector Trace Metrics

cswatt · 2023-12-15T18:24:12Z

content/en/opentelemetry/collector_exporter/_index.md

+
+[1]: https://hub.docker.com/r/otel/opentelemetry-collector-contrib/tags
+{{% /tab %}}
+{{% tab "Docker (other containers)" %}}


where does configuration go? i see an otel_collector_config.yaml and a config.yaml in step 2, is that related? if so, which one/both?

Are you referring to -v $(pwd)/otel_collector_config.yaml:/etc/otelcol-contrib/config.yaml ? If so, this is to mount volumes, so the otel_collector_config.yaml on the machine will be available in the container at this path: /etc/otelcol-contrib/config.yaml.

cswatt · 2023-12-15T18:27:24Z

content/en/opentelemetry/collector_exporter/_index.md

+{{% /tab %}}
+{{% tab "Kubernetes (Gateway)" %}}
+
+To deploy the OpenTelemetry Collector and Datadog Exporter in a Kubernetes Gateway deployment, use this [full example of configuring the OpenTelemetry Collector using the Datadog Exporter as a DaemonSet][1], including the application configuration example.


is this meant to link to the same examples as for Kubernetes DaemonSet? if so, then DaemonSet and Gateway have exactly the same instructions. is that intentional?

Co-authored-by: cecilia saixue watt <[email protected]>

kayayarai · 2023-12-15T19:25:55Z

@cswatt

I'm unclear on how the Datadog Exporter is related to the OpenTelemetry Collector. Is the exporter a component of the collector? And most critically—how does this play out wrt configuration? Do they share the same configuration? Is there a distinction between "configure the Exporter" and "configure the Collector"?

There's a diagram here https://docs.datadoghq.com/opentelemetry/ that shows how they're related-- does that help? I think you're correct that we need to be more specific about where the configs go. I'll add that.

mackjmr · 2023-12-19T13:00:08Z

content/en/opentelemetry/collector_exporter/_index.md

+
+[1]: https://hub.docker.com/r/otel/opentelemetry-collector-contrib/tags
+{{% /tab %}}
+{{% tab "Docker (other containers)" %}}


Are you referring to -v $(pwd)/otel_collector_config.yaml:/etc/otelcol-contrib/config.yaml ? If so, this is to mount volumes, so the otel_collector_config.yaml on the machine will be available in the container at this path: /etc/otelcol-contrib/config.yaml.

content/en/opentelemetry/collector_exporter/collector_health_metrics.md

content/en/opentelemetry/collector_exporter/docker_metrics.md

content/en/opentelemetry/collector_exporter/collector_batch_memory.md

mackjmr · 2023-12-19T13:33:11Z

For the additional context comments: any config file mentioned in the docs refers to the OpenTelemetry Collector configuration, except where it says values.yaml in which case it refers to the OpenTelemetry Collector helm chart.

content/en/opentelemetry/collector_exporter/otlp_receiver.md

config/_default/menus/menus.en.yaml

content/en/opentelemetry/collector_exporter/host_metrics.md

content/en/opentelemetry/collector_exporter/otlp_receiver.md

* 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]>

kayayarai added 6 commits December 12, 2023 14:07

first 2 pages

6608382

otlp

e163057

host metrics

4737002

add docker metrics

2ce8a2a

add logs and health

c02f395

add health, trace, and batch

6d0d447

kayayarai added the WORK IN PROGRESS No review needed, it's a wip ;) label Dec 12, 2023

kayayarai requested a review from a team as a code owner December 12, 2023 22:46

github-actions bot added Architecture Everything related to the Doc backend Images Images are added/removed with this PR labels Dec 12, 2023

kayayarai added 2 commits December 13, 2023 11:39

tech review feedback

28e90bf

fix nav

cc61636

kayayarai removed the WORK IN PROGRESS No review needed, it's a wip ;) label Dec 14, 2023

brett0000FF added the editorial review Waiting on a more in-depth review label Dec 14, 2023

cswatt requested changes Dec 15, 2023

View reviewed changes

Apply suggestions from code review

67b3dbd

Co-authored-by: cecilia saixue watt <[email protected]>

kayayarai and others added 2 commits December 15, 2023 13:28

simplify page titles

ee272cb

Merge branch 'master' into kari/docs-6867-otel-updates

26deb0a

mackjmr reviewed Dec 19, 2023

View reviewed changes

kayayarai and others added 7 commits January 8, 2024 09:46

Merge branch 'master' into kari/docs-6867-otel-updates

36587d8

review feedback

eff47c9

missed one

3526276

another

60b6e89

add back missing steps for DS and GW

2d1e54f

fix links

d3c5f4a

fix more links

0d4a087

dineshg13 reviewed Jan 10, 2024

View reviewed changes

content/en/opentelemetry/collector_exporter/otlp_receiver.md Outdated Show resolved Hide resolved

content/en/opentelemetry/collector_exporter/otlp_receiver.md Outdated Show resolved Hide resolved

config/_default/menus/menus.en.yaml Show resolved Hide resolved

dineshg13 reviewed Jan 10, 2024

View reviewed changes

content/en/opentelemetry/collector_exporter/host_metrics.md Outdated Show resolved Hide resolved

dineshg13 reviewed Jan 10, 2024

View reviewed changes

content/en/opentelemetry/collector_exporter/otlp_receiver.md Outdated Show resolved Hide resolved

cswatt approved these changes Jan 10, 2024

View reviewed changes

review feedback

aa31261

kayayarai merged commit 0305b3c into master Jan 10, 2024
11 checks passed

kayayarai deleted the kari/docs-6867-otel-updates branch January 10, 2024 17:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

kayayarai commented Dec 12, 2023

github-actions bot commented Dec 12, 2023

cswatt left a comment

cswatt Dec 15, 2023

cswatt Dec 15, 2023

cswatt Dec 15, 2023

cswatt Dec 15, 2023

mackjmr Dec 19, 2023

cswatt Dec 15, 2023

kayayarai commented Dec 15, 2023

mackjmr Dec 19, 2023

mackjmr commented Dec 19, 2023

		@@ -0,0 +1,141 @@
		---
		title: Datadog Exporter Docker Stats Receiver Configuration

	title: Datadog Exporter Docker Stats Receiver Configuration
	title: Datadog Exporter Collector Log Collection

	title: Datadog Exporter OTLP Receiver
	title: Datadog Exporter Collector OTLP Receiver

	title: Datadog Exporter Trace Metrics
	title: Datadog Exporter Collector Trace Metrics

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

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

Conversation

kayayarai commented Dec 12, 2023

What does this PR do? What is the motivation?

Merge instructions

Additional notes

github-actions bot commented Dec 12, 2023

Preview links (active after the build_preview check completes)

New or renamed files

cswatt left a comment

Choose a reason for hiding this comment

cswatt Dec 15, 2023

Choose a reason for hiding this comment

cswatt Dec 15, 2023

Choose a reason for hiding this comment

cswatt Dec 15, 2023

Choose a reason for hiding this comment

cswatt Dec 15, 2023

Choose a reason for hiding this comment

mackjmr Dec 19, 2023

Choose a reason for hiding this comment

cswatt Dec 15, 2023

Choose a reason for hiding this comment

kayayarai commented Dec 15, 2023

mackjmr Dec 19, 2023

Choose a reason for hiding this comment

mackjmr commented Dec 19, 2023

Preview links (active after the `build_preview` check completes)