Skip to content

Commit fa3dfa0

Browse files
committed
readme
1 parent 19d6f75 commit fa3dfa0

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

resource/opentelemetry-resource-detector-azure-app-service/README.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ OpenTelemetry Resource detectors for Azure App Services
33

44
|pypi|
55

6-
.. |pypi| image:: TODO
7-
:target: TODO
6+
.. |pypi| image:: https://badge.fury.io/py/opentelemetry-resource-detector-azure-app-service.svg
7+
:target: https://pypi.org/project/opentelemetry-resource-detector-azure-app-service/
88

99

10-
This library provides custom resource detector for container platforms
10+
This library provides custom resource detector for Azure App Services
1111

1212
Installation
1313
------------
@@ -18,14 +18,14 @@ Installation
1818

1919
---------------------------
2020

21-
Usage example for `opentelemetry-resource-detector-container`
21+
Usage example for `opentelemetry-resource-detector-azure-app-service`
2222

2323
.. code-block:: python
2424
2525
from opentelemetry import trace
2626
from opentelemetry.sdk.trace import TracerProvider
27-
from opentelemetry.resource.detector.container import (
28-
ContainerResourceDetector,
27+
from opentelemetry.resource.detector.azure.app_service import (
28+
AzureAppServiceResourceDetector,
2929
)
3030
from opentelemetry.sdk.resources import get_aggregated_resources
3131
@@ -34,12 +34,16 @@ Usage example for `opentelemetry-resource-detector-container`
3434
TracerProvider(
3535
resource=get_aggregated_resources(
3636
[
37-
ContainerResourceDetector(),
37+
AzureAppServiceResourceDetector(),
3838
]
3939
),
4040
)
4141
)
4242
43+
You can also enable the App Service Resource Detector by adding `azure_app_service` to the `OTEL_EXPERIMENTAL_RESOURCE_DETECTORS` environment variable:
44+
45+
`export OTEL_EXPERIMENTAL_RESOURCE_DETECTORS=azure_app_service`
46+
4347
References
4448
----------
4549

resource/opentelemetry-resource-detector-azure-app-service/pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ dependencies = [
3232
test = []
3333

3434
[project.entry-points.opentelemetry_resource_detector]
35-
# TODO: could remove azure from class name
36-
container = "opentelemetry.resource.detector.azure.app_service:AzureAppServiceResourceDetector"
35+
azure_app_service = "opentelemetry.resource.detector.azure.app_service:AzureAppServiceResourceDetector"
3736

3837
[project.urls]
3938
Homepage = "https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/resource/opentelemetry-resource-detector-azure-app-service"

0 commit comments

Comments
 (0)