Resource: remove unnecessary diagnostic when accessing attributes

[seemk]

Discussion issue: #5114

Since Resource already has 2 methods to deal with yet to be resolved attributes (asyncAttributesPending and waitForAsyncAttributes), the diagnostic seems redundant and perhaps misleading (since it's more of a debug message than an actual error).

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.21%. Comparing base (f1ef596) to head (5afc5f4).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5119      +/-   ##
==========================================
- Coverage   93.21%   93.21%   -0.01%     
==========================================
  Files         315      315              
  Lines        8096     8094       -2     
  Branches     1622     1621       -1     
==========================================
- Hits         7547     7545       -2     
  Misses        549      549              

Files with missing lines	Coverage Δ
packages/opentelemetry-resources/src/Resource.ts	100.00% <ø> (ø)

[pichlermarc]

Hi, thanks for reaching out - I think the reason why this pops up is because there's some other bug somewhere that triggers this message. IIRC the reason why this was put there was the following (some of the decisions made there predate my time on the project, but I'll try to give a summary as I understand it):

ResourceDetector.detect() was (still is) async. The reason for that was that there were some resource detectors that needed to perform an async operation to retrieve the resource. That was not great as the users had to await resource detection, which most of the time is not feasible as it would delay SDK registration and would cause dropped telemetry. At some point, we then introduced ResourceDetectorSync that would create resources that had async resolvable Attributes, a new feature at the time.

At the same time that this feature was introduced, awaiting the Attributes was moved to the export pipeline (SpanProcessor, MetricReader, ...) - that's the call to IResource#waitForAsyncAttributes() that's always called before before accessing IResource.attributes. If waitForAsyncAttributes() is not awaited, before accessing attributes this error is supposed to be logged - which is happening here. The error is supposed to tell the user that the attributes returned will be incomplete.

What that means is (from my perspective) is that one of these two statements should be true:

• there is somewhere a call that accesses the attributes in such a way, which is incorrect (in the SDK setup - like NodeSDK for instance, the export pipeline, or the user code)
  • if that's the case we need to address it there
• there is a bug in @opentelemetry/resource somewhere that needs to be addressed because it logs that error when it actually should not
  • if that's the case we need to come up with a test-case that triggers this an error message when there shouldn't be one and then address the bug

So to summarize: I'm worried we may be hiding a deeper issue here by removing that log. I think that we have to instead try to come up with a solution to the underlying problem.

[github-actions]

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

[github-actions]

This PR was closed because it has been stale for 14 days with no activity.