Skip to content

Commit

Permalink
Semantic conventions for up metric on Resources. open-telemetry#1078
Browse files Browse the repository at this point in the history
  • Loading branch information
cwildman committed Oct 16, 2020
1 parent 99f2ab8 commit 5b81426
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions specification/metrics/semantic_conventions/resource-metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Semantic conventions for Resource metrics

This document describes metrics created about [Resources](../../resource/sdk.md), the entities
producing telemetry in a system.

**Disclaimer:** These are initial Resource metric instruments and labels, more may be added
in the future.

## Labels

The current Resource metrics do not have any explicit labels. They SHOULD inherit the [attributes
of the encapsulating](../../resource/semantic_conventions/README.md) Resource when being exported.

## Metric Instruments

The following metric instruments SHOULD be synthesized every time a Resource produces some
telemetry.

| Name | Instrument | Units | Description |
|----------------------|---------------|--------------|-------------|
| `resource.up` | ValueRecorder | yes/no | A value of `1` indicates the Resource is healthy, `0` if the Resource is unhealthy. |

0 comments on commit 5b81426

Please sign in to comment.