-
Notifications
You must be signed in to change notification settings - Fork 539
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(azure-resource-detector) Add readme.
- Loading branch information
1 parent
4569746
commit 3d9eb98
Showing
1 changed file
with
64 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| # OpenTelemetry Resource Detector for Azure | ||
|
|
||
| [![NPM Published Version][npm-img]][npm-url] | ||
| [![Apache License][license-image]][license-image] | ||
|
|
||
| [component owners](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/.github/component_owners.yml): @JacksonWeber | ||
|
|
||
| Resource detector for Azure. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| npm install --save @opentelemetry/resource-detector-azure | ||
| ``` | ||
|
|
||
| ## Usage | ||
| ```typescript | ||
| import { detectResources } from '@opentelemetry/resources'; | ||
| import { azureAppServiceDetector } from '@opentelemetry/resource-detecotr-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". | | ||
|
|
||
| ## Useful links | ||
|
|
||
| - For more information on OpenTelemetry, visit: <https://opentelemetry.io/> | ||
| - For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js> | ||
| - For help or feedback on this project, join us in [GitHub Discussions][discussions-url] |