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

[OpenTelemetry Collector] Update example with new configuration #13787

Merged
merged 1 commit into from
Apr 22, 2022
Merged

[OpenTelemetry Collector] Update example with new configuration #13787

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions ...ent/en/tracing/setup_overview/open_standards/otel_collector_datadog_exporter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,9 @@ processors:
exporters:
datadog/api:

tags:
- example:tag
host_metadata:
tags:
- example:tag

api:
key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
Copy link
Contributor

Choose a reason for hiding this comment

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

Not that you change that and it is not a big deal at all but IMHO aaaaa... looks bit strange. Arguably xxxxxx... or XXXX... more traditional substitution. And I think [xxxxx...] or <xxx...> have a better implied intentions.

Copy link
Contributor

Choose a reason for hiding this comment

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

I've seen aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa used for API key at Datadog more than once, and I personally prefer it to xxxx or XXXX.
"a" is the first letter of the alphabet and it sounds like someone saying "aaaaaaah", like "aaaaah we're missing the API key".
But you can't pronounce "XXXXX" :)
I don't particularly agree that "XXXX" has better implied intentions.

Copy link
Member Author

@mx-psi mx-psi Apr 22, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

👍 that's a good point. I think the right choice here is to put as an example:

api:
  key: ${DD_API_KEY}

and pass the API key as an environment variable, which is the recommended setup for sensitive fields.

This needs to change in a few places though and I think I want to wait a bit until we have made a change on environment variable resolution, but I will make a note, thanks!

Copy link
Contributor

Choose a reason for hiding this comment

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

@julien-lebot

I've seen aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa used for API key at Datadog more than once, and I personally prefer it to xxxx or XXXX.
"a" is the first letter of the alphabet and it sounds like someone saying "aaaaaaah", like "aaaaah we're missing the API key".
But you can't pronounce "XXXXX" :)
I don't particularly agree that "XXXX" has better implied intentions.

That teaches me that what I am very biased even about most obvious (for me) thing :)

Expand Down