Skip to content

opentelemetry-resource-detector-azure

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

opentelemetry-resource-detector-azure

README.md

OpenTelemetry Resource Detector for Azure

[![NPM Published Version][npm-img]][npm-url] [![Apache License][license-image]][license-image]

component owners: @JacksonWeber

Resource detector for Azure.

Installation

npm install --save @opentelemetry/resource-detector-azure

Usage

import { detectResources } from '@opentelemetry/resources';
import { azureAppServiceDetector } from '@opentelemetry/resource-detector-azure';
const resource = detectResourcesSync({
    detectors: [azureAppServiceDetector],
});

const tracerProvider = new NodeTracerProvider({ resource });

Available Detectors

App Service Resource Detector

Attribute Description
azure.app.service.stamp The specific "stamp" cluster within Azure where the App Service is running, e.g., "waws-prod-sn1-001".
cloud.platform The cloud platform. Here, it's always "azure_app_service".
cloud.provider The cloud service provider. In this context, it's always "azure".
cloud.resource_id The Azure Resource Manager URI uniquely identifying the Azure App Service. Typically in the format "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Web/sites/{siteName}".
cloud.region The Azure region where the App Service is hosted, e.g., "East US", "West Europe", etc.
deployment.environment The deployment slot where the Azure App Service is running, such as "staging", "production", etc.
host.id The primary hostname for the app, excluding any custom hostnames.
service.instance.id The specific instance of the Azure App Service, useful in a scaled-out configuration.
service.name The name of the Azure App Service.

VM Resource Detector

Attribute Description
azure.vm.scaleset.name The name of the Virtual Machine Scale Set if the VM is part of one.
azure.vm.sku The SKU of the Azure Virtual Machine's operating system. For instance, for a VM running Windows Server 2019 Datacenter edition, this value would be "2019-Datacenter".
cloud.platform The cloud platform, which is always set to "azure_vm" in this context.
cloud.provider The cloud service provider, which is always set to "azure" in this context.
cloud.region The Azure region where the Virtual Machine is hosted, such as "East US", "West Europe", etc.
cloud.resource_id The Azure Resource Manager URI uniquely identifying the Azure Virtual Machine. It typically follows this format: "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/virtualMachines/{vmName}".
host.id A unique identifier for the VM host, for instance, "02aab8a4-74ef-476e-8182-f6d2ba4166a6".
host.name The name of the host machine.
host.type The size of the VM instance, for example, "Standard_D2s_v3".
os.type The type of operating system running on the VM, such as "Linux" or "Windows".
os.version The version of the operating system running on the VM.
service.instance.id An identifier for a specific instance of the service running on the Azure VM, for example, "02aab8a4-74ef-476e-8182-f6d2ba4166a6".

Azure Functions Resource Detector

Attribute Description
cloud.platform The cloud platform. Here, it's always "azure_functions".
cloud.provider The cloud service provider. In this context, it's always "azure".
cloud.region The Azure region where the Azure Function is hosted, e.g., "East US", "West Europe", etc.
faas.instance The specific instance of the Azure App Service, useful in a scaled-out configuration.
faas.name The name of the Azure App Service.
faas.version The version of the Azure Function being executed, e.g., "~4".
faas.max_memory The amount of memory available to the Azure Function expressed in MiB.

Useful links