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.policy.v1beta1.Value, then the expression’s inferred type must match the datatype of the field.

FieldTypeDescription
valueistio.policy.v1beta1.Value

The value being reported.

dimensionsmap<string, istio.policy.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.policy.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.policy.v1beta1.Value

An instance field of type Value denotes that the expression for the field is of dynamic type and can evalaute to any ValueType enum values. For example, when authoring an instance configuration for a template that has a field data of type istio.policy.v1beta1.Value, both of the following expressions are valid data: source.ip | ip("0.0.0.0"), data: request.id | ""; the resulting type is either ValueType.IP_ADDRESS or ValueType.STRING for the two cases respectively.

Objects of type Value are also passed to the adapters during request-time. There is a 1:1 mapping between oneof fields in Value and enum values inside ValueType. Depending on the expression’s evaluated ValueType, the equivalent oneof field in Value is populated by Mixer and passed to the adapters.

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.policy.v1beta1.IPAddress (oneof)

Used for values of type IPAddress

timestampValueistio.policy.v1beta1.TimeStamp (oneof)

Used for values of type TIMESTAMP

durationValueistio.policy.v1beta1.Duration (oneof)

Used for values of type DURATION

emailAddressValueistio.policy.v1beta1.EmailAddress (oneof)

Used for values of type EmailAddress

dnsNameValueistio.policy.v1beta1.DNSName (oneof)

Used for values of type DNSName

uriValueistio.policy.v1beta1.Uri (oneof)

Used for values of type Uri