Skip to content

[exporter/datadog] add basic API key validation on startup#36510

Merged
mx-psi merged 16 commits into
open-telemetry:mainfrom
jackgopack4:exporter/datadog/fix-API-key-validation
Dec 4, 2024
Merged

[exporter/datadog] add basic API key validation on startup#36510
mx-psi merged 16 commits into
open-telemetry:mainfrom
jackgopack4:exporter/datadog/fix-API-key-validation

Conversation

@jackgopack4
Copy link
Copy Markdown
Contributor

@jackgopack4 jackgopack4 commented Nov 22, 2024 •
edited
Loading

Description

adds basic hexadecimal character validation to Datadog API key on startup

Link to tracking issue

Fixes #36509

Testing

new "invalid API Key" test

Documentation

changelog file

@jackgopack4 jackgopack4 marked this pull request as ready for review November 22, 2024 21:24
@jackgopack4 jackgopack4 requested a review from a team as a code owner November 22, 2024 21:24
@mx-psi
Copy link
Copy Markdown
Member

mx-psi commented Nov 25, 2024 

        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -56,3 +56,3 @@
        	            	  API: (config.APIConfig) {
        	            	-  Key: (configopaque.String) "",
        	            	+  Key: (configopaque.String) (len=10) "[REDACTED]",
        	            	   Site: (string) (len=13) "datadoghq.com",
        	Test:       	TestUnmarshal/unmarshall_confighttp_client_configs

@jackgopack4
Copy link
Copy Markdown
Contributor Author

jackgopack4 commented Nov 25, 2024 

        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -56,3 +56,3 @@
        	            	  API: (config.APIConfig) {
        	            	-  Key: (configopaque.String) "",
        	            	+  Key: (configopaque.String) (len=10) "[REDACTED]",
        	            	   Site: (string) (len=13) "datadoghq.com",
        	Test:       	TestUnmarshal/unmarshall_confighttp_client_configs

going to look into this, not clear immediately if it's just broken/outdated test or if my change broke the intended behavior

@jackgopack4 jackgopack4 marked this pull request as draft November 25, 2024 14:42
@jackgopack4 jackgopack4 marked this pull request as ready for review November 25, 2024 15:51
@jackgopack4
Copy link
Copy Markdown
Contributor Author

jackgopack4 commented Nov 25, 2024

there may still be a discussion to be had around if we need to improve our API Key validation logic, but this keeps the behavior of v0.110.0 and prior so as to not break existing customers

mx-psi
mx-psi requested changes Nov 26, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@mx-psi mx-psi left a comment

Choose a reason for hiding this comment

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

This error comes from changes in the confmap and it is intentional. You can see the "0123" row in https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/env-vars.md#comparison-table-with-current-behavior that is this very case. I think we should not do this change and just think about how to improve the user experience (I left a concrete suggestion below).

Comment thread pkg/datadog/config/config.go Outdated
@jackgopack4 jackgopack4 changed the title fix api key validation issue when quotations are escaped inside string [exporter/datadog] add basic API key validation on startup Nov 26, 2024
@github-actions github-actions Bot added the exporter/datadog Datadog components label Nov 27, 2024
jackgopack4
jackgopack4 commented Nov 27, 2024
View reviewed changes
Comment thread pkg/datadog/config/config_test.go
@jackgopack4 jackgopack4 requested a review from mx-psi December 2, 2024 15:38
mx-psi
mx-psi reviewed Dec 2, 2024
View reviewed changes
Comment thread pkg/datadog/config/config.go Outdated
Comment thread pkg/datadog/config/config.go
Comment thread pkg/datadog/config/config.go Outdated
Comment thread pkg/datadog/config/config.go Outdated
Comment thread pkg/datadog/config/config.go Outdated
@jackgopack4 jackgopack4 requested a review from mx-psi December 2, 2024 18:44
mx-psi
mx-psi approved these changes Dec 3, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@mx-psi mx-psi left a comment

Choose a reason for hiding this comment

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

LGTM, can you fix the merge conflicts so I can merge?

@jackgopack4
Copy link
Copy Markdown
Contributor Author

jackgopack4 commented Dec 3, 2024

@mx-psi fixed merged conflicts and failing tests, should be good to go

@mx-psi mx-psi merged commit 66b0c3c into open-telemetry:main Dec 4, 2024
@github-actions github-actions Bot added this to the next release milestone Dec 4, 2024
shivanthzen pushed a commit to shivanthzen/opentelemetry-collector-contrib that referenced this pull request Dec 5, 2024
@jackgopack4 @mx-psi @shivanthzen
[exporter/datadog] add basic API key validation on startup (open-tele…
2780fc1 
…metry#36510)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
adds basic hexadecimal character validation to Datadog API key on
startup

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes open-telemetry#36509

<!--Describe what testing was performed and which tests were added.-->
#### Testing
new "invalid API Key" test

<!--Describe the documentation added.-->
#### Documentation
changelog file
<!--Please delete paragraphs that you did not use before submitting.-->

---------

Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
ZenoCC-Peng pushed a commit to ZenoCC-Peng/opentelemetry-collector-contrib that referenced this pull request Dec 6, 2024
@jackgopack4 @mx-psi @ZenoCC-Peng
[exporter/datadog] add basic API key validation on startup (open-tele…
148aece 
…metry#36510)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
adds basic hexadecimal character validation to Datadog API key on
startup

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes open-telemetry#36509

<!--Describe what testing was performed and which tests were added.-->
#### Testing
new "invalid API Key" test

<!--Describe the documentation added.-->
#### Documentation
changelog file
<!--Please delete paragraphs that you did not use before submitting.-->

---------

Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
sbylica-splunk pushed a commit to sbylica-splunk/opentelemetry-collector-contrib that referenced this pull request Dec 17, 2024
@jackgopack4 @mx-psi @sbylica-splunk
[exporter/datadog] add basic API key validation on startup (open-tele…
048d5b7 
…metry#36510)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
adds basic hexadecimal character validation to Datadog API key on
startup

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes open-telemetry#36509

<!--Describe what testing was performed and which tests were added.-->
#### Testing
new "invalid API Key" test

<!--Describe the documentation added.-->
#### Documentation
changelog file
<!--Please delete paragraphs that you did not use before submitting.-->

---------

Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
AkhigbeEromo pushed a commit to sematext/opentelemetry-collector-contrib that referenced this pull request Jan 13, 2025
@jackgopack4 @mx-psi @AkhigbeEromo
[exporter/datadog] add basic API key validation on startup (open-tele…
e5cb246 
…metry#36510)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
adds basic hexadecimal character validation to Datadog API key on
startup

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes open-telemetry#36509

<!--Describe what testing was performed and which tests were added.-->
#### Testing
new "invalid API Key" test

<!--Describe the documentation added.-->
#### Documentation
changelog file
<!--Please delete paragraphs that you did not use before submitting.-->

---------

Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
chengchuanpeng pushed a commit to chengchuanpeng/opentelemetry-collector-contrib that referenced this pull request Jan 26, 2025
@jackgopack4 @mx-psi @chengchuanpeng
[exporter/datadog] add basic API key validation on startup (open-tele…
7e4f417 
…metry#36510)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
adds basic hexadecimal character validation to Datadog API key on
startup

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes open-telemetry#36509

<!--Describe what testing was performed and which tests were added.-->
#### Testing
new "invalid API Key" test

<!--Describe the documentation added.-->
#### Documentation
changelog file
<!--Please delete paragraphs that you did not use before submitting.-->

---------

Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
zeck-ops pushed a commit to zeck-ops/opentelemetry-collector-contrib that referenced this pull request Apr 23, 2025
@jackgopack4 @mx-psi @zeck-ops
[exporter/datadog] add basic API key validation on startup (open-tele…
0271012 
…metry#36510)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
adds basic hexadecimal character validation to Datadog API key on
startup

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes open-telemetry#36509

<!--Describe what testing was performed and which tests were added.-->
#### Testing
new "invalid API Key" test

<!--Describe the documentation added.-->
#### Documentation
changelog file
<!--Please delete paragraphs that you did not use before submitting.-->

---------

Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
@jackgopack4 jackgopack4 mentioned this pull request Oct 6, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mx-psi mx-psi mx-psi approved these changes

@ankitpatel96 ankitpatel96 Awaiting requested review from ankitpatel96

@dineshg13 dineshg13 Awaiting requested review from dineshg13

@jade-guiton-dd jade-guiton-dd Awaiting requested review from jade-guiton-dd

@liustanley liustanley Awaiting requested review from liustanley

@mackjmr mackjmr Awaiting requested review from mackjmr

@songy23 songy23 Awaiting requested review from songy23 songy23 is a code owner

Assignees

@atoulme atoulme

@djaglowski djaglowski

Labels

connector/datadog exporter/datadog Datadog components pkg/datadog

Projects

None yet

Milestone

v0.115.0

Development

Successfully merging this pull request may close these issues.

[exporter/datadog] API key validation neither succeeds nor fails when API key is passed in as env var with quotes v0.111.0+

4 participants

@jackgopack4 @mx-psi @atoulme @djaglowski