Telemetry Instance template
Telemetry instances are defined using a YAML manifest with the following structure:
1
provider: Provider Name
2
name: My Telemetry Instance
3
config:
4
providerSpecificConfig1: "<value>"
5
providerSpecificConfig2: 123
6
metrics:
7
- name: metric_name
8
datasourceName: datsource_metric_name
9
defaultValue: 1.23
10
labels:
11
- label1
12
- label2
13
staticLabels:
14
staticLabel1: staticValue1
15
staticLabel2: staticValue2
with the following properties for the global section
Name | Type | Description | Mandatory |
---|---|---|---|
provider | string | The name of the Telemetry Provider | Yes |
name | string | Custom telemetry instance name | No |
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 |
and the metrics section
Name | Type | Description | Mandatory |
---|---|---|---|
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 |
defaultValue | double | Default value that, if specified, is used to create metrics in time-intervals where no other valid datapoint is available. | No |
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 |
Last modified 1mo ago