Telemetry Instance template

Telemetry instances are defined using a YAML manifest with the following structure:

provider: Provider Name
name: My Telemetry
config:
  providerSpecificConfig1: "<value>"
  providerSpecificConfig2: 123
metrics:
- name: metric_name
  datasourceName: datsource_metric_name
  defaultValue: 1.23
  labels:
    - label1
    - label2
  staticLabels:
    staticLabel1: staticValue1
    staticLabel2: staticValue2

with the following properties for the global 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

name

string

Custom telemetry instance name

No

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

aggregation

String

No

extras

Object

Only the parameter mergeEntities can be defined to either true or false

No

Last updated