docs: `resource-detector` should not be tied to tracing #5188

luizhlelis · 2023-12-16T20:48:43Z

Fixes #3027
Design discussion issue #3027

Changes

Moving resource to its own section;
Add links to it in the trace, metric, and log sections.

Merge requirement checklist

CONTRIBUTING guidelines followed (nullable enabled, static analysis, etc.)
Unit tests added/updated
Appropriate CHANGELOG.md files updated for non-trivial changes
Changes in public API reviewed (if applicable)

cijothomas · 2023-12-18T17:54:48Z

Thank you for tackling this!
#5185 Is tweaking the wordings on Resource. Once that is merged, lets bring that as well to this PR before merging.

utpilla · 2023-12-18T21:34:06Z

@luizhlelis #5185 is merged. Please resolve the merge conflicts.

cijothomas · 2023-12-19T00:07:18Z

docs/resources/README.md

+Follow [this](#resource-detector) document
+to learn about writing custom resource detectors.
+
+The snippet below shows configuring the `Resource` associated with the provider.


this section is tricky, as it is tied to Tracing signal.. We need to document all three with SDK.CreateProvider and the OTel.Ext.Hosting style of configuration of resource.

The env variables part is good for all three.

@luizhlelis See if you can fix this part too. If not, we can still merge, and do some follow ups later.

hey @cijothomas, I've just removed that section from the resource doc. I left those definitions tied to the signals, for instance, trace, metrics, and logs. Please, let me know if that's what you want or if I should move them all to the new resource doc.

utpilla · 2023-12-22T01:21:48Z

docs/resources/README.md

+  [OpenTelemetry](../../src/OpenTelemetry/README.md) package), and implement
+  the `Detect` method.
+
+A demo ResourceDetector is shown [here](../trace/extending-the-sdk/MyResourceDetector.cs).


I think it would be better to simply show the code snippet to create a custom ResourceDetector here instead of pointing to docs/trace/...

You could then add code snippets that show how to add this custom ResourceDetector to all the three signals using both Sdk.Create/LoggerFactory.Create and Extensions.Hosting approach.

Let me know if you would like to address these in this PR itself.

codecov · 2023-12-23T20:49:45Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6250307) 83.38% compared to head (733f01c) 83.13%.
Report is 14 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5188      +/-   ##
==========================================
- Coverage   83.38%   83.13%   -0.26%     
==========================================
  Files         297      271      -26     
  Lines       12531    11970     -561     
==========================================
- Hits        10449     9951     -498     
+ Misses       2082     2019      -63

Flag	Coverage Δ
unittests	`?`
unittests-Solution-Experimental	`82.85% <100.00%> (?)`
unittests-Solution-Stable	`83.07% <100.00%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
...tation.AspNetCore/Implementation/HttpInListener.cs	`89.72% <100.00%> (+0.14%)`	⬆️

... and 32 files with indirect coverage changes

github-actions · 2023-12-31T03:16:46Z

This PR was marked stale due to lack of activity and will be closed in 7 days. Commenting or Pushing will instruct the bot to automatically remove the label. This bot runs once per day.

luizhlelis

@cijothomas and @utpilla, when you have the chance, please review the PR again. Let me know if I need to do something else.

luizhlelis · 2023-12-21T23:44:12Z

docs/resources/README.md

+Follow [this](#resource-detector) document
+to learn about writing custom resource detectors.
+
+The snippet below shows configuring the `Resource` associated with the provider.


hey @cijothomas, I've just removed that section from the resource doc. I left those definitions tied to the signals, for instance, trace, metrics, and logs. Please, let me know if that's what you want or if I should move them all to the new resource doc.

luizhlelis · 2023-12-23T20:12:28Z

docs/resources/README.md

+  [OpenTelemetry](../../src/OpenTelemetry/README.md) package), and implement
+  the `Detect` method.
+
+A demo ResourceDetector is shown [here](../trace/extending-the-sdk/MyResourceDetector.cs).


cijothomas · 2024-01-12T01:41:51Z

Utkarsh and myself both were on vacation. I just came back today - will review by tomorrow. Thanks for waiting patiently!

docs/resources/README.md

cijothomas · 2024-01-17T17:15:10Z

docs/resources/README.md

@@ -0,0 +1,109 @@
+# Resources
+


it would be good to give a background on what is resource etc. here in a follow up.

cijothomas

This does make resource less tied to tracing, so approving to merge.
We need to have a follow up to move the Resource readme from individual docs to the newly created common place. Specifically, content from https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/metrics/customizing-the-sdk#resource (and logs, traces too), should be moved to the common doc as much as possible

docs: resource-detector not be tied to tracing

230ceef

luizhlelis requested a review from a team December 16, 2023 20:48

fix: removing wrong resource-detector bookmark

a716387

cijothomas mentioned this pull request Dec 18, 2023

Improve docs on Resources to encourage its usage #5185

Merged

luizhlelis and others added 2 commits December 18, 2023 19:35

Merge branch 'main' into main

02a4580

docs: fixing new resource-detector links

8b4d024

cijothomas reviewed Dec 19, 2023

View reviewed changes

cijothomas mentioned this pull request Dec 20, 2023

[documentation] Describe how to use resource detectors for all signals open-telemetry/opentelemetry-dotnet-contrib#1509

Closed

luizhlelis added 2 commits December 21, 2023 20:21

fix: removing resource section tied to the trace

686ca71

Merge branch 'main' into main

fbd84b6

utpilla reviewed Dec 22, 2023

View reviewed changes

luizhlelis and others added 4 commits December 23, 2023 13:36

Merge branch 'main' into main

6ff7dce

docs: snippets to add custom ResourceDetector

a147131

fix: markdown lint for resources doc

99e1412

fix: add resources doc to solution

9630d17

github-actions bot added the Stale Issues and pull requests which have been flagged for closing due to inactivity label Dec 31, 2023

luizhlelis requested review from cijothomas and utpilla January 2, 2024 13:53

luizhlelis commented Jan 2, 2024

View reviewed changes

github-actions bot removed the Stale Issues and pull requests which have been flagged for closing due to inactivity label Jan 3, 2024

CodeBlanch and others added 2 commits January 8, 2024 15:22

Merge branch 'main' into main

4a13e6c

Merge remote-tracking branch 'upstream/main'

492593a

cijothomas reviewed Jan 12, 2024

View reviewed changes

docs/resources/README.md Outdated Show resolved Hide resolved

luizhlelis added 2 commits January 12, 2024 22:48

Merge remote-tracking branch 'upstream/main'

e784a10

chore: extending-the-sdk project for resources

a3d3c5d

luizhlelis added 3 commits January 12, 2024 23:42

fix: remove warnings braces should not be omitted

cb4807e

chore: formating code

22b8231

Merge remote-tracking branch 'upstream/main'

3edf8a7

cijothomas reviewed Jan 17, 2024

View reviewed changes

cijothomas approved these changes Jan 17, 2024

View reviewed changes

Merge branch 'main' into main

733f01c

alanwest merged commit 89e5382 into open-telemetry:main Jan 18, 2024
30 checks passed

Kielek mentioned this pull request Jul 12, 2024

[repo] Clarify resource detectors README open-telemetry/opentelemetry-dotnet-contrib#1952

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: `resource-detector` should not be tied to tracing #5188

docs: `resource-detector` should not be tied to tracing #5188

luizhlelis commented Dec 16, 2023

cijothomas commented Dec 18, 2023

utpilla commented Dec 18, 2023

cijothomas Dec 19, 2023

cijothomas Dec 20, 2023

luizhlelis Dec 21, 2023

utpilla Dec 22, 2023

utpilla Dec 22, 2023

luizhlelis Dec 23, 2023

codecov bot commented Dec 23, 2023 •

edited

Loading

github-actions bot commented Dec 31, 2023

luizhlelis left a comment

luizhlelis Dec 21, 2023

luizhlelis Dec 23, 2023

cijothomas commented Jan 12, 2024

cijothomas Jan 17, 2024

cijothomas left a comment

docs: resource-detector should not be tied to tracing #5188

docs: resource-detector should not be tied to tracing #5188

Conversation

luizhlelis commented Dec 16, 2023

Changes

Merge requirement checklist

cijothomas commented Dec 18, 2023

utpilla commented Dec 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Dec 23, 2023 • edited Loading

Codecov Report

github-actions bot commented Dec 31, 2023

luizhlelis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cijothomas commented Jan 12, 2024

Choose a reason for hiding this comment

cijothomas left a comment

Choose a reason for hiding this comment

docs: `resource-detector` should not be tied to tracing #5188

docs: `resource-detector` should not be tied to tracing #5188

codecov bot commented Dec 23, 2023 •

edited

Loading