Skip to content

Commit ac7d11f

Browse files
committed
supported detectors
1 parent 8e0f546 commit ac7d11f

File tree

3 files changed

+31
-6
lines changed

3 files changed

+31
-6
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ documents:
7171
* [Installation](./docs/installation.md)
7272
* [Configuration](./docs/configuration.md)
7373
* [Supported instrumentations](./docs/supported-instrumentations.md)
74+
* [Supported resource detectors](./docs/supported-resource-detectors.md)
7475
* [Migrating to upstream](./docs/migration.md)
7576

7677
## Troubleshooting

docs/installation.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,9 @@ package to your project.
3939
dotnet add package --prerelease Grafana.OpenTelemetry.Base
4040
```
4141

42-
The list of [supported instrumentations](./supported-instrumentations.md)
43-
specifies what instrumentations are included in the base package.
42+
The list of [supported instrumentations](./supported-instrumentations.md) and
43+
[supported resource detectors](./supported-resource-detectors.md)
44+
specify which are included in the base package and enabled by default.
4445

4546
## Minimizing unneeded dependencies
4647

@@ -52,8 +53,8 @@ dependencies.
5253

5354
To mitigate this situation, [base package](#install-the-base-package)
5455
with a built-in lazy-loading mechanism can be used. This mechanism will
55-
initialize any known available instrumentation library assembly, regardless of
56-
whether it's added as dependency of the [full package](#install-the-full-package-with-all-available-instrumentations)
56+
initialize known available instrumentation library or resource detectors
57+
assembly, regardless of whether it's added as dependency of the [full package](#install-the-full-package-with-all-available-instrumentations)
5758
or as part of the instrumented project.
5859

5960
For example, if it is desired to use the `AspNetCore` instrumentation without
@@ -76,5 +77,6 @@ using var tracerProvider = Sdk.CreateTracerProviderBuilder()
7677
.Build();
7778
```
7879

79-
This way, any other instrumentation library [supported by the distribution](./supported-instrumentations.md)
80-
can be added via lazy loading.
80+
This way, any other [instrumentation library](./supported-instrumentations.md)
81+
or [resource detector](./supported-resource-detectors.md) supported by the
82+
distribution can be added via lazy loading.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Supported resource detectors
2+
3+
The following resource detectors are recognized:
4+
5+
| Identifier | Enabled by default | Pre-installed | Library name |
6+
| --------------------- | ------------------ | ------------------ | ------------ |
7+
| `AWSEBS` | | | [OpenTelemetry.ResourceDetectors.AWS](https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.AWS) |
8+
| `AWSEC2` | | | [OpenTelemetry.ResourceDetectors.AWS](https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.AWS) |
9+
| `AWSECS` | | | [OpenTelemetry.ResourceDetectors.AWS](https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.AWS) |
10+
| `AWSEKS` | | | [OpenTelemetry.ResourceDetectors.AWS](https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.AWS) |
11+
| `AzureAppService` | | | [OpenTelemetry.ResourceDetectors.Azure](https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.Azure) |
12+
| `AzureVM` | | | [OpenTelemetry.ResourceDetectors.Azure](https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.Azure) |
13+
| `AzureContainerApps` | | | [OpenTelemetry.ResourceDetectors.Azure](https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.Azure) |
14+
| `Container` | | :heavy_check_mark: | [OpenTelemetry.ResourceDetectors.Container](https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.Container) |
15+
| `Host` | :heavy_check_mark: | :heavy_check_mark: | [OpenTelemetry.ResourceDetectors.Host](https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.Host) |
16+
| `OperatingSystem` | | | [OpenTelemetry.ResourceDetectors.OperatingSystem](https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.OperatingSystem) |
17+
| `Process` | :heavy_check_mark: | :heavy_check_mark: | [OpenTelemetry.ResourceDetectors.Process](https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.Process) |
18+
| `ProcessRuntime` | :heavy_check_mark: | :heavy_check_mark: | [OpenTelemetry.ResourceDetectors.ProcessRuntime](https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.ProcessRuntime) |
19+
20+
* The `Container` resource detector is included but needs to be explicitly
21+
activated, as activating it in non-container environments can causes erroneous
22+
attributes. A future release may activate it by default.

0 commit comments

Comments
 (0)