Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update OpenTelemetry Collector documentation #14542

Merged
merged 5 commits into from
Jul 18, 2022
Merged

Update OpenTelemetry Collector documentation #14542

merged 5 commits into from
Jul 18, 2022

Conversation

mx-psi
Copy link
Member

@mx-psi mx-psi commented Jul 6, 2022 •
edited
Loading

What does this PR do?

Improves OpenTelemetry Collector documentaiton to reflect changes on the Collector, the OTLP protocol and the Datadog exporter. More specifically:

  • Updates OTLP/gRPC port to 4317
  • Update information about hostname resolution in the Datadog exporter
  • Remove requirements related to a timeout of 10 seconds in the exporter
  • Add note about latest tag on Docker image
  • Add --hostname $(hostname) option for Docker deployments to ensure the hostname is accurate

Motivation

Ensure docs are up to date.

Preview

See #14542 (comment)

Reviewer checklist

  • Review the changed files.
  • Review the URLs listed in the Preview section.
  • Check images for PII
  • Review any mentions of "Contact Datadog support" for internal support documentation.

@github-actions github-actions bot added metrics Content changed in the metrics folder tracing Content changed in the tracing folder labels Jul 6, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jul 6, 2022 •
edited
Loading

Preview links (active after the build_preview check completes)

Modified Files

@mx-psi
Update OpenTelemetry Collector documentation
226f65a 
- Update port to 4317
- Add `--hostname` option on Docker deployments
- Update information about hostnames
- Remove sentence referring to deprecated configuration options
mx-psi
mx-psi commented Jul 6, 2022
View reviewed changes
content/en/tracing/setup_overview/open_standards/otel_collector_datadog_exporter.md Outdated Show resolved Hide resolved
content/en/tracing/setup_overview/open_standards/otel_collector_datadog_exporter.md Outdated Show resolved Hide resolved
content/en/tracing/setup_overview/open_standards/otel_collector_datadog_exporter.md Outdated Show resolved Hide resolved
content/en/tracing/setup_overview/open_standards/otel_collector_datadog_exporter.md Outdated Show resolved Hide resolved
content/en/tracing/setup_overview/open_standards/otel_collector_datadog_exporter.md Outdated Show resolved Hide resolved
content/en/tracing/setup_overview/open_standards/otel_collector_datadog_exporter.md Outdated Show resolved Hide resolved
content/en/metrics/otlp.md Outdated Show resolved Hide resolved
content/en/tracing/setup_overview/open_standards/otel_collector_datadog_exporter.md Outdated Show resolved Hide resolved
@mx-psi mx-psi requested review from gbbr and a team July 6, 2022 08:37
@mx-psi mx-psi marked this pull request as ready for review July 6, 2022 08:37
@mx-psi mx-psi requested a review from a team as a code owner July 6, 2022 08:37
gbbr
gbbr reviewed Jul 6, 2022
View reviewed changes
Copy link
Contributor

@gbbr gbbr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM, I'm going to try and update the K8s docs soon.

content/en/tracing/setup_overview/open_standards/otel_collector_datadog_exporter.md Outdated Show resolved Hide resolved
buraizu
buraizu approved these changes Jul 6, 2022
View reviewed changes
Copy link
Contributor

@buraizu buraizu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good from a docs perspective, but what's the reason for changing all the numbers to 1?

@mx-psi
Copy link
Member Author

mx-psi commented Jul 7, 2022

Looks good from a docs perspective, but what's the reason for changing all the numbers to 1?

It was just so that I didn't have to update them every time; Markdown will replace it with the actual numbers. Happy to revert that change if it goes against conventions in this repository :)

@mx-psi
Copy link
Member Author

mx-psi commented Jul 15, 2022

@buraizu could you merge this?

bkabrda
bkabrda approved these changes Jul 18, 2022
View reviewed changes
Copy link
Contributor

@bkabrda bkabrda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just one nit comment left inline.

content/en/metrics/otlp.md Outdated Show resolved Hide resolved
@buraizu buraizu merged commit 634f69d into master Jul 18, 2022
@buraizu buraizu deleted the mx-psi/otel-updates-ga branch July 18, 2022 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gbbr gbbr gbbr left review comments

@bkabrda bkabrda bkabrda approved these changes

@buraizu buraizu buraizu approved these changes

Assignees
No one assigned
Labels
metrics Content changed in the metrics folder tracing Content changed in the tracing folder
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mx-psi @bkabrda @gbbr @buraizu