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

Jump to bottom

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

Merged
merged 18 commits into from
Jan 18, 2024
Merged

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

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
230ceef
docs: `resource-detector` not be tied to tracing
luizhlelis Dec 16, 2023
a716387
fix: removing wrong `resource-detector` bookmark
luizhlelis Dec 16, 2023
02a4580
Merge branch 'main' into main
luizhlelis Dec 18, 2023
8b4d024
docs: fixing new resource-detector links
luizhlelis Dec 18, 2023
686ca71
fix: removing resource section tied to the trace
luizhlelis Dec 21, 2023
fbd84b6
Merge branch 'main' into main
luizhlelis Dec 21, 2023
6ff7dce
Merge branch 'main' into main
luizhlelis Dec 23, 2023
a147131
docs: snippets to add custom `ResourceDetector`
luizhlelis Dec 23, 2023
99e1412
fix: markdown lint for resources doc
luizhlelis Dec 23, 2023
9630d17
fix: add resources doc to solution
luizhlelis Dec 23, 2023
4a13e6c
Merge branch 'main' into main
CodeBlanch Jan 8, 2024
492593a
Merge remote-tracking branch 'upstream/main'
luizhlelis Jan 10, 2024
e784a10
Merge remote-tracking branch 'upstream/main'
luizhlelis Jan 13, 2024
a3d3c5d
chore: `extending-the-sdk` project for resources
luizhlelis Jan 13, 2024
cb4807e
fix: remove warnings braces should not be omitted
luizhlelis Jan 13, 2024
22b8231
chore: formating code
luizhlelis Jan 13, 2024
3edf8a7
Merge remote-tracking branch 'upstream/main'
luizhlelis Jan 16, 2024
733f01c
Merge branch 'main' into main
alanwest Jan 18, 2024
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
1 change: 1 addition & 0 deletions docs/logs/extending-the-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
* [Building your own exporter](#exporter)
* [Building your own processor](#processor)
* [Building your own sampler](#sampler)
* [Building your own resource detector](../../resources/README.md#resource-detector)
* [References](#references)

## Exporter
Expand Down
2 changes: 1 addition & 1 deletion docs/metrics/customizing-the-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,7 @@ It is recommended to model attributes that are static throughout the lifetime of
the process as Resources, instead of adding them as attributes(tags) on each
measurement.

Follow [this](../../trace/extending-the-sdk/README.md#resource-detector) document
Follow [this](../../resources/README.md#resource-detector) document
to learn about writing custom resource detectors.

The snippet below shows configuring the `Resource` associated with the provider.
Expand Down
1 change: 1 addition & 0 deletions docs/metrics/extending-the-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* [Building your own reader](#reader)
* [Building your own exemplar filter](#exemplarfilter)
* [Building your own exemplar reservoir](#exemplarreservoir)
* [Building your own resource detector](../../resources/README.md#resource-detector)
* [References](#references)

## Exporter
Expand Down
16 changes: 16 additions & 0 deletions docs/resources/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Resources

Copy link
Member

Choose a reason for hiding this comment

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

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

## Resource Detector

OpenTelemetry .NET SDK provides a resource detector for detecting resource
information from the `OTEL_RESOURCE_ATTRIBUTES` and `OTEL_SERVICE_NAME`
environment variables.

Custom resource detectors can be implemented:

* ResourceDetectors should inherit from
`OpenTelemetry.Resources.IResourceDetector`, (which belongs to the
[OpenTelemetry](../../src/OpenTelemetry/README.md) package), and implement
the `Detect` method.

A demo ResourceDetector is shown [here](../trace/extending-the-sdk/MyResourceDetector.cs).
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

2 changes: 1 addition & 1 deletion docs/trace/customizing-the-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ It is recommended to model attributes that are static throughout the lifetime of
the process as Resources, instead of adding them as attributes(tags) on each
`Activity`.

Follow [this](../extending-the-sdk/README.md#resource-detector) document
Follow [this](../../resources/README.md#resource-detector) document
to learn about writing custom resource detectors.

The snippet below shows configuring the `Resource` associated with the provider.
Expand Down
17 changes: 1 addition & 16 deletions docs/trace/extending-the-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Quick links:
* [Building your own instrumentation library](#instrumentation-library)
* [Building your own processor](#processor)
* [Building your own sampler](#sampler)
* [Building your own resource detector](#resource-detector)
* [Building your own resource detector](../../resources/README.md#resource-detector)
* [Registration extension method guidance for library authors](#registration-extension-method-guidance-for-library-authors)
* [References](#references)

Expand Down Expand Up @@ -340,21 +340,6 @@ class MySampler : Sampler

A demo sampler is shown [here](./MySampler.cs).

## Resource Detector

OpenTelemetry .NET SDK provides a resource detector for detecting resource
information from the `OTEL_RESOURCE_ATTRIBUTES` and `OTEL_SERVICE_NAME`
environment variables.

Custom resource detectors can be implemented:

* ResourceDetectors should inherit from
`OpenTelemetry.Resources.IResourceDetector`, (which belongs to the
[OpenTelemetry](../../../src/OpenTelemetry/README.md) package), and implement
the `Detect` method.

A demo ResourceDetector is shown [here](./MyResourceDetector.cs).

## Registration extension method guidance for library authors

> **Note**
Expand Down