From 230ceef1dbef58fc427c2b0c5c1f762d903ed529 Mon Sep 17 00:00:00 2001 From: Luiz Lelis Date: Sat, 16 Dec 2023 17:44:30 -0300 Subject: [PATCH] docs: `resource-detector` not be tied to tracing --- docs/logs/extending-the-sdk/README.md | 1 + docs/metrics/extending-the-sdk/README.md | 1 + docs/resources/README.md | 20 ++++++++++++++++++++ docs/trace/extending-the-sdk/README.md | 17 +---------------- 4 files changed, 23 insertions(+), 16 deletions(-) create mode 100644 docs/resources/README.md diff --git a/docs/logs/extending-the-sdk/README.md b/docs/logs/extending-the-sdk/README.md index d18b88624f0..f86387ef749 100644 --- a/docs/logs/extending-the-sdk/README.md +++ b/docs/logs/extending-the-sdk/README.md @@ -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) * [References](#references) ## Exporter diff --git a/docs/metrics/extending-the-sdk/README.md b/docs/metrics/extending-the-sdk/README.md index 4c409961d86..c72190bf8cb 100644 --- a/docs/metrics/extending-the-sdk/README.md +++ b/docs/metrics/extending-the-sdk/README.md @@ -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) * [References](#references) ## Exporter diff --git a/docs/resources/README.md b/docs/resources/README.md new file mode 100644 index 00000000000..84d3ce6f536 --- /dev/null +++ b/docs/resources/README.md @@ -0,0 +1,20 @@ +# Resources + +Quick links: + +* [Building your own resource detector](#resource-detector) + +## 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). diff --git a/docs/trace/extending-the-sdk/README.md b/docs/trace/extending-the-sdk/README.md index 10ad6b661ad..4d6fb215f49 100644 --- a/docs/trace/extending-the-sdk/README.md +++ b/docs/trace/extending-the-sdk/README.md @@ -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) * [Registration extension method guidance for library authors](#registration-extension-method-guidance-for-library-authors) * [References](#references) @@ -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**