Telemetry instances are defined using a YAML manifest with the following structure:
with the following properties for the global section
| Name | Type | Description | Mandatory |
|---|---|---|---|
and the metrics section
| Name | Type | Description | Mandatory |
|---|---|---|---|
provider
string
The name of the Telemetry Provider
Yes
config
object
Provider-specific configuration in a key-value format (see specific provider documentation for details)
Yes
metrics
object
This section is used to specify the metrics to extract. This section is specific for each Telemetry Provider (see specific provider documentation for details)
No
name
string
Name of the metric in Akamas.
This metric must exists in at least one of the referred by the System associated with the Telemetry Provider Instance
Yes
datasourceName
string
Name of the metric (or extraction query) in the data source. The value of this parameter is specific to the data source.
Yes
labels
List of strings
List of labels. For the specific usage of this parameter, see the documentation of the specific Telemetry Provider
No
staticLabels
List of key-value pair
List of Key-Value pairs that are interpreted as a pair of labels name and value. This "static labels" are copied directly in each sample of the specific metric and sent to the Metric Service
No