Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
pyohannes committed May 27, 2024
1 parent 2674ac2 commit 2bee6b5
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions detectors/azure/vm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Azure VM Resource detector

The Azure VM resource detector supports detecting attributes specific to Azure VMs.

## Usage

```golang
// Instantiate a new host resource detector
azureVmResourceDetector := vm.New()
resource, err := azureVmResourceDetector.Detect(context.Background())
```

## Supported attributes

According to semantic conventions for
[host](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/host.md),
[cloud](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/cloud.md),
and
[os](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/os.md)
attributes, each of the following attributes is added if it is available:

* `cloud.provider`
* `cloud.platform`
* `host.id`
* `host.name`
* `host.type`
* `os.type`
* `os.version`

0 comments on commit 2bee6b5

Please sign in to comment.