Skip to content

Commit c28f9b8

Browse files
authored
Update functions detector readme (#2533)
1 parent f4f3042 commit c28f9b8

File tree

1 file changed

+11
-10
lines changed
  • resource/opentelemetry-resource-detector-azure

1 file changed

+11
-10
lines changed

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

+11-10
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ OpenTelemetry Resource detectors for Azure
99
This library contains OpenTelemetry `Resource Detectors <https://opentelemetry.io/docs/specs/otel/resource/sdk/#detecting-resource-information-from-the-environment>`_ for the following Azure resources:
1010
* `Azure App Service <https://azure.microsoft.com/en-us/products/app-service>`_
1111
* `Azure Virtual Machines <https://azure.microsoft.com/en-us/products/virtual-machines>`_
12+
* `Azure Functions (Experimental) <https://azure.microsoft.com/en-us/products/functions>`_
1213

1314
Installation
1415
------------
@@ -60,16 +61,6 @@ The Azure App Service Resource Detector sets the following Resource Attributes:
6061
* ``service.instance.id`` set to the value of the ``WEBSITE_INSTANCE_ID`` environment variable.
6162
* ``azure.app.service.stamp`` set to the value of the ``WEBSITE_HOME_STAMPNAME`` environment variable.
6263

63-
The Azure Functions Resource Detector sets the following Resource Attributes:
64-
* ``service.name`` set to the value of the ``WEBSITE_SITE_NAME`` environment variable.
65-
* ``process.id`` set to the process ID collected from the running process.
66-
* ``cloud.platform`` set to ``azure_functions``.
67-
* ``cloud.provider`` set to ``azure``.
68-
* ``cloud.resource_id`` set using the ``WEBSITE_RESOURCE_GROUP``, ``WEBSITE_OWNER_NAME``, and ``WEBSITE_SITE_NAME`` environment variables.
69-
* ``cloud.region`` set to the value of the ``REGION_NAME`` environment variable.
70-
* ``faas.instance`` set to the value of the ``WEBSITE_INSTANCE_ID`` environment variable.
71-
* ``faas.max_memory`` set to the value of the ``WEBSITE_MEMORY_LIMIT_MB`` environment variable.
72-
7364
The Azure VM Resource Detector sets the following Resource Attributes according to the response from the `Azure Metadata Service <https://learn.microsoft.com/azure/virtual-machines/instance-metadata-service?tabs=windows>`_:
7465
* ``azure.vm.scaleset.name`` set to the value of the ``vmScaleSetName`` field.
7566
* ``azure.vm.sku`` set to the value of the ``sku`` field.
@@ -84,6 +75,16 @@ The Azure VM Resource Detector sets the following Resource Attributes according
8475
* ``os.version`` set to the value of the ``version`` field.
8576
* ``service.instance.id`` set to the value of the ``vmId`` field.
8677

78+
The Azure Functions Resource Detector is currently experimental. It sets the following Resource Attributes:
79+
* ``service.name`` set to the value of the ``WEBSITE_SITE_NAME`` environment variable.
80+
* ``process.id`` set to the process ID collected from the running process.
81+
* ``cloud.platform`` set to ``azure_functions``.
82+
* ``cloud.provider`` set to ``azure``.
83+
* ``cloud.resource_id`` set using the ``WEBSITE_RESOURCE_GROUP``, ``WEBSITE_OWNER_NAME``, and ``WEBSITE_SITE_NAME`` environment variables.
84+
* ``cloud.region`` set to the value of the ``REGION_NAME`` environment variable.
85+
* ``faas.instance`` set to the value of the ``WEBSITE_INSTANCE_ID`` environment variable.
86+
* ``faas.max_memory`` set to the value of the ``WEBSITE_MEMORY_LIMIT_MB`` environment variable.
87+
8788
For more information, see the `Semantic Conventions for Cloud Resource Attributes <https://opentelemetry.io/docs/specs/otel/resource/semantic_conventions/cloud/>`_.
8889

8990
References

0 commit comments

Comments
 (0)