• StatsD
    • Params
    • Params.MetricInfo
    • Params.MetricInfo.Type

    StatsD

    The statsd adapter enables Istio to deliver metric data to aStatsD monitoring backend.

    This adapter supports the metric template.

    Params

    Configuration format for the statsd adapter.

    FieldTypeDescriptionRequired
    addressstringAddress of the statsd server, e.g. localhost:8125No
    prefixstringMetric prefix, do not specify for no prefixNo
    flushDurationDurationFlushDuration controls the maximum amount of time between sending metrics to the statsd collection server.Metrics are reported when either flush_bytes is full or flush_duration time has elapsed since the last report.No
    flushBytesint32Maximum UDP packet size to send; if not specified defaults to 512 bytes. If the statsd server is running on thesame (private) network 1432 bytes is recommended for better performance.No
    samplingRatefloatChance that any particular metric is sampled when incremented; can take the range [0, 1], defaults to 1 if unspecified.No
    metricsmap<string, MetricInfo>Map of metric name -> info. If a metric’s name is not in the map then the metric will not be exported to statsd.No

    Params.MetricInfo

    Describes how to represent this metric in statsd

    FieldTypeDescriptionRequired
    typeTypeNo
    nameTemplatestringThe template will be filled with values from the metric’s labels and the resulting string will be used asthe statsd metric name. This allows easier creation of statsd metrics like action_name-response_code.The template strings must conform to go’s text/template syntax. For the example of action_name-response_code,we use the template:{{.apiMethod}}-{{.responseCode}}If name_template is the empty string the Istio metric name will be used for statsd metric’s name.No

    Params.MetricInfo.Type

    The type of metric.

    NameDescription
    UNKNOWN
    COUNTER
    GAUGE
    DISTRIBUTION