Metric

The metric template is designed to let you describe runtime metric to dispatch to monitoring backends.

Example config:

apiVersion: "config.istio.io/v1alpha2"
kind: metric
metadata:
  name: requestsize
  namespace: istio-system
spec:
  value: request.size | 0
  dimensions:
    source_service: source.service | "unknown"
    source_version: source.labels["version"] | "unknown"
    destination_service: destination.service | "unknown"
    destination_version: destination.labels["version"] | "unknown"
    response_code: response.code | 200
  monitored_resource_type: '"UNSPECIFIED"'

Template

The metric template represents a single piece of data to report.

When writing the configuration, the value for the fields associated with this template can either be a literal or an expression. Please note that if the datatype of a field is not istio.mixer.adapter.model.v1beta1.Value, then the expression’s inferred type must match the datatype of the field.

FieldTypeDescription
valueistio.mixer.adapter.model.v1beta1.Value

The value being reported.

dimensionsmap<string, istio.mixer.adapter.model.v1beta1.Value>

The unique identity of the particular metric to report.

monitoredResourceTypestring

Optional. An expression to compute the type of the monitored resource this metric is being reported on. If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise these fields will be ignored by the adapter.

monitoredResourceDimensionsmap<string, istio.mixer.adapter.model.v1beta1.Value>

Optional. A set of expressions that will form the dimensions of the monitored resource this metric is being reported on. If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise these fields will be ignored by the adapter.

istio.mixer.adapter.model.v1beta1.Value

Value is used inside templates for fields that have dynamic types. The actual datatype of the field depends on the datatype of the expression used in the operator configuration.

FieldTypeDescription
stringValuestring (oneof)

Used for values of type STRING

int64Valueint64 (oneof)

Used for values of type INT64

doubleValuedouble (oneof)

Used for values of type DOUBLE

boolValuebool (oneof)

Used for values of type BOOL

ipAddressValueistio.mixer.adapter.model.v1beta1.IPAddress (oneof)

Used for values of type IPAddress

timestampValueistio.mixer.adapter.model.v1beta1.TimeStamp (oneof)

Used for values of type TIMESTAMP

durationValueistio.mixer.adapter.model.v1beta1.Duration (oneof)

Used for values of type DURATION

emailAddressValueistio.mixer.adapter.model.v1beta1.EmailAddress (oneof)

Used for values of type EmailAddress

dnsNameValueistio.mixer.adapter.model.v1beta1.DNSName (oneof)

Used for values of type DNSName

uriValueistio.mixer.adapter.model.v1beta1.Uri (oneof)

Used for values of type Uri