mirror of https://github.com/istio/istio.io.git
91 lines
3.4 KiB
HTML
91 lines
3.4 KiB
HTML
---
|
|
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/istio' REPO
|
|
source_repo: https://github.com/istio/istio
|
|
title: Metric
|
|
description: A template that represents a single runtime metric.
|
|
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/metric.html
|
|
layout: protoc-gen-docs
|
|
generator: protoc-gen-docs
|
|
aliases:
|
|
- /docs/reference/config/template/metric.html
|
|
number_of_entries: 1
|
|
---
|
|
<p>The <code>metric</code> template is designed to let you describe runtime metric to dispatch to
|
|
monitoring backends.</p>
|
|
|
|
<p>Example config:</p>
|
|
|
|
<pre><code class="language-yaml">apiVersion: "config.istio.io/v1alpha2"
|
|
kind: instance
|
|
metadata:
|
|
name: requestsize
|
|
namespace: istio-system
|
|
spec:
|
|
compiledTemplate: metric
|
|
params:
|
|
value: request.size | 0
|
|
dimensions:
|
|
source_version: source.labels["version"] | "unknown"
|
|
destination_service: destination.service.host | "unknown"
|
|
destination_version: destination.labels["version"] | "unknown"
|
|
response_code: response.code | 200
|
|
monitored_resource_type: '"UNSPECIFIED"'
|
|
</code></pre>
|
|
|
|
<h2 id="Template">Template</h2>
|
|
<section>
|
|
<p>The <code>metric</code> template represents a single piece of data to report.</p>
|
|
|
|
<p>When writing the configuration, the value for the fields associated with this template can either be a
|
|
literal or an <a href="/docs/reference//config/policy-and-telemetry/expression-language/">expression</a>. Please note that if the datatype of a field is not istio.policy.v1beta1.Value,
|
|
then the expression’s <a href="/docs/reference//config/policy-and-telemetry/expression-language/#type-checking">inferred type</a> must match the datatype of the field.</p>
|
|
|
|
<table class="message-fields">
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr id="Template-value">
|
|
<td><code>value</code></td>
|
|
<td><code><a href="/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">istio.policy.v1beta1.Value</a></code></td>
|
|
<td>
|
|
<p>The value being reported.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Template-dimensions">
|
|
<td><code>dimensions</code></td>
|
|
<td><code>map<string, <a href="/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">istio.policy.v1beta1.Value</a>></code></td>
|
|
<td>
|
|
<p>The unique identity of the particular metric to report.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Template-monitored_resource_type">
|
|
<td><code>monitoredResourceType</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>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.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Template-monitored_resource_dimensions">
|
|
<td><code>monitoredResourceDimensions</code></td>
|
|
<td><code>map<string, <a href="/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">istio.policy.v1beta1.Value</a>></code></td>
|
|
<td>
|
|
<p>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.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|