fix(detectors): reduce diag level on detectors failing to detect

[johnli-developer]

Which problem is this PR solving?

• Fix Reduce log level on detectors failing to detect #2268

Short description of the changes

• change log from warn to debug when detector failed to detect

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: johnli-developer / name: John (2e32496, 793f3bf)

[david-luna]

@johnli-developer thanks for contributing to the project :)

I see some other places in detectors where diag.warn is still used. Is this PR a work in progress?

[johnli-developer]

@johnli-developer thanks for contributing to the project :)

I see some other places in detectors where diag.warn is still used. Is this PR a work in progress?

This PR is complete it's change to debug for detectors. Which one would you also like to change to debug?

[trentm]

Here are some other ones:

% rg 'diag\.(info|warn)' detectors
detectors/node/opentelemetry-resource-detector-container/src/detectors/ContainerDetector.ts
65:      diag.info(
131:        diag.info(

detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEcsDetectorSync.ts
140:      diag.warn('AwsEcsDetector failed to read container ID', e);

detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEksDetectorSync.ts
98:      diag.warn('Process is not running on K8S', e);
141:      diag.warn('Cannot get cluster name on EKS', e);
157:      diag.warn('Unable to read Kubernetes client token.', e);
192:      diag.warn(`AwsEksDetector failed to read container ID: ${e.message}`);

That doesn't mean that this PR has to deal with all of them. But it won't "Fix: #2268" unless it gets all of them.

[codecov]

Codecov Report

Attention: Patch coverage is 71.42857% with 2 lines in your changes missing coverage. Please review.

Project coverage is 90.52%. Comparing base (dfb2dff) to head (2e32496).
Report is 221 commits behind head on main.

Files	Patch %	Lines
...e-detector-aws/src/detectors/AwsEksDetectorSync.ts	75.00%	1 Missing ⚠️
...ector-container/src/detectors/ContainerDetector.ts	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2382      +/-   ##
==========================================
- Coverage   90.97%   90.52%   -0.45%     
==========================================
  Files         146      157      +11     
  Lines        7492     7622     +130     
  Branches     1502     1571      +69     
==========================================
+ Hits         6816     6900      +84     
- Misses        676      722      +46     

Files	Coverage Δ
...e-detector-aws/src/detectors/AwsEcsDetectorSync.ts	97.02% <100.00%> (ø)
...e-detector-aws/src/detectors/AwsEksDetectorSync.ts	91.46% <75.00%> (ø)
...ector-container/src/detectors/ContainerDetector.ts	95.08% <50.00%> (+2.22%)	⬆️

... and 75 files with indirect coverage changes

[johnli-developer]

Here are some other ones:

% rg 'diag\.(info|warn)' detectors
detectors/node/opentelemetry-resource-detector-container/src/detectors/ContainerDetector.ts
65:      diag.info(
131:        diag.info(

detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEcsDetectorSync.ts
140:      diag.warn('AwsEcsDetector failed to read container ID', e);

detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEksDetectorSync.ts
98:      diag.warn('Process is not running on K8S', e);
141:      diag.warn('Cannot get cluster name on EKS', e);
157:      diag.warn('Unable to read Kubernetes client token.', e);
192:      diag.warn(`AwsEksDetector failed to read container ID: ${e.message}`);

That doesn't mean that this PR has to deal with all of them. But it won't "Fix: #2268" unless it gets all of them.

Sure, I will update them

[johnli-developer]

Here are some other ones:

% rg 'diag\.(info|warn)' detectors
detectors/node/opentelemetry-resource-detector-container/src/detectors/ContainerDetector.ts
65:      diag.info(
131:        diag.info(

detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEcsDetectorSync.ts
140:      diag.warn('AwsEcsDetector failed to read container ID', e);

detectors/node/opentelemetry-resource-detector-aws/src/detectors/AwsEksDetectorSync.ts
98:      diag.warn('Process is not running on K8S', e);
141:      diag.warn('Cannot get cluster name on EKS', e);
157:      diag.warn('Unable to read Kubernetes client token.', e);
192:      diag.warn(`AwsEksDetector failed to read container ID: ${e.message}`);

That doesn't mean that this PR has to deal with all of them. But it won't "Fix: #2268" unless it gets all of them.

@trentm They are updated, could you help review the changes?

[trentm]

Looks good. Thanks.
From the original issue:

So my proposal would be:

reduce the level to debug
rephrase the messages

This handles the first point: reducing to diag.debug.

I think the messages could benefit from some rephrasing to be less concerning, even for the user that has OTEL_LOG_LEVEL set to debug. However that could be done in a separate PR.

[trentm]

@johnli-developer I've set this up to merge when the PR is updated to the base branch. It looks like your fork repo doesn't allow me the access to do that. Can you update the base branch on this PR? I think the GitHub UI will show an "Update Branch" button for you.

[johnli-developer]

@johnli-developer I've set this up to merge when the PR is updated to the base branch. It looks like your fork repo doesn't allow me the access to do that. Can you update the base branch on this PR? I think the GitHub UI will show an "Update Branch" button for you.
@trentm I clicked that update branch button, is it OK now?