Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(resource-detector-azure): update readme for azure resource detector #2057

Merged
merged 7 commits into from
Apr 9, 2024
Merged

docs(resource-detector-azure): update readme for azure resource detector #2057

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7759107
chore: update readme for azure resource detector
maryliag Mar 27, 2024
02ef6f0
remove notes column
maryliag Apr 9, 2024
e50cf61
Merge branch 'main' into doc-azure
trentm Apr 9, 2024
d56bf72
drop one missed 'Key: ...' column entry; align some table end column …
trentm Apr 9, 2024
064df05
Update detectors/node/opentelemetry-resource-detector-azure/README.md
maryliag Apr 9, 2024
b25b8d9
update doc to the semconv version this package is using
trentm Apr 9, 2024
a786f77
Merge branch 'main' into doc-azure
trentm Apr 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 31 additions & 31 deletions detectors/node/opentelemetry-resource-detector-azure/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,48 +27,48 @@ const tracerProvider = new NodeTracerProvider({ resource });

## Available Detectors

This package implements Semantic Convention [Version 1.19.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md).
trentm marked this conversation as resolved.
Show resolved Hide resolved

### App Service Resource Detector

| Attribute | Description |
| Resource Attribute | Description |
|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| azure.app.service.stamp | The specific "stamp" cluster within Azure where the App Service is running, e.g., "waws-prod-sn1-001". |
| azure.app.service.stamp | The specific "stamp" cluster within Azure where the App Service is running, e.g., "waws-prod-sn1-001". Value of Process Environment Variable `APP_SERVICE_ATTRIBUTE_ENV_VARS`. |
| 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. |
| cloud.region | The Azure region where the App Service is hosted, e.g., "East US", "West Europe", etc. Value of Process Environment Variable `REGION_NAME`. |
| 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}`. |
| deployment.environment | The deployment slot where the Azure App Service is running, such as "staging", "production", etc. Value of Process Environment Variable `WEBSITE_SLOT_NAME`. |
| host.id | The primary hostname for the app, excluding any custom hostnames. Value of Process Environment Variable `WEBSITE_HOSTNAME`. |
| service.instance.id | The specific instance of the Azure App Service, useful in a scaled-out configuration. Value of Process Environment Variable `WEBSITE_INSTANCE_ID`. |
| service.name | The name of the Azure App Service. Value of Process Environment Variable `WEBSITE_SITE_NAME`. |

### 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". |
| Resource Attribute | Description |
|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| azure.vm.scaleset.name | The name of the Virtual Machine Scale Set if the VM is part of one. Value from `vmScaleSetName` key on `/metadata/instance/compute` request. |
| 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". Value from `sku` key on `/metadata/instance/compute` request. |
| 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. Value from `location` key on `/metadata/instance/compute` request. |
| 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}`. Value from `resourceId` key on `/metadata/instance/compute` request.|
| host.id | A unique identifier for the VM host, for instance, "02aab8a4-74ef-476e-8182-f6d2ba4166a6". Value from `vmId` key on `/metadata/instance/compute` request. |
| host.name | The name of the host machine. Value from `name` key on `/metadata/instance/compute` request. |
| host.type | The size of the VM instance, for example, "Standard_D2s_v3". Value from `vmSize` key on `/metadata/instance/compute` request. |
| os.version | The version of the operating system running on the VM. Value from `version` key on `/metadata/instance/compute` request. |

### 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. |
| Resource 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. Value of Process Environment Variable `REGION_NAME`. |
| faas.instance | The specific instance of the Azure App Service, useful in a scaled-out configuration. Value from Process Environment Variable `WEBSITE_INSTANCE_ID`. |
| faas.max_memory | The amount of memory available to the Azure Function expressed in MiB. value from Process Environment Variable `WEBSITE_MEMORY_LIMIT_MB`. |
| faas.name | The name of the Azure App Service. Value from Process Environment Variable `WEBSITE_SITE_NAME`. |
| faas.version | The version of the Azure Function being executed, e.g., "~4". value from Process Environment Variable `FUNCTIONS_EXTENSION_VERSION`. |

## Useful links

Expand Down
Loading