mirror of https://github.com/istio/istio.io.git
230 lines
5.3 KiB
HTML
230 lines
5.3 KiB
HTML
---
|
|
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/proxy' REPO
|
|
source_repo: https://github.com/istio/proxy
|
|
title: Stats Config
|
|
description: Configuration for Stats Filter.
|
|
location: https://istio.io/docs/reference/config/proxy_extensions/stats.html
|
|
layout: protoc-gen-docs
|
|
generator: protoc-gen-docs
|
|
weight: 20
|
|
number_of_entries: 4
|
|
---
|
|
<h2 id="MetricConfig">MetricConfig</h2>
|
|
<section>
|
|
<p>Metric instance configuration overrides.
|
|
The metric value and the metric type are optional and permit changing the
|
|
reported value for an existing metric.
|
|
The standard metrics are optimized and reported through a “fast-path”.
|
|
The customizations allow full configurability, at the cost of a “slower”
|
|
path.</p>
|
|
|
|
<table class="message-fields">
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr id="MetricConfig-dimensions">
|
|
<td><code>dimensions</code></td>
|
|
<td><code>map<string, string></code></td>
|
|
<td>
|
|
<p>(Optional) Collection of tag names and tag expressions to include in the
|
|
metric. Conflicts are resolved by the tag name by overriding previously
|
|
supplied values.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="MetricConfig-name">
|
|
<td><code>name</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>(Optional) Metric name to restrict the override to a metric. If not
|
|
specified, applies to all.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="MetricConfig-tags_to_remove">
|
|
<td><code>tagsToRemove</code></td>
|
|
<td><code>string[]</code></td>
|
|
<td>
|
|
<p>(Optional) A list of tags to remove.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="MetricConfig-match">
|
|
<td><code>match</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>NOT IMPLEMENTED. (Optional) Conditional enabling the override.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<h2 id="MetricDefinition">MetricDefinition</h2>
|
|
<section>
|
|
<table class="message-fields">
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr id="MetricDefinition-name">
|
|
<td><code>name</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Metric name.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="MetricDefinition-value">
|
|
<td><code>value</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Metric value expression.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="MetricDefinition-type">
|
|
<td><code>type</code></td>
|
|
<td><code><a href="#MetricType">MetricType</a></code></td>
|
|
<td>
|
|
<p>NOT IMPLEMENTED (Optional) Metric type.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<h2 id="MetricType">MetricType</h2>
|
|
<section>
|
|
<table class="enum-values">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr id="MetricType-COUNTER">
|
|
<td><code>COUNTER</code></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr id="MetricType-GAUGE">
|
|
<td><code>GAUGE</code></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr id="MetricType-HISTOGRAM">
|
|
<td><code>HISTOGRAM</code></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<h2 id="PluginConfig">PluginConfig</h2>
|
|
<section>
|
|
<table class="message-fields">
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr id="PluginConfig-debug">
|
|
<td><code>debug</code></td>
|
|
<td><code>bool</code></td>
|
|
<td>
|
|
<p>next id: 7
|
|
The following settings should be rarely used.
|
|
Enable debug for this filter.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="PluginConfig-max_peer_cache_size">
|
|
<td><code>maxPeerCacheSize</code></td>
|
|
<td><code>int32</code></td>
|
|
<td>
|
|
<p>maximum size of the peer metadata cache.
|
|
A long lived proxy that connects with many transient peers can build up a
|
|
large cache. To turn off the cache, set this field to a negative value.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="PluginConfig-stat_prefix">
|
|
<td><code>statPrefix</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>prefix to add to stats emitted by the plugin.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="PluginConfig-field_separator">
|
|
<td><code>fieldSeparator</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Stats api squashes dimensions in a single string.
|
|
The squashed string is parsed at prometheus scrape time to recover
|
|
dimensions. The following 2 fields set the field and value separators {key:
|
|
value} –> key{value<em>separator}value{field</em>separator}</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="PluginConfig-value_separator">
|
|
<td><code>valueSeparator</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>default: “==”</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="PluginConfig-disable_host_header_fallback">
|
|
<td><code>disableHostHeaderFallback</code></td>
|
|
<td><code>bool</code></td>
|
|
<td>
|
|
<p>Optional: Disable using host header as a fallback if destination service is
|
|
not available from the controlplane. Disable the fallback if the host
|
|
header originates outsides the mesh, like at ingress.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="PluginConfig-tcp_reporting_duration">
|
|
<td><code>tcpReportingDuration</code></td>
|
|
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">google.protobuf.Duration</a></code></td>
|
|
<td>
|
|
<p>Optional. Allows configuration of the time between calls out to for TCP
|
|
metrics reporting. The default duration is <code>15s</code>.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="PluginConfig-metrics">
|
|
<td><code>metrics</code></td>
|
|
<td><code><a href="#MetricConfig">MetricConfig[]</a></code></td>
|
|
<td>
|
|
<p>Metric overrides.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="PluginConfig-definitions">
|
|
<td><code>definitions</code></td>
|
|
<td><code><a href="#MetricDefinition">MetricDefinition[]</a></code></td>
|
|
<td>
|
|
<p>Metric definitions.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|