mirror of https://github.com/istio/istio.io.git
remove deleted docs in english (#10575)
* remove deleted docs in english * > fixx lint
This commit is contained in:
Kebe
GitHub
parent
f82e0f14b8
commit
1314887414
|
|
@ -29,7 +29,7 @@ Mixer 服务作为 Istio 和一套开放式基础设施之间的抽象层。Isti
|
|||
Mixer 本质上就是一个处理属性和路由的机器。代理将[属性](/zh/docs/reference/config/policy-and-telemetry/mixer-overview/#attributes)作为预检和遥测报告的一部分发送出来，并且转换为一系列对适配器的调用。运维人员提供了用于描述如何将传入的属性映射为适配器的配置。
|
||||
|
||||
{{< image width="60%"
|
||||
link="/zh/docs/reference/config/policy-and-telemetry/mixer-overview/machine.svg"
|
||||
link="/zh/blog/2017/adapter-model/machine.svg"
|
||||
caption="Attribute Machine"
|
||||
>}}
|
||||
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 52 KiB After Width: | Height: | Size: 52 KiB |
File diff suppressed because it is too large
Load Diff
|
|
@ -1,14 +0,0 @@
|
|||
---
|
||||
title: Mixer 策略和遥测
|
||||
description: 描述如何配置 Mixer 的策略和遥测功能。
|
||||
weight: 80
|
||||
aliases:
|
||||
- /zh/docs/reference/config/mixer/index.html
|
||||
---
|
||||
|
||||
{{< warning >}}
|
||||
Mixer 已弃用。Mixer 所提供的功能已迁移至 Envoy 代理中。
|
||||
在 Istio 中对 Mixer 的支持将截止到 Istio 1.7 发行版。
|
||||
|
||||
请参考 [Telemetry V2](/zh/docs/reference/config/telemetry)，它取代了 Mixer 遥测。
|
||||
{{</ warning>}}
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
title: 适配器
|
||||
description: Mixer 适配器能够让 Istio 连接各种基础设施后端以完成类似指标和日志这样的功能。
|
||||
weight: 40
|
||||
aliases:
|
||||
- /zh/docs/reference/config/mixer/adapters/index.html
|
||||
- /zh/docs/reference/config/adapters/
|
||||
---
|
||||
|
||||
{{< idea >}}
|
||||
要实现一个新的 Mixer 适配器，请参考[适配器开发者指南](https://github.com/istio/istio/wiki/Mixer-Compiled-In-Adapter-Dev-Guide)。
|
||||
{{< /idea >}}
|
||||
|
||||
## 模板
|
||||
|
||||
下表显示了由每个支持的适配器实现的[模板](/zh/docs/reference/config/policy-and-telemetry/templates)。
|
||||
|
||||
{{< adapter_table >}}
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
---
|
||||
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/apache/skywalking-data-collect-protocol' REPO
|
||||
source_repo: https://github.com/apache/skywalking-data-collect-protocol
|
||||
title: Apache SkyWalking
|
||||
description: Adapter to deliver metrics to Apache SkyWalking.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/apache-skywalking.html
|
||||
layout: partner-component
|
||||
generator: protoc-gen-docs
|
||||
provider: Apache SkyWalking
|
||||
contact_email: dev@skywalking.apache.org
|
||||
support_link:
|
||||
source_link: https://github.com/apache/skywalking
|
||||
latest_release_link: https://skywalking.apache.org/downloads/
|
||||
helm_chart_link:
|
||||
istio_versions: "1.0.3, 1.0.4, 1.1.0, 1.1.1"
|
||||
supported_templates: metric
|
||||
logo_link: https://github.com/apache/skywalking-website/raw/master/docs/.vuepress/public/assets/logo.svg
|
||||
number_of_entries: 1
|
||||
---
|
||||
|
||||
<!-- Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
contributor license agreements. See the NOTICE file distributed with
|
||||
this work for additional information regarding copyright ownership.
|
||||
The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
(the "License"); you may not use this file except in compliance with
|
||||
the License. You may obtain a copy of the License at
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License. -->
|
||||
|
||||
<p>The SkyWalking adapter uses the <code>Istio bypass</code> adapter to collect metrics and make them available to
|
||||
<a href="https://skywalking.apache.org/">Apache SkyWalking</a>. SkyWalking provides a topology map and metrics graph
|
||||
to visualize the whole mesh.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
|
||||
|
||||
<p>Follow the <a href="https://github.com/apache/skywalking/blob/master/docs/README.md">official Apache SkyWalking documentation</a>
|
||||
and <a href="https://github.com/apache/skywalking-kubernetes">SkyWalking k8s documentation</a> for details on configuring SkyWalking and the Istio bypass adapter.</p>
|
||||
|
|
@ -1,283 +0,0 @@
|
|||
---
|
||||
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/apigee/istio-mixer-adapter' REPO
|
||||
source_repo: https://github.com/apigee/istio-mixer-adapter
|
||||
title: Apigee
|
||||
description: Adapter for Apigee's distributed policy checks and analytics.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/apigee.html
|
||||
layout: partner-component
|
||||
generator: protoc-gen-docs
|
||||
provider: Apigee
|
||||
contact_email:
|
||||
support_link: https://apigee.com/about/support/portal
|
||||
source_link: https://github.com/apigee/istio-mixer-adapter
|
||||
latest_release_link: https://github.com/apigee/istio-mixer-adapter/releases
|
||||
helm_chart_link:
|
||||
istio_versions: "1.1.x, 1.2.x, 1.3.x"
|
||||
supported_templates: authorization, analytics
|
||||
number_of_entries: 4
|
||||
---
|
||||
<p>The Apigee Mixer adapter provides Apigee’s distributed authentication and quota policy checks
|
||||
as well as the ingestion of Istio telemetry for analysis and reporting.</p>
|
||||
|
||||
<p>Important: The adapter is provided in an enhanced Mixer image. The default Mixer image must be replaced and the
|
||||
proper CRDs must be applied in order to use these features. Complete Apigee documentation on the concepts and usage
|
||||
of this adapter is available on the <a href="https://docs.apigee.com/api-platform/istio-adapter/concepts">Apigee Adapter for Istio</a>
|
||||
site. For more information and product support, please <a href="https://apigee.com/about/support/portal">contact Apigee support</a>.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/authorization/">authorization template</a>
|
||||
and Apigee’s <a href="/zh/docs/reference/config/policy-and-telemetry/templates/analytics/">analytics template</a>.</p>
|
||||
|
||||
<p>Example config:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: config.istio.io/v1alpha2
|
||||
kind: apigee
|
||||
metadata:
|
||||
name: apigee-handler
|
||||
namespace: istio-system
|
||||
spec:
|
||||
apigee_base: https://istioservices.apigee.net/edgemicro
|
||||
customer_base: https://myorg-test.apigee.net/istio-auth
|
||||
org_name: myorg
|
||||
env_name: test
|
||||
key: mykey
|
||||
secret: mysecret
|
||||
temp_dir: "/tmp/apigee-istio"
|
||||
client_timeout: 30s
|
||||
allowUnverifiedSSLCert: false
|
||||
products:
|
||||
refresh_rate: 2m
|
||||
analytics:
|
||||
legacy_endpoint: false
|
||||
file_limit: 1024
|
||||
auth:
|
||||
api_key_claim:
|
||||
api_key_cache_duration: 30m
|
||||
</code></pre>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>The Configuration for the Apigee adapter provides information on how the adapter should contact
|
||||
the Apigee proxies and how it should operate. Running the <code>apigee-istio provision</code> CLI command
|
||||
will ensure that all proxies are installed into your Apigee environment and generate this file
|
||||
with all required settings for you.
|
||||
For additional information on this adapter or support please contact anchor-prega-support@google.com.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-apigee_base">
|
||||
<td><code>apigeeBase</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Apigee Base is the URI for a shared proxy on Apigee.
|
||||
Required.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-customer_base">
|
||||
<td><code>customerBase</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Customer Base is the URI for an organization-specific proxy on Apigee.
|
||||
Required.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-org_name">
|
||||
<td><code>orgName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Org Name is the name of the organization on Apigee.
|
||||
Required.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-env_name">
|
||||
<td><code>envName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Env Name is the name of the environment on Apigee.
|
||||
Required.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-key">
|
||||
<td><code>key</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Key is used to authenticate to the Apigee proxy endpoints, generated during provisioning.
|
||||
Required.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-secret">
|
||||
<td><code>secret</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Secret is used to authenticate to the Apigee proxy endpoints, generated during provisioning.
|
||||
Required.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-temp_dir">
|
||||
<td><code>tempDir</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The local directory to be used by the adapter for temporary files.
|
||||
Optional. Default: “/tmp/apigee-istio”.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-client_timeout">
|
||||
<td><code>clientTimeout</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>The timeout to be used for adapter requests to Apigee servers.
|
||||
Optional. Default: “30s” (30 seconds).</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-allowUnverifiedSSLCert">
|
||||
<td><code>allowUnverifiedSSLCert</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Set to true to allow an unknown server SSL Certificate (eg. self-signed)
|
||||
Optional. Default: false.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-products">
|
||||
<td><code>products</code></td>
|
||||
<td><code><a href="#Params-product_options">Params.product_options</a></code></td>
|
||||
<td>
|
||||
<p>Options specific to to products handling.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-analytics">
|
||||
<td><code>analytics</code></td>
|
||||
<td><code><a href="#Params-analytics_options">Params.analytics_options</a></code></td>
|
||||
<td>
|
||||
<p>Options specific to to analytics handling.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-auth">
|
||||
<td><code>auth</code></td>
|
||||
<td><code><a href="#Params-auth_options">Params.auth_options</a></code></td>
|
||||
<td>
|
||||
<p>Options specific to to products handling.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-analytics_options">Params.analytics_options</h2>
|
||||
<section>
|
||||
<p>Options specific to to analytics handling.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-analytics_options-legacy_endpoint">
|
||||
<td><code>legacyEndpoint</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>If true, use legacy direct communication analytics protocol instead of buffering. Must be true for OPDK.
|
||||
Optional. Default: false.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-analytics_options-file_limit">
|
||||
<td><code>fileLimit</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>The number of analytics files that can be buffered before oldest files are dropped.
|
||||
Optional. Default: 1024.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-analytics_options-send_channel_size">
|
||||
<td><code>sendChannelSize</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>The size of the channel used to buffer record sends in memory.
|
||||
Optional. Default: 10.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-auth_options">Params.auth_options</h2>
|
||||
<section>
|
||||
<p>Options specific to to auth handling.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-auth_options-api_key_cache_duration">
|
||||
<td><code>apiKeyCacheDuration</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>The length of time API Keys are valid in the cache.
|
||||
Optional. Default: “30m” (30 minutes).</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-auth_options-api_key_claim">
|
||||
<td><code>apiKeyClaim</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The name of a JWT claim from which to look for an api_key.
|
||||
Optional. Default: none.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-product_options">Params.product_options</h2>
|
||||
<section>
|
||||
<p>Options specific to to products handling.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-product_options-refresh_rate">
|
||||
<td><code>refreshRate</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>The rate at which the list of products is refreshed from Apigee.
|
||||
Optional. Default: “2m” (2 minutes).</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/ibm-cloud-security/app-identity-and-access-adapter' REPO
|
||||
source_repo: https://github.com/ibm-cloud-security/app-identity-and-access-adapter
|
||||
title: App Identity and Access
|
||||
description: Adapter to enforce authentication and authorization policies for web apps and APIs.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/app-identity-access-adapter.html
|
||||
layout: partner-component
|
||||
generator: protoc-gen-docs
|
||||
provider: IBM Cloud
|
||||
contact_email: antona@us.ibm.com
|
||||
source_link: https://github.com/ibm-cloud-security/app-identity-and-access-adapter
|
||||
latest_release_link: https://github.com/ibm-cloud-security/app-identity-and-access-adapter
|
||||
helm_chart_link:
|
||||
istio_versions: "1.1.x, 1.2.x"
|
||||
number_of_entries: 0
|
||||
---
|
||||
<p>With the App Identity and Access Istio adapter, you can use any OIDC compliant identity provider, such as <a href="https://www.ibm.com/cloud/app-id">IBM Cloud App ID</a>, to
|
||||
protect your APIs and containerized web apps. Without any change to your code or the need to redeploy
|
||||
your app, you can enforce authentication and authorization policies in all of your environments.
|
||||
To get started with sample configurations see the <a href="https://cloud.ibm.com/docs/services/appid?topic=appid-istio-adapter">docs</a>.</p>
|
||||
|
|
@ -1,136 +0,0 @@
|
|||
---
|
||||
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: Circonus
|
||||
description: Adapter for circonus.com's monitoring solution.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/circonus.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: metric
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/circonus.html
|
||||
number_of_entries: 3
|
||||
---
|
||||
<p>The <code>circonus</code> adapter enables Istio to deliver metric data to the
|
||||
<a href="https://www.circonus.com">Circonus</a> monitoring backend.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the Circonus adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-submission_url">
|
||||
<td><code>submissionUrl</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Circonus SubmissionURL to HTTPTrap check</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-submission_interval">
|
||||
<td><code>submissionInterval</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-metrics">
|
||||
<td><code>metrics</code></td>
|
||||
<td><code><a href="#Params-MetricInfo">MetricInfo[]</a></code></td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo">Params.MetricInfo</h2>
|
||||
<section>
|
||||
<p>Describes how to represent a metric</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-name">
|
||||
<td><code>name</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>name</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-type">
|
||||
<td><code>type</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-Type">Type</a></code></td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-Type">Params.MetricInfo.Type</h2>
|
||||
<section>
|
||||
<p>The type of metric.</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-Type-UNKNOWN">
|
||||
<td><code>UNKNOWN</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-COUNTER">
|
||||
<td><code>COUNTER</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-GAUGE">
|
||||
<td><code>GAUGE</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-DISTRIBUTION">
|
||||
<td><code>DISTRIBUTION</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,85 +0,0 @@
|
|||
---
|
||||
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/osswangxining/alicloud-istio-grpcadapter' REPO
|
||||
source_repo: https://github.com/osswangxining/alicloud-istio-grpcadapter
|
||||
title: CloudMonitor
|
||||
description: Adapter for cloudmonitor metrics.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/cloudmonitor.html
|
||||
layout: partner-component
|
||||
generator: protoc-gen-docs
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/cloudmonitor.html
|
||||
number_of_entries: 2
|
||||
---
|
||||
<p>The CloudMonitor adapter enables Istio to deliver metrics to
|
||||
<a href="https://cloudmonitor.console.aliyun.com/">AliCloud CloudMonitor</a>.</p>
|
||||
|
||||
<p>To push metrics to CloudMonitor using this adapter you must provide AliCloud credentials the AliCloud SDK.
|
||||
(see <a href="https://github.com/aliyun/alibaba-cloud-sdk-go">AliCloud official SDK</a>).</p>
|
||||
|
||||
<p>The handler configuration must contain the same metrics as the instance configuration.
|
||||
The metrics specified in both instance and handler configurations will be sent to CloudMonitor.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration for the <code>cloudmonitor</code> adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-regiond_id">
|
||||
<td><code>regiondId</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The Id of one region where the AliCloud Cloud Monitor service instance is located</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-access_key_id">
|
||||
<td><code>accessKeyId</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The access key Id of AliCloud access account</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-access_key_secret">
|
||||
<td><code>accessKeySecret</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The access key secret of AliCloud access account</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-group_id">
|
||||
<td><code>groupId</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>The Id of application group within AliCloud Cloud Monitor service instance</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-metric_info">
|
||||
<td><code>metricInfo</code></td>
|
||||
<td><code>map<string, <a href="#Params-MetricList">Params.MetricList</a>></code></td>
|
||||
<td>
|
||||
<p>A map of Istio metric name to CloudMonitor metric info.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricList">Params.MetricList</h2>
|
||||
<section>
|
||||
<p>CloudMonitor metric format.
|
||||
<a href="https://github.com/aliyun/alibaba-cloud-sdk-go/blob/master/services/cms/put_custom_metric.go">CloudMonitor Custom Metric Request</a></p>
|
||||
|
||||
</section>
|
||||
|
|
@ -1,303 +0,0 @@
|
|||
---
|
||||
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: CloudWatch
|
||||
description: Adapter for cloudwatch metrics.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/cloudwatch.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: logentry
|
||||
supported_templates: metric
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/cloudwatch.html
|
||||
number_of_entries: 4
|
||||
---
|
||||
<p>The CloudWatch adapter enables Istio to deliver metrics to
|
||||
<a href="https://aws.amazon.com/cloudwatch/">Amazon CloudWatch</a>.
|
||||
<a href="https://aws.amazon.com/cloudwatch/">Amazon CloudWatch</a> and logs to
|
||||
<a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html">Amazon CloudWatchLogs</a>.</p>
|
||||
|
||||
<p>To push metrics and logs to CloudWatch using this adapter you must provide AWS credentials to the AWS SDK.
|
||||
(see <a href="https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-credentials.html">AWS docs</a>).</p>
|
||||
|
||||
<p>The handler configuration must contain the same metrics as the instance configuration.
|
||||
The metrics specified in both instance and handler configurations will be sent to CloudWatch.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration for the <code>cloudwatch</code> adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-namespace">
|
||||
<td><code>namespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>CloudWatch metric namespace.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-metric_info">
|
||||
<td><code>metricInfo</code></td>
|
||||
<td><code>map<string, <a href="#Params-MetricDatum">MetricDatum</a>></code></td>
|
||||
<td>
|
||||
<p>A map of Istio metric name to CloudWatch metric info.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-log_group_name">
|
||||
<td><code>logGroupName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The name of the log group in cloudwatchlogs.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-log_stream_name">
|
||||
<td><code>logStreamName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The name of the log stream in cloudwatchlogs.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-logs">
|
||||
<td><code>logs</code></td>
|
||||
<td><code>map<string, <a href="#Params-LogInfo">LogInfo</a>></code></td>
|
||||
<td>
|
||||
<p>A map of Istio logentry name to CloudWatch logentry info.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-LogInfo">Params.LogInfo</h2>
|
||||
<section>
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-LogInfo-payload_template">
|
||||
<td><code>payloadTemplate</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>A golang text/template template that will be executed to construct the payload for this log entry.
|
||||
It will be given the full set of variables for the log to use to construct its result.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricDatum">Params.MetricDatum</h2>
|
||||
<section>
|
||||
<p>CloudWatch metric format.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricDatum-unit">
|
||||
<td><code>unit</code></td>
|
||||
<td><code><a href="#Params-MetricDatum-Unit">Unit</a></code></td>
|
||||
<td>
|
||||
<p>The unit of the metric. Must be valid cloudwatch unit value.
|
||||
<a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html">CloudWatch docs</a></p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricDatum-Unit">Params.MetricDatum.Unit</h2>
|
||||
<section>
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricDatum-Unit-None">
|
||||
<td><code>None</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Seconds">
|
||||
<td><code>Seconds</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Microseconds">
|
||||
<td><code>Microseconds</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Milliseconds">
|
||||
<td><code>Milliseconds</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Count">
|
||||
<td><code>Count</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Bytes">
|
||||
<td><code>Bytes</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Kilobytes">
|
||||
<td><code>Kilobytes</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Megabytes">
|
||||
<td><code>Megabytes</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Gigabytes">
|
||||
<td><code>Gigabytes</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Terabytes">
|
||||
<td><code>Terabytes</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Bits">
|
||||
<td><code>Bits</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Kilobits">
|
||||
<td><code>Kilobits</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Megabits">
|
||||
<td><code>Megabits</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Gigabits">
|
||||
<td><code>Gigabits</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Terabits">
|
||||
<td><code>Terabits</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Percent">
|
||||
<td><code>Percent</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Bytes_Second">
|
||||
<td><code>Bytes_Second</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Kilobytes_Second">
|
||||
<td><code>Kilobytes_Second</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Megabytes_Second">
|
||||
<td><code>Megabytes_Second</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Gigabytes_Second">
|
||||
<td><code>Gigabytes_Second</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Terabytes_Second">
|
||||
<td><code>Terabytes_Second</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Bits_Second">
|
||||
<td><code>Bits_Second</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Kilobits_Second">
|
||||
<td><code>Kilobits_Second</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Megabits_Second">
|
||||
<td><code>Megabits_Second</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Gigabits_Second">
|
||||
<td><code>Gigabits_Second</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Terabits_Second">
|
||||
<td><code>Terabits_Second</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricDatum-Unit-Count_Second">
|
||||
<td><code>Count_Second</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,204 +0,0 @@
|
|||
---
|
||||
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: Datadog
|
||||
description: Adapter to deliver metrics to a dogstatsd agent for delivery to DataDog.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/datadog.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: metric
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/datadog.html
|
||||
number_of_entries: 3
|
||||
---
|
||||
<p>The <code>dogstatsd</code> adapter is designed to deliver Istio metric instances to a
|
||||
listening <a href="https://www.datadoghq.com/">DataDog</a> agent.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration parameter for the DataDog adapter. These params control how Mixer telemetry is transformed and sent to a dogstatsd agent.</p>
|
||||
|
||||
<p>The adapter assumes that a dogstatsd agent is running as a sidecar or at some other endpoint that the Mixer can reach.
|
||||
Any dimension that is a part of the metric is converted to a tag automatically. The configuration of the DataDog agent/daemon is outside the scope of the adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-address">
|
||||
<td><code>address</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Address of the dogstatsd server.
|
||||
Default: localhost:8125</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-prefix">
|
||||
<td><code>prefix</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Prefix to prepend to all metrics handled by the adapter. Metric “bar” with prefix “foo.” becomes “foo.bar” in DataDog. In order to make sure the metrics get populated into Datadog properly and avoid any billing issues, it’s important to leave the metric prefix to its default value of ‘istio.’
|
||||
Default: “istio.”</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-buffer_length">
|
||||
<td><code>bufferLength</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Number of individual metrics to buffer before flushing metrics to the network. When buffered, metrics are flushed every 100ms or when the buffer is filled.
|
||||
When buffer is 0, metrics are not buffered.
|
||||
Default: 0</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-global_tags">
|
||||
<td><code>globalTags</code></td>
|
||||
<td><code>map<string, string></code></td>
|
||||
<td>
|
||||
<p>Tags to add to every metric. “global”: “tag” becomes “global:tag” in DataDog
|
||||
Default: []</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-sample_rate">
|
||||
<td><code>sampleRate</code></td>
|
||||
<td><code>double</code></td>
|
||||
<td>
|
||||
<p>Chance that any particular metric is sampled when emitted; can take the range [0, 1].
|
||||
Default: 1</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-metrics">
|
||||
<td><code>metrics</code></td>
|
||||
<td><code>map<string, <a href="#Params-MetricInfo">MetricInfo</a>></code></td>
|
||||
<td>
|
||||
<p>Map of a specific metric instance name -> info. If a metric’s instance name is not in the map then the metric will not be exported to DataDog.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo">Params.MetricInfo</h2>
|
||||
<section>
|
||||
<p>Describes how to represent this metric in DataDog</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-name">
|
||||
<td><code>name</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Name of the metric in DataDog</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-type">
|
||||
<td><code>type</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-Type">Type</a></code></td>
|
||||
<td>
|
||||
<p>The type of metric</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-tags">
|
||||
<td><code>tags</code></td>
|
||||
<td><code>map<string, string></code></td>
|
||||
<td>
|
||||
<p>Tags to add to the metric in addition to the dimensions. “tag”: “val” becomes “tag:val” in DataDog
|
||||
Default: []</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-Type">Params.MetricInfo.Type</h2>
|
||||
<section>
|
||||
<p>Describes the type of metric</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-Type-UNKNOWN_TYPE">
|
||||
<td><code>UNKNOWN_TYPE</code></td>
|
||||
<td>
|
||||
<p>Default Unknown Type</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-COUNTER">
|
||||
<td><code>COUNTER</code></td>
|
||||
<td>
|
||||
<p>Increments a DataDog counter</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-GAUGE">
|
||||
<td><code>GAUGE</code></td>
|
||||
<td>
|
||||
<p>Sets the new value of a DataDog gauge</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-DISTRIBUTION">
|
||||
<td><code>DISTRIBUTION</code></td>
|
||||
<td>
|
||||
<p>DISTRIBUTION is converted to a Timing Histogram for metrics with a time unit and a Histogram for all other units</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,181 +0,0 @@
|
|||
---
|
||||
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: Denier
|
||||
description: Adapter that always returns a precondition denial.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/denier.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: listentry,quota,checknothing
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/denier.html
|
||||
number_of_entries: 2
|
||||
---
|
||||
<p>The <code>denier</code> adapter is designed to always return a denial to precondition
|
||||
checks. You can specify the exact error to return for these denials.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/checknothing/">checknothing template</a>,
|
||||
the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/listentry/">listentry template</a>,
|
||||
and the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/quota/">quota template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the Denier adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-status">
|
||||
<td><code>status</code></td>
|
||||
<td><code><a href="#google-rpc-Status">Status</a></code></td>
|
||||
<td>
|
||||
<p>The error to return when denying a request.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-valid_duration">
|
||||
<td><code>validDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>The duration for which the denial is valid.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-valid_use_count">
|
||||
<td><code>validUseCount</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>The number of times the denial may be used.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="google-rpc-Status">google.rpc.Status</h2>
|
||||
<section>
|
||||
<p>The <code>Status</code> type defines a logical error model that is suitable for
|
||||
different programming environments, including REST APIs and RPC APIs. It is
|
||||
used by <a href="https://github.com/grpc">gRPC</a>. The error model is designed to be:</p>
|
||||
|
||||
<ul>
|
||||
<li>Simple to use and understand for most users</li>
|
||||
<li>Flexible enough to meet unexpected needs</li>
|
||||
</ul>
|
||||
|
||||
<h3 id="overview">Overview</h3>
|
||||
|
||||
<p>The <code>Status</code> message contains three pieces of data: error code, error
|
||||
message, and error details. The error code should be an enum value of
|
||||
<em>google.rpc.Code</em>, but it may accept additional error codes
|
||||
if needed. The error message should be a developer-facing English message
|
||||
that helps developers <em>understand</em> and <em>resolve</em> the error. If a localized
|
||||
user-facing error message is needed, put the localized message in the error
|
||||
details or localize it in the client. The optional error details may contain
|
||||
arbitrary information about the error. There is a predefined set of error
|
||||
detail types in the package <code>google.rpc</code> that can be used for common error
|
||||
conditions.</p>
|
||||
|
||||
<h3 id="language-mapping">Language mapping</h3>
|
||||
|
||||
<p>The <code>Status</code> message is the logical representation of the error model, but it
|
||||
is not necessarily the actual wire format. When the <code>Status</code> message is
|
||||
exposed in different client libraries and different wire protocols, it can be
|
||||
mapped differently. For example, it will likely be mapped to some exceptions
|
||||
in Java, but more likely mapped to some error codes in C.</p>
|
||||
|
||||
<h3 id="other-uses">Other uses</h3>
|
||||
|
||||
<p>The error model and the <code>Status</code> message can be used in a variety of
|
||||
environments, either with or without APIs, to provide a
|
||||
consistent developer experience across different environments.</p>
|
||||
|
||||
<p>Example uses of this error model include:</p>
|
||||
|
||||
<ul>
|
||||
<li><p>Partial errors. If a service needs to return partial errors to the client,
|
||||
it may embed the <code>Status</code> in the normal response to indicate the partial
|
||||
errors.</p></li>
|
||||
|
||||
<li><p>Workflow errors. A typical workflow has multiple steps. Each step may
|
||||
have a <code>Status</code> message for error reporting.</p></li>
|
||||
|
||||
<li><p>Batch operations. If a client uses batch request and batch response, the
|
||||
<code>Status</code> message should be used directly inside batch response, one for
|
||||
each error sub-response.</p></li>
|
||||
|
||||
<li><p>Asynchronous operations. If an API call embeds asynchronous operation
|
||||
results in its response, the status of those operations should be
|
||||
represented directly using the <code>Status</code> message.</p></li>
|
||||
|
||||
<li><p>Logging. If some API errors are stored in logs, the message <code>Status</code> could
|
||||
be used directly after any stripping needed for security/privacy reasons.</p></li>
|
||||
</ul>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="google-rpc-Status-code">
|
||||
<td><code>code</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>The status code, which should be an enum value of
|
||||
<em>google.rpc.Code</em>.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="google-rpc-Status-message">
|
||||
<td><code>message</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>A developer-facing error message, which should be in English. Any
|
||||
user-facing error message should be localized and sent in the
|
||||
<a href="#google-rpc-Status-details">google.rpc.Status.details</a> field, or localized
|
||||
by the client.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="google-rpc-Status-details">
|
||||
<td><code>details</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#any">Any[]</a></code></td>
|
||||
<td>
|
||||
<p>A list of messages that carry the error details. There is a common set of
|
||||
message types for APIs to use.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,123 +0,0 @@
|
|||
---
|
||||
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: Fluentd
|
||||
description: Adapter that delivers logs to a Fluentd daemon.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/fluentd.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: logentry
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/fluentd.html
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>fluentd</code> adapter is designed to deliver Istio log entries to a
|
||||
listening <a href="https://www.fluentd.org">fluentd</a> daemon.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/logentry/">logentry template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration parameters for the fluentd adapter.</p>
|
||||
|
||||
<p>This adapter accepts logentry instance. It then routes
|
||||
those logentries to a listening fluentd daemon with minimal
|
||||
transformation. Fluentd uses a “tag” for all logs. The “Name” of
|
||||
the logentry is used as the “tag”, unless the logentry already has
|
||||
a variable “tag”.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-address">
|
||||
<td><code>address</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Address of listening fluentd daemon. Example: fluentd-server:24224
|
||||
Default value is localhost:24224</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-integer_duration">
|
||||
<td><code>integerDuration</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Convert attributes of type duration to integers of unit ms in
|
||||
logs. Default behaviour is a string representation including
|
||||
unit.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-instance_buffer_size">
|
||||
<td><code>instanceBufferSize</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>Controls the size of the queue of log entries awaiting processing by the
|
||||
data push goroutine. This impacts the overall size of the backlog of
|
||||
log entries that the handler will accept. If the handler falls behind and
|
||||
the number of outstanding instances exceeds this limit, the handler will
|
||||
begin to drop log entries.
|
||||
Defaults to 1024.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-max_batch_size_bytes">
|
||||
<td><code>maxBatchSizeBytes</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>Controls the number of data bytes that are encoded and buffered by the handler before
|
||||
they are pushed to the fluentd backend. This impacts the size and frequency of requests
|
||||
sent to the fluentd backend. Once the buffer exceeds this limit, the handler will attempt to push
|
||||
data to the backend.
|
||||
Defaults to 8,388,608 (8 MiB).</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-push_interval_duration">
|
||||
<td><code>pushIntervalDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Duration interval for pushing batched data to the fluentd backend. At least once every duration,
|
||||
the handler will attempt to push data.
|
||||
Default to 1m.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-push_timeout_duration">
|
||||
<td><code>pushTimeoutDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Timeout duration for pushing batched data to the fluentd backend. If a request takes longer than
|
||||
the configured timeout, the request will be cancelled and dropped.
|
||||
Default to 1m.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,101 +0,0 @@
|
|||
---
|
||||
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: Kubernetes Env
|
||||
description: Adapter that extracts information from a Kubernetes environment.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/kubernetesenv.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: kubernetes
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/kubernetesenv.html
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>kubernetesenv</code> adapter extracts information from a Kubernetes environment
|
||||
and produces attributes that can be used in downstream adapters.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/kubernetes/">kubernetes template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration parameters for the kubernetes adapter. These params
|
||||
control the manner in which the kubernetes adapter discovers and
|
||||
generates values related to pod information.</p>
|
||||
|
||||
<p>The adapter works by looking up pod information by UIDs (of the
|
||||
form: “kubernetes://pod.namespace”). It expects that the UIDs will be
|
||||
supplied in an input map for three distinct traffic classes (source,
|
||||
destination, and origin).</p>
|
||||
|
||||
<p>For all valid UIDs supplied, this adapter generates output
|
||||
values containing information about the related pods.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-kubeconfig_path">
|
||||
<td><code>kubeconfigPath</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>File path to discover <code>kubeconfig</code>. For in-cluster configuration,
|
||||
this should be left unset. For local configuration, this should
|
||||
be set to the path of a <code>kubeconfig</code> file that can be used to
|
||||
reach a kubernetes API server.</p>
|
||||
|
||||
<p>NOTE: The <code>kubernetesenv</code> adapter will use the value of the <code>KUBECONFIG</code> environment variable
|
||||
in the case where it is set (overriding any value configured
|
||||
through this proto).</p>
|
||||
|
||||
<p>Default: “” (unset)</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-cache_refresh_duration">
|
||||
<td><code>cacheRefreshDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Controls the resync period of the Kubernetes cluster info cache.
|
||||
The cache will watch for events and every so often completely resync.
|
||||
This controls how frequently the complete resync occurs.</p>
|
||||
|
||||
<p>Default: 5 minutes</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-cluster_registries_namespace">
|
||||
<td><code>clusterRegistriesNamespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Namespace of the secret created for multicluster support.</p>
|
||||
|
||||
<p>Details on multicluster and the Kubernetes secret required to
|
||||
access the remote cluster’s credentials can be found in
|
||||
<a href="/zh/docs/setup/install/multicluster/">multicluster install</a>.</p>
|
||||
|
||||
<p>NOTE: If <code>cluster_registries_namespace</code> is not set then the environment
|
||||
variable <code>POD_NAMESPACE</code> is checked/used. If <code>POD_NAMESPACE</code> is not
|
||||
set then <code>cluster_registries_namespace</code> defaults to “istio-system”.</p>
|
||||
|
||||
<p>Default: “istio-system”</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,174 +0,0 @@
|
|||
---
|
||||
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: List
|
||||
description: Adapter that performs whitelist or blacklist checks.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/list.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: listentry
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/list.html
|
||||
number_of_entries: 2
|
||||
---
|
||||
<p>The <code>list</code> adapter makes it possible to perform simple whitelist or blacklist
|
||||
checks. You can configure the adapter with the list to check, or you can point
|
||||
it to a URL from where the list should be fetched. Lists can be simple strings,
|
||||
IP addresses, or regex patterns.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/listentry/">listentry template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the <code>list</code> adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-provider_url">
|
||||
<td><code>providerUrl</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Where to find the list to check against. This may be omitted for a completely local list.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-refresh_interval">
|
||||
<td><code>refreshInterval</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Determines how often the provider is polled for
|
||||
an updated list</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-ttl">
|
||||
<td><code>ttl</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Indicates how long to keep a list before discarding it.
|
||||
Typically, the TTL value should be set to noticeably longer (> 2x) than the
|
||||
refresh interval to ensure continued operation in the face of transient
|
||||
server outages.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-caching_interval">
|
||||
<td><code>cachingInterval</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Indicates the amount of time a caller of this adapter can cache an answer
|
||||
before it should ask the adapter again.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-caching_use_count">
|
||||
<td><code>cachingUseCount</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Indicates the number of times a caller of this adapter can use a cached answer
|
||||
before it should ask the adapter again.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-overrides">
|
||||
<td><code>overrides</code></td>
|
||||
<td><code>string[]</code></td>
|
||||
<td>
|
||||
<p>List entries that are consulted first, before the list from the server</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-entry_type">
|
||||
<td><code>entryType</code></td>
|
||||
<td><code><a href="#Params-ListEntryType">ListEntryType</a></code></td>
|
||||
<td>
|
||||
<p>Determines the kind of list entry and overrides.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-blacklist">
|
||||
<td><code>blacklist</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Whether the list operates as a blacklist or a whitelist.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-ListEntryType">Params.ListEntryType</h2>
|
||||
<section>
|
||||
<p>Determines the type of list that the adapter is consulting.</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-ListEntryType-STRINGS">
|
||||
<td><code>STRINGS</code></td>
|
||||
<td>
|
||||
<p>List entries are treated as plain strings.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-ListEntryType-CASE_INSENSITIVE_STRINGS">
|
||||
<td><code>CASE_INSENSITIVE_STRINGS</code></td>
|
||||
<td>
|
||||
<p>List entries are treated as case-insensitive strings.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-ListEntryType-IP_ADDRESSES">
|
||||
<td><code>IP_ADDRESSES</code></td>
|
||||
<td>
|
||||
<p>List entries are treated as IP addresses and ranges.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-ListEntryType-REGEX">
|
||||
<td><code>REGEX</code></td>
|
||||
<td>
|
||||
<p>List entries are treated as re2 regexp. See <a href="https://github.com/google/re2/wiki/Syntax">here</a> for the supported syntax.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,180 +0,0 @@
|
|||
---
|
||||
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: Memory quota
|
||||
description: Adapter for a simple in-memory quota management system.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/memquota.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: quota
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/memquota.html
|
||||
number_of_entries: 3
|
||||
---
|
||||
<p>The <code>memquota</code> adapter can be used to support Istio’s quota management
|
||||
system. Although functional, this adapter is not intended for production
|
||||
use and is suited for local testing only. The reason for this limitation
|
||||
is that this adapter can only be used in meshes where there is a single
|
||||
instance of Mixer running for the whole mesh (i.e. non-HA configuration)
|
||||
and if that single instance crashes, all outstanding quota values will
|
||||
be lost.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/quota/">quota template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the <code>memquota</code> adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-quotas">
|
||||
<td><code>quotas</code></td>
|
||||
<td><code><a href="#Params-Quota">Quota[]</a></code></td>
|
||||
<td>
|
||||
<p>The set of known quotas.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-min_deduplication_duration">
|
||||
<td><code>minDeduplicationDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Minimum number of seconds that deduplication is possible for a given operation.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-Override">Params.Override</h2>
|
||||
<section>
|
||||
<p>Defines an override value for a quota. If no override matches
|
||||
a particular quota request, the default for the quota is used.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-Override-dimensions">
|
||||
<td><code>dimensions</code></td>
|
||||
<td><code>map<string, string></code></td>
|
||||
<td>
|
||||
<p>The specific dimensions for which this override applies.
|
||||
String representation of instance dimensions is used to check against configured dimensions.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Override-max_amount">
|
||||
<td><code>maxAmount</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>The upper limit for this quota.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Override-valid_duration">
|
||||
<td><code>validDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>The amount of time allocated quota remains valid before it is
|
||||
automatically released. This is only meaningful for rate limit
|
||||
quotas, otherwise the value must be zero.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-Quota">Params.Quota</h2>
|
||||
<section>
|
||||
<p>Defines a quota’s limit and duration.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-Quota-name">
|
||||
<td><code>name</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The name of the quota</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Quota-max_amount">
|
||||
<td><code>maxAmount</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>The upper limit for this quota.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Quota-valid_duration">
|
||||
<td><code>validDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>The amount of time allocated quota remains valid before it is
|
||||
automatically released. This is only meaningful for rate limit
|
||||
quotas, otherwise the value must be zero.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Quota-overrides">
|
||||
<td><code>overrides</code></td>
|
||||
<td><code><a href="#Params-Override">Override[]</a></code></td>
|
||||
<td>
|
||||
<p>Overrides associated with this quota.
|
||||
The first matching override is applied.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,175 +0,0 @@
|
|||
---
|
||||
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/newrelic/newrelic-istio-adapter' REPO
|
||||
source_repo: https://github.com/newrelic/newrelic-istio-adapter
|
||||
title: New Relic
|
||||
description: An Istio Mixer adapter to send telemetry data to New Relic.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/newrelic.html
|
||||
layout: partner-component
|
||||
generator: protoc-gen-docs
|
||||
provider: New Relic, Inc.
|
||||
source_link: https://github.com/newrelic/newrelic-istio-adapter
|
||||
latest_release_link: https://github.com/newrelic/newrelic-istio-adapter/releases
|
||||
supported_templates: metric, tracespan
|
||||
number_of_entries: 3
|
||||
---
|
||||
<p>An Istio Mixer adapter to send telemetry data to New Relic.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the <code>newrelic</code> adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-namespace">
|
||||
<td><code>namespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Optional. The namespace is used as a prefix for metric names in New Relic.
|
||||
An example: for a metric named <code>requestSize</code> with a namespace of <code>istio</code>,
|
||||
the full metric name in New Relic becomes <code>istio.requestSize</code>.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-metrics">
|
||||
<td><code>metrics</code></td>
|
||||
<td><code>map<string, <a href="#Params-MetricInfo">Params.MetricInfo</a>></code></td>
|
||||
<td>
|
||||
<p>Map of Istio metric instance names and the corresponding New Relic
|
||||
MetricInfo specification. This identifies what to send New Relic and
|
||||
in what form it should be sent.</p>
|
||||
|
||||
<p>Any metric instances Istio sends to the adapter but not specified here
|
||||
will be dropped and not exported to New Relic.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo">Params.MetricInfo</h2>
|
||||
<section>
|
||||
<p>Describes how to represent an Istio metric instance in New Relic.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-name">
|
||||
<td><code>name</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Recommended. The name of the metric (scoped by namespaces) in New Relic.</p>
|
||||
|
||||
<p>The name must not be empty and the fully qualified name (prefixed
|
||||
with the namespace) must contain 255 16-bit code units (UTF-16) or
|
||||
less. Otherwise, an error will be logged and no metric will be sent
|
||||
to New Relic.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-type">
|
||||
<td><code>type</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-Type">Params.MetricInfo.Type</a></code></td>
|
||||
<td>
|
||||
<p>Required. New Relic metric type to interpret the Istio instance as.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-Type">Params.MetricInfo.Type</h2>
|
||||
<section>
|
||||
<p>New Relic Metric types.</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-Type-UNSPECIFIED">
|
||||
<td><code>UNSPECIFIED</code></td>
|
||||
<td>
|
||||
<p>Default and invalid unspecified type.</p>
|
||||
|
||||
<p>An error will be logged and the metric dropped if unspecified.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-GAUGE">
|
||||
<td><code>GAUGE</code></td>
|
||||
<td>
|
||||
<p>A New Relic <code>Gauge</code> type.</p>
|
||||
|
||||
<p>This metric type represents the instantaneous state of something
|
||||
or process that can both increase and decrease in value.</p>
|
||||
|
||||
<p>For example, this metric type would be used to record:</p>
|
||||
|
||||
<ul>
|
||||
<li>the network throughput of a service</li>
|
||||
<li>the storage capacity used on a server</li>
|
||||
<li>the size of a queue</li>
|
||||
</ul>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-COUNT">
|
||||
<td><code>COUNT</code></td>
|
||||
<td>
|
||||
<p>A New Relic <code>Count</code> type.</p>
|
||||
|
||||
<p>This metric type represents the number of occurrences for an event
|
||||
within a time window. It is important to note that this is not the
|
||||
cumulative tally of occurrences since the beginning of
|
||||
measurements. Rather, this metric type represents the change in the
|
||||
cumulative tally of events within a time window.</p>
|
||||
|
||||
<p>For example, this metric type would be used to record:</p>
|
||||
|
||||
<ul>
|
||||
<li>the number of requests to a service</li>
|
||||
<li>the number of tasks submitted to a processor</li>
|
||||
<li>the number of errors produced</li>
|
||||
</ul>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-SUMMARY">
|
||||
<td><code>SUMMARY</code></td>
|
||||
<td>
|
||||
<p>New Relic <code>Summary</code> type.</p>
|
||||
|
||||
<p>This metric type reports aggregated information about discrete
|
||||
events. The information is recorded as a count of events, average
|
||||
event values, sum of event values, and the minimum and maximum
|
||||
event values observed within a time window.</p>
|
||||
|
||||
<p>For example, this metric type would be used to record:</p>
|
||||
|
||||
<ul>
|
||||
<li>the duration and count of requests to service</li>
|
||||
<li>the duration and count of database transactions</li>
|
||||
<li>the time each message spent in a queue</li>
|
||||
</ul>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,100 +0,0 @@
|
|||
---
|
||||
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: OPA
|
||||
description: Adapter that implements an Open Policy Agent engine.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/opa.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: authorization
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/opa.html
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>opa</code> adapter exposes an <a href="http://www.openpolicyagent.org">Open Policy Agent</a> engine
|
||||
that provides sophisticated access control mechanisms.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/authorization/">authorization template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the <code>opa</code> adapter.</p>
|
||||
|
||||
<p>Example configuration:</p>
|
||||
|
||||
<pre><code class="language-yaml">policy:
|
||||
- |+
|
||||
package mixerauthz
|
||||
policy = [
|
||||
{
|
||||
"rule": {
|
||||
"verbs": [
|
||||
"storage.buckets.get"
|
||||
],
|
||||
"users": [
|
||||
"bucket-admins"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
default allow = false
|
||||
|
||||
allow = true {
|
||||
rule = policy[_].rule
|
||||
input.subject.user = rule.users[_]
|
||||
input.action.method = rule.verbs[_]
|
||||
}
|
||||
checkMethod: "data.mixerauthz.allow"
|
||||
failClose: true
|
||||
</code></pre>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-policy">
|
||||
<td><code>policy</code></td>
|
||||
<td><code>string[]</code></td>
|
||||
<td>
|
||||
<p>List of OPA policies</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-check_method">
|
||||
<td><code>checkMethod</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Query method to check.
|
||||
Format: <code>data.<package name>.<method name></code></p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-fail_close">
|
||||
<td><code>failClose</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Close the client request when adapter has a issue.
|
||||
If failClose is set to true and there is a runtime error,
|
||||
instead of disabling the adapter, close the client request</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,470 +0,0 @@
|
|||
---
|
||||
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: Prometheus
|
||||
description: Adapter that exposes Istio metrics for ingestion by a Prometheus harvester.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/prometheus.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: metric
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/prometheus.html
|
||||
number_of_entries: 8
|
||||
---
|
||||
<p>The <code>prometheus</code> adapter collects Istio metrics and makes them available to
|
||||
<a href="https://prometheus.io">Prometheus</a>.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the <code>prometheus</code> adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-metrics">
|
||||
<td><code>metrics</code></td>
|
||||
<td><code><a href="#Params-MetricInfo">MetricInfo[]</a></code></td>
|
||||
<td>
|
||||
<p>The set of metrics to represent in Prometheus. If a metric is defined in Istio but doesn’t have a corresponding
|
||||
shape here, it will not be populated at runtime.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-metrics_expiration_policy">
|
||||
<td><code>metricsExpirationPolicy</code></td>
|
||||
<td><code><a href="#Params-MetricsExpirationPolicy">MetricsExpirationPolicy</a></code></td>
|
||||
<td>
|
||||
<p>Optional. The rate at which to expire metrics from the adapter. This option controls the amount of metric data
|
||||
that the adapter will maintain over its lifetime.</p>
|
||||
|
||||
<p>EXPERIMENTAL: This feature should only be used in advanced cases.</p>
|
||||
|
||||
<p>Example config stanza:</p>
|
||||
|
||||
<pre><code class="language-yaml">metricsExpirationPolicy:
|
||||
metricsExpiryDuration: "5s"
|
||||
expiryCheckIntervalDuration: "1s"
|
||||
</code></pre>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo">Params.MetricInfo</h2>
|
||||
<section>
|
||||
<p>Describes how a metric should be represented in Prometheus.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-namespace">
|
||||
<td><code>namespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Optional. The namespace is used as a prefix on the metric names.
|
||||
An example: for a metric named <code>requests_total</code> with a namespace of <code>istio</code>,
|
||||
the full metric name becomes <code>istio_requests_total</code>.
|
||||
NOTE: The specified namespace should be a prometheus-safe name. If not, the adapter
|
||||
will attempt to convert the namespace to a prometheus-safe name.
|
||||
NOTE: Changing the value for this will potentially impact downstream integrations
|
||||
and should be used with caution.
|
||||
Default value: <code>istio</code>.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-name">
|
||||
<td><code>name</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Recommended. The name is used to register the prometheus metric.
|
||||
It must be unique across all prometheus metrics as prometheus does not allow duplicate names.
|
||||
If name is not specified a sanitized version of instance_name is used.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-instance_name">
|
||||
<td><code>instanceName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Required. The name is the fully qualified name of the Istio metric instance
|
||||
that this MetricInfo processes.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-description">
|
||||
<td><code>description</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Optional. A human readable description of this metric.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-kind">
|
||||
<td><code>kind</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-Kind">Kind</a></code></td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-buckets">
|
||||
<td><code>buckets</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-BucketsDefinition">BucketsDefinition</a></code></td>
|
||||
<td>
|
||||
<p>For metrics with a metric kind of DISTRIBUTION, this provides a mechanism
|
||||
for configuring the buckets that will be used to store the aggregated values.
|
||||
This field must be provided for metrics declared to be of type DISTRIBUTION.
|
||||
This field will be ignored for non-distribution metric kinds.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-label_names">
|
||||
<td><code>labelNames</code></td>
|
||||
<td><code>string[]</code></td>
|
||||
<td>
|
||||
<p>The names of labels to use: these need to match the dimensions of the Istio metric.
|
||||
TODO: see if we can remove this and rely on only the dimensions in the future.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-BucketsDefinition">Params.MetricInfo.BucketsDefinition</h2>
|
||||
<section>
|
||||
<p>Describes buckets for DISTRIBUTION kind metrics.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-linear_buckets" class="oneof oneof-start">
|
||||
<td><code>linearBuckets</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-BucketsDefinition-Linear">Linear (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>The linear buckets.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
Yes
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-exponential_buckets" class="oneof">
|
||||
<td><code>exponentialBuckets</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-BucketsDefinition-Exponential">Exponential (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>The exponential buckets.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
Yes
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-explicit_buckets" class="oneof">
|
||||
<td><code>explicitBuckets</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-BucketsDefinition-Explicit">Explicit (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>The explicit buckets.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
Yes
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-BucketsDefinition-Explicit">Params.MetricInfo.BucketsDefinition.Explicit</h2>
|
||||
<section>
|
||||
<p>Specifies a set of buckets with arbitrary widths.</p>
|
||||
|
||||
<p>There are <code>size(bounds) + 1</code> (= <code>N</code>) buckets. Bucket <code>i</code> has the following
|
||||
boundaries:</p>
|
||||
|
||||
<ul>
|
||||
<li>Upper bound (<code>0 <= i < N-1</code>): <code>bounds[i]</code></li>
|
||||
<li>Lower bound (<code>1 <= i < N</code>): <code>bounds[i - 1]</code></li>
|
||||
</ul>
|
||||
|
||||
<p>The <code>bounds</code> field must contain at least one element. If <code>bounds</code> has
|
||||
only one element, then there are no finite buckets, and that single
|
||||
element is the common boundary of the overflow and underflow buckets.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Explicit-bounds">
|
||||
<td><code>bounds</code></td>
|
||||
<td><code>double[]</code></td>
|
||||
<td>
|
||||
<p>The values must be monotonically increasing.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-BucketsDefinition-Exponential">Params.MetricInfo.BucketsDefinition.Exponential</h2>
|
||||
<section>
|
||||
<p>Specifies an exponential sequence of buckets that have a width that is
|
||||
proportional to the value of the lower bound. Each bucket represents a
|
||||
constant relative uncertainty on a specific value in the bucket.</p>
|
||||
|
||||
<p>There are <code>num_finite_buckets + 2</code> (= <code>N</code>) buckets. The two additional
|
||||
buckets are the underflow and overflow buckets.</p>
|
||||
|
||||
<p>Bucket <code>i</code> has the following boundaries:</p>
|
||||
|
||||
<ul>
|
||||
<li>Upper bound (0 <= i < N-1): <code>scale * (growth_factor ^ i)</code></li>
|
||||
<li>Lower bound (1 <= i < N): <code>scale * (growth_factor ^ (i - 1))</code></li>
|
||||
</ul>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Exponential-num_finite_buckets">
|
||||
<td><code>numFiniteBuckets</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Must be greater than 0.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Exponential-growth_factor">
|
||||
<td><code>growthFactor</code></td>
|
||||
<td><code>double</code></td>
|
||||
<td>
|
||||
<p>Must be greater than 1.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Exponential-scale">
|
||||
<td><code>scale</code></td>
|
||||
<td><code>double</code></td>
|
||||
<td>
|
||||
<p>Must be greater than 0.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-BucketsDefinition-Linear">Params.MetricInfo.BucketsDefinition.Linear</h2>
|
||||
<section>
|
||||
<p>Specifies a linear sequence of buckets that all have the same width
|
||||
(except overflow and underflow). Each bucket represents a constant
|
||||
absolute uncertainty on the specific value in the bucket.</p>
|
||||
|
||||
<p>There are <code>num_finite_buckets + 2</code> (= <code>N</code>) buckets. The two additional
|
||||
buckets are the underflow and overflow buckets.</p>
|
||||
|
||||
<p>Bucket <code>i</code> has the following boundaries:</p>
|
||||
|
||||
<ul>
|
||||
<li>Upper bound (<code>0 <= i < N-1</code>): <code>offset + (width * i)</code></li>
|
||||
<li>Lower bound (<code>1 <= i < N</code>): <code>offset + (width * (i - 1))</code></li>
|
||||
</ul>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Linear-num_finite_buckets">
|
||||
<td><code>numFiniteBuckets</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Must be greater than 0.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Linear-width">
|
||||
<td><code>width</code></td>
|
||||
<td><code>double</code></td>
|
||||
<td>
|
||||
<p>Must be greater than 0.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Linear-offset">
|
||||
<td><code>offset</code></td>
|
||||
<td><code>double</code></td>
|
||||
<td>
|
||||
<p>Lower bound of the first bucket.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-Kind">Params.MetricInfo.Kind</h2>
|
||||
<section>
|
||||
<p>Describes what kind of metric this is.</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-Kind-UNSPECIFIED">
|
||||
<td><code>UNSPECIFIED</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Kind-GAUGE">
|
||||
<td><code>GAUGE</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Kind-COUNTER">
|
||||
<td><code>COUNTER</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Kind-DISTRIBUTION">
|
||||
<td><code>DISTRIBUTION</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricsExpirationPolicy">Params.MetricsExpirationPolicy</h2>
|
||||
<section>
|
||||
<p>Describes the expiration policy for metrics generated by a prometheus handler.</p>
|
||||
|
||||
<p>Example: A Metrics Expiration Policy of <code>{ metrics_expiry_duration: "10m", expiry_check_interval_duration: "1m" }</code>
|
||||
would configure the handler to delete all metrics that have received no updtaes for 10 minutes. Metrics would be checked
|
||||
every minute to determine whether or not they should be expired.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricsExpirationPolicy-metrics_expiry_duration">
|
||||
<td><code>metricsExpiryDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Required. Describes the desired lifetime of a metric. If the metric is not updated at any point during this duration, it
|
||||
will be removed from the set of metrics exported by the handler.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricsExpirationPolicy-expiry_check_interval_duration">
|
||||
<td><code>expiryCheckIntervalDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>Optional. Describes the interval in which metrics will be checked to see if they have been stale for longer that the configured
|
||||
<code>metrics_expiry_duration</code>. This should be generally be set to a duration much shorter than the configured <code>metrics_expiry_duration</code>.
|
||||
This bounds the total amount of additional time (beyond the desired lifetime) that a metric may be exported.
|
||||
If a value is not explicitly provided, this value will default to half of the configured <code>metrics_expiry_duration</code>.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,245 +0,0 @@
|
|||
---
|
||||
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: Redis Quota
|
||||
description: Adapter for a Redis-based quota management system.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/redisquota.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: quota
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/redisquota.html
|
||||
number_of_entries: 4
|
||||
---
|
||||
<p>The <code>redisquota</code> adapter can be used to support Istio’s quota management
|
||||
system. It depends on a Redis server to store quota values.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/quota/">quota template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>redisquota adapter supports the rate limit quota using either fixed or
|
||||
rolling window algorithm. And it is using Redis as a shared data storage.</p>
|
||||
|
||||
<p>Example configuration:</p>
|
||||
|
||||
<pre><code class="language-yaml">redisServerUrl: localhost:6379
|
||||
connectionPoolSize: 10
|
||||
quotas:
|
||||
- name: requestcount.quota.istio-system
|
||||
maxAmount: 50
|
||||
validDuration: 60s
|
||||
bucketDuration: 1s
|
||||
rateLimitAlgorithm: ROLLING_WINDOW
|
||||
overrides:
|
||||
- dimensions:
|
||||
destination: ratings
|
||||
source: reviews
|
||||
maxAmount: 12
|
||||
- dimensions:
|
||||
destination: reviews
|
||||
maxAmount: 5
|
||||
</code></pre>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-quotas">
|
||||
<td><code>quotas</code></td>
|
||||
<td><code><a href="#Params-Quota">Quota[]</a></code></td>
|
||||
<td>
|
||||
<p>The set of known quotas. At least one quota configuration is required</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-redis_server_url">
|
||||
<td><code>redisServerUrl</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Redis connection string <code><hostname>:<port number></code>
|
||||
ex) localhost:6379</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-connection_pool_size">
|
||||
<td><code>connectionPoolSize</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>Maximum number of idle connections to redis
|
||||
Default is 10 connections per every CPU as reported by runtime.NumCPU.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-Override">Params.Override</h2>
|
||||
<section>
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-Override-dimensions">
|
||||
<td><code>dimensions</code></td>
|
||||
<td><code>map<string, string></code></td>
|
||||
<td>
|
||||
<p>The specific dimensions for which this override applies.
|
||||
String representation of instance dimensions is used to check against configured dimensions.
|
||||
<code>dimensions</code> should not be empty</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Override-max_amount">
|
||||
<td><code>maxAmount</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>The upper limit for this quota override.
|
||||
This value should be bigger than 0</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-Quota">Params.Quota</h2>
|
||||
<section>
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-Quota-name">
|
||||
<td><code>name</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The name of the quota</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Quota-max_amount">
|
||||
<td><code>maxAmount</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>The upper limit for this quota. max_amount should be bigger than 0</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Quota-valid_duration">
|
||||
<td><code>validDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>The amount of time allocated quota remains valid before it is
|
||||
automatically released. This is only meaningful for rate limit quotas.
|
||||
value should be <code>0 < validDuration</code></p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Quota-bucket_duration">
|
||||
<td><code>bucketDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>The <code>bucketDuration</code> will be ignored if <code>rateLimitAlgorithm</code> is <code>FIXED_WINDOW</code>
|
||||
value should be <code>0 < bucketDuration < validDuration</code></p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Quota-rate_limit_algorithm">
|
||||
<td><code>rateLimitAlgorithm</code></td>
|
||||
<td><code><a href="#Params-QuotaAlgorithm">QuotaAlgorithm</a></code></td>
|
||||
<td>
|
||||
<p>Quota management algorithm. The default value is <code>FIXED_WINDOW</code></p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Quota-overrides">
|
||||
<td><code>overrides</code></td>
|
||||
<td><code><a href="#Params-Override">Override[]</a></code></td>
|
||||
<td>
|
||||
<p>Overrides associated with this quota.
|
||||
The first matching override is applied.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-QuotaAlgorithm">Params.QuotaAlgorithm</h2>
|
||||
<section>
|
||||
<p>Algorithms for rate-limiting:</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-QuotaAlgorithm-FIXED_WINDOW">
|
||||
<td><code>FIXED_WINDOW</code></td>
|
||||
<td>
|
||||
<p><code>FIXED_WINDOW</code> The fixed window approach can allow 2x peak specified rate, whereas the rolling-window doesn’t.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-QuotaAlgorithm-ROLLING_WINDOW">
|
||||
<td><code>ROLLING_WINDOW</code></td>
|
||||
<td>
|
||||
<p><code>ROLLING_WINDOW</code> The rolling window algorithm’s additional precision comes at the cost of increased redis resource usage.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,231 +0,0 @@
|
|||
---
|
||||
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: SolarWinds
|
||||
description: Adapter to deliver logs and metrics to Papertrail and AppOptics backends.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/solarwinds.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: metric,logentry
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/solarwinds.html
|
||||
number_of_entries: 3
|
||||
---
|
||||
<p>The <code>solarwinds</code> adapter enables Istio to deliver log and metric data to the
|
||||
<a href="https://www.papertrailapp.com">Papertrail</a> logging backend and the
|
||||
<a href="https://www.appoptics.com">AppOptics</a> monitoring backend.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>
|
||||
and the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/metric/">logentry template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the <code>solarwinds</code> adapter.</p>
|
||||
|
||||
<p>Example config usage:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: handler
|
||||
metadata:
|
||||
name: solarwinds
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledAdapter: solarwinds
|
||||
params:
|
||||
appoptics_access_token: <APPOPTICS SAMPLE TOKEN>
|
||||
papertrail_url: <PAPERTRAIL URL>
|
||||
papertrail_local_retention_duration: <RETENTION PERIOD FOR LOGS LOCALLY, Optional>
|
||||
metrics:
|
||||
requestcount.metric.istio-system:
|
||||
label_names:
|
||||
- source_service
|
||||
- source_version
|
||||
- destination_service
|
||||
- destination_version
|
||||
- response_code
|
||||
requestduration.metric.istio-system:
|
||||
label_names:
|
||||
- source_service
|
||||
- source_version
|
||||
- destination_service
|
||||
- destination_version
|
||||
- response_code
|
||||
requestsize.metric.istio-system:
|
||||
label_names:
|
||||
- source_service
|
||||
- source_version
|
||||
- destination_service
|
||||
- destination_version
|
||||
- response_code
|
||||
responsesize.metric.istio-system:
|
||||
label_names:
|
||||
- source_service
|
||||
- source_version
|
||||
- destination_service
|
||||
- destination_version
|
||||
- response_code
|
||||
tcpbytesent.metric.istio-system:
|
||||
label_names:
|
||||
- source_service
|
||||
- source_version
|
||||
- destination_service
|
||||
- destination_version
|
||||
tcpbytereceived.metric.istio-system:
|
||||
label_names:
|
||||
- source_service
|
||||
- source_version
|
||||
- destination_service
|
||||
- destination_version
|
||||
logs:
|
||||
solarwindslogentry.logentry.istio-system:
|
||||
payloadTemplate: '{{or (.originIp) "-"}} - {{or (.sourceUser) "-"}} [{{or (.timestamp.Format "2006-01-02T15:04:05Z07:00") "-"}}] "{{or (.method) "-"}} {{or (.url) "-"}} {{or (.protocol) "-"}}" {{or (.responseCode) "-"}} {{or (.responseSize) "-"}}'
|
||||
</code></pre>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-appoptics_access_token">
|
||||
<td><code>appopticsAccessToken</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>AppOptics Access Token needed to send metrics to AppOptics. If no access token is given then metrics
|
||||
will NOT be shipped to AppOptics</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-appoptics_batch_size">
|
||||
<td><code>appopticsBatchSize</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Optional. Max batch size of metrics to be sent to AppOptics.
|
||||
AppOptics does not allow batch size greater than 1000.
|
||||
If this is unspecified or given a value 0 explicitly, a default batch size of 1000 will be used.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-papertrail_url">
|
||||
<td><code>papertrailUrl</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Papertrail url to ship logs to. If no papertrail url is given then the logs will NOT be shipped but rather
|
||||
dropped.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-papertrail_local_retention_duration">
|
||||
<td><code>papertrailLocalRetentionDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>This is the duration for which logs will be persisted locally until it is shipped to papertrail in the event
|
||||
of a network failure. Default value is 1 hour.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-metrics">
|
||||
<td><code>metrics</code></td>
|
||||
<td><code>map<string, <a href="#Params-MetricInfo">MetricInfo</a>></code></td>
|
||||
<td>
|
||||
<p>A map of Istio metric name to solarwinds metric info.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-logs">
|
||||
<td><code>logs</code></td>
|
||||
<td><code>map<string, <a href="#Params-LogInfo">LogInfo</a>></code></td>
|
||||
<td>
|
||||
<p>A map of Istio logentry name to solarwinds log info.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-LogInfo">Params.LogInfo</h2>
|
||||
<section>
|
||||
<p>Describes how to represent an Istio log entry in Solarwinds AppOptics</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-LogInfo-payload_template">
|
||||
<td><code>payloadTemplate</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Optional. A golang text/template template (more details about golang text/template’s templating can be
|
||||
found here: https://golang.org/pkg/text/template/) that will be executed to construct the payload for
|
||||
this log entry.
|
||||
An example template that could be used:
|
||||
{{or (.originIp) “-”}} - {{or (.sourceUser) “-”}} [{{or (.timestamp.Format “2006-01-02T15:04:05Z07:00”) “-”}}] “{{or (.method) “-”}} {{or (.url) “-”}} {{or (.protocol) “-”}}” {{or (.responseCode) “-”}} {{or (.responseSize) “-”}}
|
||||
A sample log that will be created after parsing the template with appropriate variables will look like this:
|
||||
Jan 23 21:53:02 istio-mixer-57d88dc4b4-rbgmc istio: 10.32.0.15 - kubernetes://istio-ingress-78545c5bc9-wbr6g.istio-system [2018-01-24T02:53:02Z] “GET /productpage http” 200 5599
|
||||
It will be given the full set of variables for the log to use to construct its result.
|
||||
If it is not provided, a default template in place will be used.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo">Params.MetricInfo</h2>
|
||||
<section>
|
||||
<p>Describes how to represent an Istio metric in Solarwinds AppOptics</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-label_names">
|
||||
<td><code>labelNames</code></td>
|
||||
<td><code>string[]</code></td>
|
||||
<td>
|
||||
<p>The names of labels to use: these need to match the dimensions of the Istio metric.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,874 +0,0 @@
|
|||
---
|
||||
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: Stackdriver
|
||||
description: Adapter to deliver logs, metrics, and traces to Stackdriver.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/stackdriver.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: metric,logentry,tracespan
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/stackdriver.html
|
||||
number_of_entries: 12
|
||||
---
|
||||
<p>The <code>stackdriver</code> adapter enables Istio to deliver log, metric and traces to the
|
||||
<a href="https://cloud.google.com/stackdriver/">Stackdriver</a> backend.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>,
|
||||
the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/logentry/">logentry template</a>,
|
||||
and the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/tracespan/">tracespan template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the <code>stackdriver</code> adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-endpoint">
|
||||
<td><code>endpoint</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Endpoint URL to send stackdriver data - leave empty to use the
|
||||
StackDriver SDK’s default value (monitoring.googleapis.com).</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-project_id">
|
||||
<td><code>projectId</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>GCP Project to attach metrics to.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-push_interval">
|
||||
<td><code>pushInterval</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>This adapter batches the data it sends to Stackdriver; we will push to stackdriver every push_interval.
|
||||
If no value is provided we default to once per minute.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-app_credentials" class="oneof oneof-start">
|
||||
<td><code>appCredentials</code></td>
|
||||
<td><code>bool (oneof)</code></td>
|
||||
<td>
|
||||
<p>Use Google’s Application Default Credentials to authorize calls made
|
||||
by the StackDriver SDK.</p>
|
||||
|
||||
<p><a href="https://developers.google.com/identity/protocols/application-default-credentials">See Google’s documentation</a>.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
Yes
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-api_key" class="oneof">
|
||||
<td><code>apiKey</code></td>
|
||||
<td><code>string (oneof)</code></td>
|
||||
<td>
|
||||
<p>The API Key to be used for auth. API Key is no longer supported, use service account instead.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
Yes
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-service_account_path" class="oneof">
|
||||
<td><code>serviceAccountPath</code></td>
|
||||
<td><code>string (oneof)</code></td>
|
||||
<td>
|
||||
<p>The path to a Google service account credential file, relative to
|
||||
the Mixer. E.g. <code>/etc/opt/mixer/gcp-serviceaccount-creds.json</code>
|
||||
or <code>./testdata/my-test-account-creds.json</code>.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
Yes
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-metric_info">
|
||||
<td><code>metricInfo</code></td>
|
||||
<td><code>map<string, <a href="#Params-MetricInfo">MetricInfo</a>></code></td>
|
||||
<td>
|
||||
<p>A map of Istio metric name to Stackdriver metric info.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-log_info">
|
||||
<td><code>logInfo</code></td>
|
||||
<td><code>map<string, <a href="#Params-LogInfo">LogInfo</a>></code></td>
|
||||
<td>
|
||||
<p>A map of Istio LogEntry name to Stackdriver log info.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-trace">
|
||||
<td><code>trace</code></td>
|
||||
<td><code><a href="#Params-Trace">Trace</a></code></td>
|
||||
<td>
|
||||
<p>Stackdriver Trace configuration.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-LogInfo">Params.LogInfo</h2>
|
||||
<section>
|
||||
<p>Describes how to represent an Istio Log in Stackdriver.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-LogInfo-label_names">
|
||||
<td><code>labelNames</code></td>
|
||||
<td><code>string[]</code></td>
|
||||
<td>
|
||||
<p>The logging template provides a set of variables; these list the subset of variables that should be used to
|
||||
form Stackdriver labels for the log entry.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-payload_template">
|
||||
<td><code>payloadTemplate</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>A golang text/template template that will be executed to construct the payload for this log entry.
|
||||
It will be given the full set of variables for the log to use to construct its result.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-http_mapping">
|
||||
<td><code>httpMapping</code></td>
|
||||
<td><code><a href="#Params-LogInfo-HttpRequestMapping">HttpRequestMapping</a></code></td>
|
||||
<td>
|
||||
<p>If an HttpRequestMapping is provided, a HttpRequest object will be filled out for this log entry using the
|
||||
variables named in the mapping to populate the fields of the request struct from the instance’s variables.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-sink_info">
|
||||
<td><code>sinkInfo</code></td>
|
||||
<td><code><a href="#Params-LogInfo-SinkInfo">SinkInfo</a></code></td>
|
||||
<td>
|
||||
<p>If SinkInfo is provided, Stackriver logs would be exported to that sink.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-LogInfo-HttpRequestMapping">Params.LogInfo.HttpRequestMapping</h2>
|
||||
<section>
|
||||
<p>Maps from template variable names to the various fields of Stackdriver’s HTTP request struct.
|
||||
See https://godoc.org/cloud.google.com/go/logging#HTTPRequest</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-LogInfo-HttpRequestMapping-status">
|
||||
<td><code>status</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>template variable name to map into HTTPRequest.Status</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-HttpRequestMapping-request_size">
|
||||
<td><code>requestSize</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>template variable name to map into HTTPRequest.RequestSize</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-HttpRequestMapping-response_size">
|
||||
<td><code>responseSize</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>template variable name to map into HTTPRequest.ResponseSize</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-HttpRequestMapping-latency">
|
||||
<td><code>latency</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>template variable name to map into HTTPRequest.Latency</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-HttpRequestMapping-local_ip">
|
||||
<td><code>localIp</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>template variable name to map into HTTPRequest.LocalIP</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-HttpRequestMapping-remote_ip">
|
||||
<td><code>remoteIp</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>template variable name to map into HTTPRequest.RemoteIP</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-HttpRequestMapping-url">
|
||||
<td><code>url</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>template variable name to map into HTTPRequest.Request.Url</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-HttpRequestMapping-method">
|
||||
<td><code>method</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>template variable name to map into HTTPRequest.RequestMethod</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-HttpRequestMapping-user_agent">
|
||||
<td><code>userAgent</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>template variable name to map into HTTPRequest.UserAgent</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-HttpRequestMapping-referer">
|
||||
<td><code>referer</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>template variable name to map into HTTPRequest.Referer</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-LogInfo-SinkInfo">Params.LogInfo.SinkInfo</h2>
|
||||
<section>
|
||||
<p>Contains information about sink to export Stackdriver logs to.
|
||||
See https://godoc.org/cloud.google.com/go/logging/logadmin#Sink.
|
||||
Ex: If you want to export it to a GCS bucket, id would be a unique idetifier you want for the sink,
|
||||
destination would be the storage be name of GCS Storage bucket and filter would be user defined condition for
|
||||
filtering logs. See below for a sample config:</p>
|
||||
|
||||
<pre><code class="language-yaml">id: 'info-errors-to-gcs'
|
||||
destination: 'storage.googleapis.com/<bucket_name>'
|
||||
filter: 'severity >= Default'
|
||||
</code></pre>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-LogInfo-SinkInfo-id">
|
||||
<td><code>id</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Client assigned sink identifier.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-SinkInfo-destination">
|
||||
<td><code>destination</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Export Destination.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-SinkInfo-filter">
|
||||
<td><code>filter</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Filter that specifies any filtering to be done on logs.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-SinkInfo-UniqueWriterIdentity">
|
||||
<td><code>UniqueWriterIdentity</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Determines the kind of IAM identity returned as WriterIdentity in the new
|
||||
sink. If this value is omitted or set to false, and if the sink’s parent is a
|
||||
project, then the value returned as WriterIdentity is the same group or
|
||||
service account used by Stackdriver Logging before the addition of writer
|
||||
identities to the API. The sink’s destination must be in the same project as
|
||||
the sink itself.</p>
|
||||
|
||||
<p>If this field is set to true, or if the sink is owned by a non-project
|
||||
resource such as an organization, then the value of WriterIdentity will
|
||||
be a unique service account used only for exports from the new sink.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-SinkInfo-UpdateDestination">
|
||||
<td><code>UpdateDestination</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>These fields apply only to UpdateSinkOpt calls. The corresponding sink field
|
||||
is updated if and only if the Update field is true.
|
||||
Upate sink destination.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-SinkInfo-UpdateFilter">
|
||||
<td><code>UpdateFilter</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Update sink filter.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-LogInfo-SinkInfo-UpdateIncludeChildren">
|
||||
<td><code>UpdateIncludeChildren</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Update includes children.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo">Params.MetricInfo</h2>
|
||||
<section>
|
||||
<p>Describes how to represent an Istio metric in Stackdriver.
|
||||
See https://github.com/googleapis/googleapis/blob/master/google/api/metric.proto</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-kind">
|
||||
<td><code>kind</code></td>
|
||||
<td><code><a href="#google-api-MetricDescriptor-MetricKind">MetricKind</a></code></td>
|
||||
<td>
|
||||
<p>The kind of measurement for a metric, which describes how the data is reported. Ex: Gauge.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-value">
|
||||
<td><code>value</code></td>
|
||||
<td><code><a href="#google-api-MetricDescriptor-ValueType">ValueType</a></code></td>
|
||||
<td>
|
||||
<p>The type of the metric’s value. Ex: Distribution.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-buckets">
|
||||
<td><code>buckets</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-BucketsDefinition">BucketsDefinition</a></code></td>
|
||||
<td>
|
||||
<p>For metrics with a metric value of DISTRIBUTION, this provides a mechanism
|
||||
for configuring the buckets that will be used to store the aggregated values.
|
||||
This field must be provided for metrics declared to be of type DISTRIBUTION.
|
||||
This field will be ignored for non-distribution metric kinds.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-metric_type">
|
||||
<td><code>metricType</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Stackdriver metric type name, e.g.
|
||||
istio.io/service/server/request_count. If this is not provided, a
|
||||
concantenation of custom metric prefix (custom.googleapis.com/) and
|
||||
Istio metric name will be used.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-BucketsDefinition">Params.MetricInfo.BucketsDefinition</h2>
|
||||
<section>
|
||||
<p>Describes buckets for DISTRIBUTION valued metrics.
|
||||
TODO: look into using google.api.distribution.proto instead - we would pull it in but it has a ton of
|
||||
dependencies it doesn’t actually use.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-linear_buckets" class="oneof oneof-start">
|
||||
<td><code>linearBuckets</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-BucketsDefinition-Linear">Linear (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>The linear buckets.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
Yes
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-exponential_buckets" class="oneof">
|
||||
<td><code>exponentialBuckets</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-BucketsDefinition-Exponential">Exponential (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>The exponential buckets.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
Yes
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-explicit_buckets" class="oneof">
|
||||
<td><code>explicitBuckets</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-BucketsDefinition-Explicit">Explicit (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>The explicit buckets.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
Yes
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-BucketsDefinition-Explicit">Params.MetricInfo.BucketsDefinition.Explicit</h2>
|
||||
<section>
|
||||
<p>Specifies a set of buckets with arbitrary widths.</p>
|
||||
|
||||
<p>There are <code>size(bounds) + 1</code> (= <code>N</code>) buckets. Bucket <code>i</code> has the following
|
||||
boundaries:</p>
|
||||
|
||||
<ul>
|
||||
<li>Upper bound (<code>0 <= i < N-1</code>): <code>bounds[i]</code></li>
|
||||
<li>Lower bound (<code>1 <= i < N</code>): <code>bounds[i - 1]</code></li>
|
||||
</ul>
|
||||
|
||||
<p>The <code>bounds</code> field must contain at least one element. If <code>bounds</code> has
|
||||
only one element, then there are no finite buckets, and that single
|
||||
element is the common boundary of the overflow and underflow buckets.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Explicit-bounds">
|
||||
<td><code>bounds</code></td>
|
||||
<td><code>double[]</code></td>
|
||||
<td>
|
||||
<p>The values must be monotonically increasing.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-BucketsDefinition-Exponential">Params.MetricInfo.BucketsDefinition.Exponential</h2>
|
||||
<section>
|
||||
<p>Specifies an exponential sequence of buckets that have a width that is
|
||||
proportional to the value of the lower bound. Each bucket represents a
|
||||
constant relative uncertainty on a specific value in the bucket.</p>
|
||||
|
||||
<p>There are <code>num_finite_buckets + 2</code> (= <code>N</code>) buckets. The two additional
|
||||
buckets are the underflow and overflow buckets.</p>
|
||||
|
||||
<p>Bucket <code>i</code> has the following boundaries:</p>
|
||||
|
||||
<ul>
|
||||
<li>Upper bound (0 <= i < N-1): <code>scale * (growth_factor ^ i)</code></li>
|
||||
<li>Lower bound (1 <= i < N): <code>scale * (growth_factor ^ (i - 1))</code></li>
|
||||
</ul>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Exponential-num_finite_buckets">
|
||||
<td><code>numFiniteBuckets</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Must be greater than 0.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Exponential-growth_factor">
|
||||
<td><code>growthFactor</code></td>
|
||||
<td><code>double</code></td>
|
||||
<td>
|
||||
<p>Must be greater than 1.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Exponential-scale">
|
||||
<td><code>scale</code></td>
|
||||
<td><code>double</code></td>
|
||||
<td>
|
||||
<p>Must be greater than 0.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-BucketsDefinition-Linear">Params.MetricInfo.BucketsDefinition.Linear</h2>
|
||||
<section>
|
||||
<p>Specifies a linear sequence of buckets that all have the same width
|
||||
(except overflow and underflow). Each bucket represents a constant
|
||||
absolute uncertainty on the specific value in the bucket.</p>
|
||||
|
||||
<p>There are <code>num_finite_buckets + 2</code> (= <code>N</code>) buckets. The two additional
|
||||
buckets are the underflow and overflow buckets.</p>
|
||||
|
||||
<p>Bucket <code>i</code> has the following boundaries:</p>
|
||||
|
||||
<ul>
|
||||
<li>Upper bound (<code>0 <= i < N-1</code>): <code>offset + (width * i)</code></li>
|
||||
<li>Lower bound (<code>1 <= i < N</code>): <code>offset + (width * (i - 1))</code></li>
|
||||
</ul>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Linear-num_finite_buckets">
|
||||
<td><code>numFiniteBuckets</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Must be greater than 0.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Linear-width">
|
||||
<td><code>width</code></td>
|
||||
<td><code>double</code></td>
|
||||
<td>
|
||||
<p>Must be greater than 0.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-BucketsDefinition-Linear-offset">
|
||||
<td><code>offset</code></td>
|
||||
<td><code>double</code></td>
|
||||
<td>
|
||||
<p>Lower bound of the first bucket.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-Trace">Params.Trace</h2>
|
||||
<section>
|
||||
<p>Details of Stackdriver Trace configuration for tracespan template.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-Trace-sample_probability">
|
||||
<td><code>sampleProbability</code></td>
|
||||
<td><code>double</code></td>
|
||||
<td>
|
||||
<p>Proability that a particular trace ID will be sampled.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="google-api-MetricDescriptor-MetricKind">google.api.MetricDescriptor.MetricKind</h2>
|
||||
<section>
|
||||
<p>The kind of measurement. It describes how the data is reported.</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="google-api-MetricDescriptor-MetricKind-METRIC_KIND_UNSPECIFIED">
|
||||
<td><code>METRIC_KIND_UNSPECIFIED</code></td>
|
||||
<td>
|
||||
<p>Do not use this default value.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="google-api-MetricDescriptor-MetricKind-GAUGE">
|
||||
<td><code>GAUGE</code></td>
|
||||
<td>
|
||||
<p>An instantaneous measurement of a value.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="google-api-MetricDescriptor-MetricKind-DELTA">
|
||||
<td><code>DELTA</code></td>
|
||||
<td>
|
||||
<p>The change in a value during a time interval.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="google-api-MetricDescriptor-MetricKind-CUMULATIVE">
|
||||
<td><code>CUMULATIVE</code></td>
|
||||
<td>
|
||||
<p>A value accumulated over a time interval. Cumulative
|
||||
measurements in a time series should have the same start time
|
||||
and increasing end times, until an event resets the cumulative
|
||||
value to zero and sets a new start time for the following
|
||||
points.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="google-api-MetricDescriptor-ValueType">google.api.MetricDescriptor.ValueType</h2>
|
||||
<section>
|
||||
<p>The value type of a metric.</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="google-api-MetricDescriptor-ValueType-VALUE_TYPE_UNSPECIFIED">
|
||||
<td><code>VALUE_TYPE_UNSPECIFIED</code></td>
|
||||
<td>
|
||||
<p>Do not use this default value.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="google-api-MetricDescriptor-ValueType-BOOL">
|
||||
<td><code>BOOL</code></td>
|
||||
<td>
|
||||
<p>The value is a boolean.
|
||||
This value type can be used only if the metric kind is <code>GAUGE</code>.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="google-api-MetricDescriptor-ValueType-INT64">
|
||||
<td><code>INT64</code></td>
|
||||
<td>
|
||||
<p>The value is a signed 64-bit integer.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="google-api-MetricDescriptor-ValueType-DOUBLE">
|
||||
<td><code>DOUBLE</code></td>
|
||||
<td>
|
||||
<p>The value is a double precision floating point number.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="google-api-MetricDescriptor-ValueType-STRING">
|
||||
<td><code>STRING</code></td>
|
||||
<td>
|
||||
<p>The value is a text string.
|
||||
This value type can be used only if the metric kind is <code>GAUGE</code>.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="google-api-MetricDescriptor-ValueType-DISTRIBUTION">
|
||||
<td><code>DISTRIBUTION</code></td>
|
||||
<td>
|
||||
<p>The value is a <em><code>Distribution</code></em>.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="google-api-MetricDescriptor-ValueType-MONEY">
|
||||
<td><code>MONEY</code></td>
|
||||
<td>
|
||||
<p>The value is money.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,181 +0,0 @@
|
|||
---
|
||||
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: StatsD
|
||||
description: Adapter to deliver metrics to a StatsD backend.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/statsd.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: metric
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/statsd.html
|
||||
number_of_entries: 3
|
||||
---
|
||||
<p>The <code>statsd</code> adapter enables Istio to deliver metric data to a
|
||||
<a href="https://github.com/etsy/statsd">StatsD</a> monitoring backend.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the <code>statsd</code> adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-address">
|
||||
<td><code>address</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Address of the statsd server, e.g. localhost:8125</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-prefix">
|
||||
<td><code>prefix</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Metric prefix, do not specify for no prefix</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-flush_duration">
|
||||
<td><code>flushDuration</code></td>
|
||||
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
|
||||
<td>
|
||||
<p>FlushDuration controls the maximum amount of time between sending metrics to the statsd collection server.
|
||||
Metrics are reported when either flush<em>bytes is full or flush</em>duration time has elapsed since the last report.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-flush_bytes">
|
||||
<td><code>flushBytes</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>Maximum UDP packet size to send; if not specified defaults to 512 bytes. If the statsd server is running on the
|
||||
same (private) network 1432 bytes is recommended for better performance.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-sampling_rate">
|
||||
<td><code>samplingRate</code></td>
|
||||
<td><code>float</code></td>
|
||||
<td>
|
||||
<p>Chance that any particular metric is sampled when incremented; can take the range [0, 1], defaults to 1 if unspecified.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-metrics">
|
||||
<td><code>metrics</code></td>
|
||||
<td><code>map<string, <a href="#Params-MetricInfo">MetricInfo</a>></code></td>
|
||||
<td>
|
||||
<p>Map of metric name -> info. If a metric’s name is not in the map then the metric will not be exported to statsd.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo">Params.MetricInfo</h2>
|
||||
<section>
|
||||
<p>Describes how to represent this metric in statsd</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-type">
|
||||
<td><code>type</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-Type">Type</a></code></td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-name_template">
|
||||
<td><code>nameTemplate</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The template will be filled with values from the metric’s labels and the resulting string will be used as
|
||||
the statsd metric name. This allows easier creation of statsd metrics like <code>action_name-response_code</code>.
|
||||
The template strings must conform to go’s text/template syntax. For the example of <code>action_name-response_code</code>,
|
||||
we use the template:
|
||||
<code>{{.apiMethod}}-{{.responseCode}}</code></p>
|
||||
|
||||
<p>If name_template is the empty string the Istio metric name will be used for statsd metric’s name.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-Type">Params.MetricInfo.Type</h2>
|
||||
<section>
|
||||
<p>The type of metric.</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-Type-UNKNOWN">
|
||||
<td><code>UNKNOWN</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-COUNTER">
|
||||
<td><code>COUNTER</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-GAUGE">
|
||||
<td><code>GAUGE</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-DISTRIBUTION">
|
||||
<td><code>DISTRIBUTION</code></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,247 +0,0 @@
|
|||
---
|
||||
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: Stdio
|
||||
description: Adapter to locally output logs and metrics.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/stdio.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: logentry,metric
|
||||
aliases:
|
||||
- /zh/docs/reference/config/adapters/stdio.html
|
||||
number_of_entries: 3
|
||||
---
|
||||
<p>The <code>stdio</code> adapter enables Istio to output logs and metrics to
|
||||
the local machine. Logs and metrics can be directed to Mixer’s
|
||||
standard output stream, standard error stream, or to any locally
|
||||
reachable file. When outputting to files, you can enable file rotation
|
||||
such that the adapter will automatically manage a set of file backups
|
||||
as data is generated.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/logentry/">logentry template</a>.
|
||||
and the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the <code>stdio</code> adapter</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-log_stream">
|
||||
<td><code>logStream</code></td>
|
||||
<td><code><a href="#Params-Stream">Stream</a></code></td>
|
||||
<td>
|
||||
<p>Selects which standard stream to write to for log entries.
|
||||
STDERR is the default Stream.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-severity_levels">
|
||||
<td><code>severityLevels</code></td>
|
||||
<td><code>map<string, <a href="#Params-Level">Level</a>></code></td>
|
||||
<td>
|
||||
<p>Maps from severity strings as specified in LogEntry instances to
|
||||
the set of levels supported by this adapter. This defaults to a map of</p>
|
||||
|
||||
<pre><code>"INFORMATIONAL" : INFO,
|
||||
"informational" : INFO,
|
||||
"INFO" : INFO,
|
||||
"info" : INFO,
|
||||
"WARNING" : WARNING,
|
||||
"warning" : WARNING,
|
||||
"WARN": WARNING,
|
||||
"warning": WARNING,
|
||||
"ERROR": ERROR,
|
||||
"error": ERROR,
|
||||
"ERR": ERROR,
|
||||
"err": ERROR,
|
||||
"FATAL": ERROR,
|
||||
"fatal": ERROR,
|
||||
</code></pre>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-metric_level">
|
||||
<td><code>metricLevel</code></td>
|
||||
<td><code><a href="#Params-Level">Level</a></code></td>
|
||||
<td>
|
||||
<p>The level to assign to metrics being output. Defaults to INFO.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-output_as_json">
|
||||
<td><code>outputAsJson</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>Whether to output a console-friendly or json-friendly format. Defaults to true.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-output_level">
|
||||
<td><code>outputLevel</code></td>
|
||||
<td><code><a href="#Params-Level">Level</a></code></td>
|
||||
<td>
|
||||
<p>The minimum level to output, anything less than this level is ignored. Defaults to INFO (everything).</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-output_path">
|
||||
<td><code>outputPath</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The file system path when outputting to a file or rotating file.</p>
|
||||
|
||||
<p>When using rotated log files, this path is used as a foundational path. This is where log
|
||||
output is normally saved. When a rotation needs to take place because the file got too big
|
||||
or too old, then the file is renamed by appending a timestamp to the name. Such renamed
|
||||
files are called backups. Once a backup has been created, output resumes to this path.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-max_megabytes_before_rotation">
|
||||
<td><code>maxMegabytesBeforeRotation</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>The maximum size in megabytes of a log file before it gets
|
||||
rotated. It defaults to 100 megabytes.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-max_days_before_rotation">
|
||||
<td><code>maxDaysBeforeRotation</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>The maximum number of days to retain old rotated log files based on the
|
||||
timestamp encoded in their filename. Note that a day is defined as 24
|
||||
hours and may not exactly correspond to calendar days due to daylight
|
||||
savings, leap seconds, etc. The default is to remove log files
|
||||
older than 30 days. 0 indicates no limit.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-max_rotated_files">
|
||||
<td><code>maxRotatedFiles</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>The maximum number of old rotated log files to retain. The default
|
||||
is to retain at most 1000 logs. 0 indicates no limit.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-Level">Params.Level</h2>
|
||||
<section>
|
||||
<p>Importance level for individual items output by this adapter.</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-Level-INFO">
|
||||
<td><code>INFO</code></td>
|
||||
<td>
|
||||
<p>informational, warning, and error log messages are included</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Level-WARNING">
|
||||
<td><code>WARNING</code></td>
|
||||
<td>
|
||||
<p>warning and error log messges are included</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Level-ERROR">
|
||||
<td><code>ERROR</code></td>
|
||||
<td>
|
||||
<p>only error log messages are included</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-Stream">Params.Stream</h2>
|
||||
<section>
|
||||
<p>Stream is used to select between different log output sinks.</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-Stream-STDOUT">
|
||||
<td><code>STDOUT</code></td>
|
||||
<td>
|
||||
<p>Output to the Mixer process’ standard output stream. This is the default value.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Stream-STDERR">
|
||||
<td><code>STDERR</code></td>
|
||||
<td>
|
||||
<p>Output to the Mixer process’ standard error stream.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Stream-FILE">
|
||||
<td><code>FILE</code></td>
|
||||
<td>
|
||||
<p>Output to a specific file.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-Stream-ROTATED_FILE">
|
||||
<td><code>ROTATED_FILE</code></td>
|
||||
<td>
|
||||
<p>Output to a specific rotating file, controlled by the various file rotation options.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,362 +0,0 @@
|
|||
---
|
||||
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/vmware/wavefront-adapter-for-istio' REPO
|
||||
source_repo: https://github.com/vmware/wavefront-adapter-for-istio
|
||||
title: Wavefront by VMware
|
||||
description: Adapter to deliver metrics to Wavefront by VMware.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/wavefront.html
|
||||
layout: partner-component
|
||||
generator: protoc-gen-docs
|
||||
provider: VMware, Inc.
|
||||
contact_email: veniln@vmware.com
|
||||
support_link:
|
||||
source_link: https://github.com/vmware/wavefront-adapter-for-istio
|
||||
latest_release_link: https://github.com/vmware/wavefront-adapter-for-istio/releases/tag/0.1.1
|
||||
helm_chart_link:
|
||||
istio_versions: "1.0.3, 1.0.4"
|
||||
supported_templates: metric
|
||||
logo_link: https://github.com/vmware/wavefront-adapter-for-istio/raw/master/docs/images/logo.png
|
||||
number_of_entries: 9
|
||||
---
|
||||
<p>The <code>wavefront</code> adapter collects metrics and makes them available to
|
||||
<a href="https://www.wavefront.com/">Wavefront by VMware</a>.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the <code>wavefront</code> adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-direct" class="oneof oneof-start">
|
||||
<td><code>direct</code></td>
|
||||
<td><code><a href="#Params-WavefrontDirect">Params.WavefrontDirect (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>The credentials for direct ingestion.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-proxy" class="oneof">
|
||||
<td><code>proxy</code></td>
|
||||
<td><code><a href="#Params-WavefrontProxy">Params.WavefrontProxy (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>The credentials for ingestion via a Wavefront Proxy.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-flush_interval">
|
||||
<td><code>flushInterval</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>The metrics flush interval.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-source">
|
||||
<td><code>source</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The source tag for all metrics handled by this adapter.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-prefix">
|
||||
<td><code>prefix</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The prefix to prepend all metrics handled by the adapter.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-metrics">
|
||||
<td><code>metrics</code></td>
|
||||
<td><code><a href="#Params-MetricInfo">Params.MetricInfo[]</a></code></td>
|
||||
<td>
|
||||
<p>The set of metrics to publish to Wavefront.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-logs">
|
||||
<td><code>logs</code></td>
|
||||
<td><code><a href="#Params-Logs">Params.Logs</a></code></td>
|
||||
<td>
|
||||
<p>The log configuration.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-Logs">Params.Logs</h2>
|
||||
<section>
|
||||
<p>Describes the logging configuration.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-Logs-level">
|
||||
<td><code>level</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The log level (one of error, warn, info, debug, or none). Ex: info</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo">Params.MetricInfo</h2>
|
||||
<section>
|
||||
<p>Describes how a metric should be represented on Wavefront.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-name">
|
||||
<td><code>name</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The metric name. (Optional)</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-instance_name">
|
||||
<td><code>instanceName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The fully qualified Istio metric instance name.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-type">
|
||||
<td><code>type</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-Type">Params.MetricInfo.Type</a></code></td>
|
||||
<td>
|
||||
<p>The metric type.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-sample">
|
||||
<td><code>sample</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-Sample">Params.MetricInfo.Sample</a></code></td>
|
||||
<td>
|
||||
<p>For metrics with type HISTOGRAM, this describes the sample definition.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-Sample">Params.MetricInfo.Sample</h2>
|
||||
<section>
|
||||
<p>Describes a sample as in the <a href="https://github.com/rcrowley/go-metrics">rcrowley/go-metrics</a> library.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-Sample-exp_decay" class="oneof oneof-start">
|
||||
<td><code>expDecay</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-Sample-ExpDecay">Params.MetricInfo.Sample.ExpDecay (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>Definition of an exponentially decaying sample.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Sample-uniform" class="oneof">
|
||||
<td><code>uniform</code></td>
|
||||
<td><code><a href="#Params-MetricInfo-Sample-Uniform">Params.MetricInfo.Sample.Uniform (oneof)</a></code></td>
|
||||
<td>
|
||||
<p>Definition of a uniform sample.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-Sample-ExpDecay">Params.MetricInfo.Sample.ExpDecay</h2>
|
||||
<section>
|
||||
<p>Describes an exponentially decaying sample.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-Sample-ExpDecay-reservoir_size">
|
||||
<td><code>reservoirSize</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>The reservoir size.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Sample-ExpDecay-alpha">
|
||||
<td><code>alpha</code></td>
|
||||
<td><code>double</code></td>
|
||||
<td>
|
||||
<p>The alpha.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-Sample-Uniform">Params.MetricInfo.Sample.Uniform</h2>
|
||||
<section>
|
||||
<p>Describes a uniform sample.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-Sample-Uniform-reservoir_size">
|
||||
<td><code>reservoirSize</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>The reservoir size.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-MetricInfo-Type">Params.MetricInfo.Type</h2>
|
||||
<section>
|
||||
<p>Describes metric types as in <a href="https://docs.wavefront.com/metric_types.html">Wavefront</a>.</p>
|
||||
|
||||
<table class="enum-values">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-MetricInfo-Type-UNKNOWN">
|
||||
<td><code>UNKNOWN</code></td>
|
||||
<td>
|
||||
<p>Reserved for unknown metric types.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-GAUGE">
|
||||
<td><code>GAUGE</code></td>
|
||||
<td>
|
||||
<p>Represents a gauge metric type.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-COUNTER">
|
||||
<td><code>COUNTER</code></td>
|
||||
<td>
|
||||
<p>Represents a counter metric type.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-DELTA_COUNTER">
|
||||
<td><code>DELTA_COUNTER</code></td>
|
||||
<td>
|
||||
<p>Represents a delta counter metric type.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-MetricInfo-Type-HISTOGRAM">
|
||||
<td><code>HISTOGRAM</code></td>
|
||||
<td>
|
||||
<p>Represents a histogram metric type.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-WavefrontDirect">Params.WavefrontDirect</h2>
|
||||
<section>
|
||||
<p>Describes Wavefront Server credentials.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-WavefrontDirect-server">
|
||||
<td><code>server</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The Wavefront server URL. Ex: https://mydomain.wavefront.com</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-WavefrontDirect-token">
|
||||
<td><code>token</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The Wavefront API token.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Params-WavefrontProxy">Params.WavefrontProxy</h2>
|
||||
<section>
|
||||
<p>Describes Wavefront Proxy credentials.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-WavefrontProxy-address">
|
||||
<td><code>address</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The wavefront proxy address. Ex: 192.168.99.100:2878</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,60 +0,0 @@
|
|||
---
|
||||
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: Zipkin
|
||||
description: Adapter to deliver tracing data to Zipkin.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/zipkin.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
supported_templates: tracespan
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>zipkin</code> adapter enables Istio to deliver tracing data to the
|
||||
<a href="https://zipkin.io/">Zipkin</a> tracing backend.</p>
|
||||
|
||||
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/tracespan/">tracespan template</a>.</p>
|
||||
|
||||
<h2 id="Params">Params</h2>
|
||||
<section>
|
||||
<p>Configuration format for the <code>zipkin</code> adapter.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Params-url">
|
||||
<td><code>url</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>URL of Zipkin HTTP endpoint.</p>
|
||||
|
||||
<p>Required.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Params-sample_probability">
|
||||
<td><code>sampleProbability</code></td>
|
||||
<td><code>double</code></td>
|
||||
<td>
|
||||
<p>Uniform probability that a trace will be sampled.
|
||||
Defaults to 0 (sampling disabled) if unset.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,113 +0,0 @@
|
|||
---
|
||||
title: 属性词汇
|
||||
description: 描述用于策略和控制的基本属性词汇表。
|
||||
weight: 10
|
||||
aliases:
|
||||
- /zh/docs/reference/config/mixer/attribute-vocabulary.html
|
||||
- /zh/docs/reference/config/mixer/aspects/attributes.html
|
||||
---
|
||||
|
||||
属性是整个 Istio 使用的核心概念。
|
||||
可以在[这里](/zh/docs/reference/config/policy-and-telemetry/mixer-overview/#attributes)找到属性是什么和用于何处的描述。
|
||||
|
||||
每个给定的 Istio 部署有固定的能够理解的属性词汇。
|
||||
这个特定的词汇由当前部署涉及到的所有属性生产者一起来决定。
|
||||
Istio 中除了 Envoy 是首要的属性生产者外，Mixer 和服务也会产生属性。
|
||||
|
||||
下面这个表格展示一组规范属性集合和他们各自的类型。
|
||||
大多数 Istio 部署都会包含产生这些属性的代理（Envoy 或 Mixer 适配器）。
|
||||
|
||||
| 名称 | 类型 | 描述 | Kubernetes 示例 |
|
||||
|------|------|-------------|--------------------|
|
||||
| `source.uid` | string | 源工作负载实例特定于平台的唯一标识符。 | `kubernetes://redis-master-2353460263-1ecey.my-namespace` |
|
||||
| `source.ip` | ip_address | 源工作负载实例的 IP 地址。 | `10.0.0.117` |
|
||||
| `source.labels` | map[string, string] | 源实例附带的键值对 map 。 | version => v1 |
|
||||
| `source.name` | string | 源工作负载实例的名称。 | `redis-master-2353460263-1ecey` |
|
||||
| `source.namespace` | string | 源工作负载实例的命名空间。 | `my-namespace` |
|
||||
| `source.principal` | string | 源工作负载的运行基于的授权机构。 | `service-account-foo` |
|
||||
| `source.owner` | string | 控制源工作负载实例的工作负载。 | `kubernetes://apis/extensions/v1beta1/namespaces/istio-system/deployments/istio-policy` |
|
||||
| `source.workload.uid` | string | 源工作负载的唯一标识符。 | `istio://istio-system/workloads/istio-policy` |
|
||||
| `source.workload.name` | string | 源工作负载的名称。 | `istio-policy` |
|
||||
| `source.workload.namespace` | string | 源工作负载的命名空间。 | `istio-system` |
|
||||
| `destination.uid` | string | 服务器实例特定于平台的唯一标识符。 | `kubernetes://my-svc-234443-5sffe.my-namespace` |
|
||||
| `destination.ip` | ip_address | 服务器 IP 地址。 | `10.0.0.104` |
|
||||
| `destination.port` | int64 | 服务器 IP 地址上的接收端口。 | `8080` |
|
||||
| `destination.labels` | map[string, string] | 服务器实例附带的键值对 map 。 | version => v2 |
|
||||
| `destination.name` | string | 目标工作负载实例的名称。 | `istio-telemetry-2359333` |
|
||||
| `destination.namespace` | string | 目标工作负载实例的命名空间。 | `istio-system` |
|
||||
| `destination.principal` | string | 目标工作负载运行所基于的授权机构。 | `service-account` |
|
||||
| `destination.owner` | string | 控制目标工作负载实例的工作负载。 | `kubernetes://apis/extensions/v1beta1/namespaces/istio-system/deployments/istio-telemetry` |
|
||||
| `destination.workload.uid` | string | 目标工作负载的唯一标识符。 | `istio://istio-system/workloads/istio-telemetry` |
|
||||
| `destination.workload.name` | string | 目标工作负载的名称。 | `istio-telemetry` |
|
||||
| `destination.workload.namespace`| string | 目标工作负载的命名空间。 | `istio-system` |
|
||||
| `destination.container.name` | string | 目标工作负载实例的容器名称。 | `mixer` |
|
||||
| `destination.container.image` | string |目标工作负载实例的容器镜像。 | `gcr.io/istio-testing/mixer:0.8.0` |
|
||||
| `destination.service.host` | string | 目标主机地址。 | `istio-telemetry.istio-system.svc.cluster.local` |
|
||||
| `destination.service.uid` | string | 目标服务的唯一标识符。 | `istio://istio-system/services/istio-telemetry` |
|
||||
| `destination.service.name` | string | 目标服务的名称。 | `istio-telemetry` |
|
||||
| `destination.service.namespace` | string | 目标服务的命名空间。 | `istio-system` |
|
||||
| `origin.ip` | ip_address | 代理客户端的 IP 地址, e.g. ingress 代理的来源。 | `127.0.0.1` |
|
||||
| `request.headers` | map[string, string] | HTTP 请求头，key使用小写。以gRPC为例，此处为其元数据。 | |
|
||||
| `request.id` | string | 从统计角度上拥有低碰撞概率的请求 ID。 | |
|
||||
| `request.path` | string | 包括 query string 的 HTTP URL 路径。 | |
|
||||
| `request.url_path` | string | 部分 HTTP URL 路径，除去了 query string。 | |
|
||||
| `request.query_params` | map[string, string] | 从 HTTP URL 提取的 query 参数的 map。 | |
|
||||
| `request.host` | string | HTTP/1.x 请求头中的 Host 字段或者是 HTTP/2 请求头中的 authority 字段。 | `redis-master:3337` |
|
||||
| `request.method` | string | HTTP 请求方法。 | |
|
||||
| `request.reason` | string | 审计系统用到的请求理由。 | |
|
||||
| `request.referer` | string | HTTP 请求头中的 referer 字段。 | |
|
||||
| `request.scheme` | string | 请求的 URI Scheme。 | |
|
||||
| `request.size` | int64 | 以字节为单位的请求大小。对于 HTTP 来说，等于 Content-Length 的值。 | |
|
||||
| `request.total_size` | int64 | 以字节为单位的整个 HTTP 请求的大小，包括请求头、消息体和结束符。 | |
|
||||
| `request.time` | timestamp | 目标收到请求时的时间戳。相当于 Firebase 里的 "now"。 | |
|
||||
| `request.useragent` | string | HTTP 请求头中的 User-Agent 字段。 | |
|
||||
| `response.headers` | map[string, string] | HTTP 响应头，key 使用小写。 | |
|
||||
| `response.size` | int64 | 以字节为单位的响应消息体大小。 | |
|
||||
| `response.total_size` | int64 | 以字节为单位的整个 HTTP 响应的大小，包括响应头和消息体。 | |
|
||||
| `response.time` | timestamp | 目标产生响应时的时间戳。 | |
|
||||
| `response.duration` | duration | 生成响应总共花费的时间。 | |
|
||||
| `response.code` | int64 | HTTP 响应的状态码。 | |
|
||||
| `response.grpc_status` | string | gRPC 响应的状态码。 | |
|
||||
| `response.grpc_message` | string | gRPC 响应的状态消息。 | |
|
||||
| `connection.id` | string | 从统计角度上拥有低碰撞概率的 TCP 连接 ID。 | |
|
||||
| `connection.event` | string | TCP 连接的状态，它的值域范围为：“open”、“continue” 和 “close”。 | |
|
||||
| `connection.received.bytes` | int64 | 对于一条连接，在最后一次 Report() 之后，目标服务在此连接上接收到的字节数。 | |
|
||||
| `connection.received.bytes_total` | int64 | 在连接的生命周期中，目标服务接收到的全部字节数。 | |
|
||||
| `connection.sent.bytes` | int64 | 对于一条连接，在最后一次 Report() 之后，目标服务在此连接上发送的字节数。 | |
|
||||
| `connection.sent.bytes_total` | int64 | 在连接的生命周期中，目标服务发送的全部字节数。 | |
|
||||
| `connection.duration` | duration | 连接打开的总时间量。 | |
|
||||
| `connection.mtls` | boolean | 标示接收到的请求是否来自于启用了 mutual TLS 的下游连接。 | |
|
||||
| `connection.requested_server_name` | string | 连接请求的服务器名 （ SNI ）。 | |
|
||||
| `context.protocol` | string | 请求或者被代理的连接的协议。 | `tcp` |
|
||||
| `context.time` | timestamp | Mixer 操作的时间戳。 | |
|
||||
| `context.reporter.kind` | string | 将报告的属性集上下文化。 对于来自 sidecars 的服务器端调用设置为 `inbound`，对于来自 sidecars 和网关的客户端调用设置为 `outbound` 。 | `inbound` |
|
||||
| `context.reporter.uid` | string | 属性报告者特定于平台的唯一标识符。 | `kubernetes://my-svc-234443-5sffe.my-namespace` |
|
||||
| `context.proxy_error_code` | string | 有关来自代理的响应或连接的其他详细信息。 如果是 Envoy, 请参阅 [Envoy Access Log](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage/#config-access-log-format-response-flags) 的 `%RESPONSE_FLAGS%` 查看更多信息 | `UH` |
|
||||
| `api.service` | string | 公开的服务名。和处于网格中的服务身份不同，它反映了暴露给客户端的服务名称。 | `my-svc.com` |
|
||||
| `api.version` | string | API 版本。 | `v1alpha1` |
|
||||
| `api.operation` | string | 用于辨别操作的唯一字符串。在特定的 <service, version> 描述的所有操作中，这个 ID 是唯一的。 | `getPetsById` |
|
||||
| `api.protocol` | string | API 调用的协议类型。主要用于监控和分析。注意这是暴露给客户端的前端协议，不是后端服务实现的协议。 | `http`, `https`, or `grpc` |
|
||||
| `request.auth.principal` | string | 请求的经过身份验证的主体。这是一个用“ / ”把 JWT 中的发行者（ `iss` ）和主题（ `sub` ）声明连接起来的字符串，其中主题的值是被 URL 编码的。此属性可能来自 Istio 身份验证策略中的对等体或源，具体取决于 Istio 身份验证策略中定义的绑定规则。 | `issuer@foo.com/sub@foo.com` |
|
||||
| `request.auth.audiences` | string | 此身份验证信息的目标受众。此值应反映 JWT 中的受众（ `aud` ）声明。 | `aud1` |
|
||||
| `request.auth.presenter` | string | 授权证书的出示人。此值应反映 JWT 或 OAuth2 客户端 ID 中的可选授权演示者（`azp`）声明。 | 123456789012.my-svc.com |
|
||||
| `request.auth.claims` | map[string, string] | 原始 JWT 中所有的的字符串声明。 | `iss`: `issuer@foo.com`, `sub`: `sub@foo.com`, `aud`: `aud1` |
|
||||
| `request.api_key` | string | 用于请求的 API key 。 | abcde12345 |
|
||||
| `check.error_code` | int64 | Mixer Check 调用的[错误码](https://github.com/google/protobuf/blob/master/src/google/protobuf/stubs/status.h) 。 | 5 |
|
||||
| `check.error_message` | string | Mixer Check 调用的错误消息。 | Could not find the resource |
|
||||
| `check.cache_hit` | boolean | 标示 Mixer check 调用是否命中本地缓存。 | |
|
||||
| `quota.cache_hit` | boolean | 标示 Mixer 限额调用是否命中本地缓存。 | |
|
||||
|
||||
## 时间戳和持续时间属性格式
|
||||
|
||||
时间戳属性以 RFC 3339 格式表示。
|
||||
应用 timestamp 属性时，可以使用 [CEXL](/zh/docs/reference/config/policy-and-telemetry/expression-language/)
|
||||
中定义的 `timestamp` 函数将 RFC 3339 格式的文本时间戳转换为 `TIMESTAMP` 类型，
|
||||
例如：`request.time | timestamp("2018-01-01T22:08:41+00:00")`, `response.time > timestamp("2020-02-29T00:00:00-08:00")`。
|
||||
|
||||
持续时间属性表示时间量，表示为一系列十进制数，其中可选的小数部分用句点表示，以及单位值。
|
||||
可能的单位值是纳秒 `ns`、微秒 `us`（或 `μs`）、毫秒 `ms`、秒 `s`、分钟 `m`、小时 `h`。例如：
|
||||
|
||||
* `1ms` 表示 1 毫秒
|
||||
* `2.3s` 表示 2.3 秒
|
||||
* `4m` 表示 4 分钟
|
||||
* `5h10m` 表示 5 小时 10 分钟
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
---
|
||||
title: 表达式语言
|
||||
description: Mixer 配置表达式语言手册。
|
||||
weight: 20
|
||||
aliases:
|
||||
- /zh/docs/reference/config/mixer/expression-language.html
|
||||
---
|
||||
|
||||
这篇文档描述了怎样使用 Mixer 配置表达式语言(CEXL)。
|
||||
|
||||
## 底层{#background}
|
||||
|
||||
Mixer 配置使用了一种表达式语言(CEXL) 去描述 match expressions 以及 [mapping expressions](/zh/docs/reference/config/policy-and-telemetry/mixer-overview/#attribute-expressions)。
|
||||
CEXL 表达式为有类型的[值](https://github.com/istio/api/blob/{{<source_branch_name>}}/policy/v1beta1/value_type.proto)映射了一组带类型的[属性](/zh/docs/reference/config/policy-and-telemetry/mixer-overview/#attributes)和常量。
|
||||
|
||||
## 语法{#syntax}
|
||||
|
||||
CEXL 使用 **[Go 表达式](https://golang.org/ref/spec#Expressions)**的一个子集作为语法。
|
||||
CEXL 实现了一组 Go 操作符来限制这部分有限的 Go 表达式。
|
||||
CEXL 同样支持任意的括号。
|
||||
|
||||
## 函数{#functions}
|
||||
|
||||
CEXL 支持如下函数。
|
||||
|
||||
|操作符/函数 |定义 |例子 | 描述|
|
||||
|------------------|-----------|--------|------------|
|
||||
|`==` |相等 |`request.size == 200`
|
||||
|`!=` |不等 |`request.auth.principal != "admin"`
|
||||
|<code>||</code> |逻辑或 | `(request.size == 200)` <code>||</code> `(request.auth.principal == "admin")`
|
||||
|`&&` |逻辑与 | `(request.size == 200) && (request.auth.principal == "admin")`
|
||||
|`[ ]` |Map 取值 | `request.headers["x-request-id"]`
|
||||
|`+` |加 | `request.host + request.path`
|
||||
|`>` |大于 | `response.code > 200`
|
||||
|`>=` |大于等于 | `request.size >= 100`
|
||||
|`<` |小于 | `response.code < 500`
|
||||
|`<=` |小于等于 | `request.size <= 100`
|
||||
|<code>|</code> | 取首个非空元素 | `source.labels["app"]` <code>|</code> `source.labels["svc"]` <code>|</code> `"unknown"`
|
||||
|`match` | 通配符匹配 |`match(destination.service, "*.ns1.svc.cluster.local")` | 以 `*` 的位置匹配前缀或后缀
|
||||
|`email` | 将文本类型的 e-mail 转换为 `EMAIL_ADDRESS` 类型 | `email("awesome@istio.io")` | 使用 `email` 函数创建一个 `EMAIL_ADDRESS` 字面量。
|
||||
|`dnsName` | 将文本类型的 DNS 转换为 `DNS_NAME` 类型 | `dnsName("www.istio.io")` | 使用 `dnsName` 函数创建一个 `DNS_NAME` 字面量。
|
||||
|`ip` | 将文本类型的 IPv4 地址转换为 `IP_ADDRESS` type | `source.ip == ip("10.11.12.13")` | 使用 `ip` 函数创建一个 `IP_ADDRESS` 字面量。
|
||||
|`timestamp` | 将文本类型的 RFC 3339 时间戳格式转换为 `TIMESTAMP` 类型 | `timestamp("2015-01-02T15:04:35Z")` | 使用 `timestamp` 函数创建一个 `TIMESTAMP` 字面量。
|
||||
|`uri` | 将文本类型的 URI 转换为 `URI` 类型 | `uri("http://istio.io")` | 使用 `uri` 函数创建一个 `URI` 字面量。
|
||||
|`.matches` | 正则表达式匹配 | `"svc.*".matches(destination.service)` | 通过正则表达式 `"svc.*"` 匹配 `destination.service`。
|
||||
|`.startsWith` | 字符串前缀匹配 | `destination.service.startsWith("acme")` | 检查 `destination.service` 的值是否开始于 `"acme"`。
|
||||
|`.endsWith` | 字符串后缀匹配 | `destination.service.endsWith("acme")` | 检查 `destination.service` 的值是否结束于 `"acme"`。
|
||||
|`emptyStringMap` | 创建一个空的 string map | `request.headers` <code>|</code> `emptyStringMap()`| 为 `request.headers` 使用 `emptyStringMap` 去创建一个空的 string map 作为默认值。
|
||||
|`conditional` | 三元运算 | `conditional((context.reporter.kind` <code>|</code> `"inbound") == "outbound", "client", "server")` | report kind 是 `outbound` 时返回 `"client"`，否则返回 `"server"`。
|
||||
|`toLower` | 将字符串转换成小写 | `toLower("User-Agent")` | 返回 `"user-agent"`
|
||||
|`size` | 字符串的长度 | `size("admin")` | 返回 5
|
||||
|
||||
## 类型检查{#type-checking}
|
||||
|
||||
CEXL 变量是[属性词汇表](/zh/docs/reference/config/policy-and-telemetry/attribute-vocabulary/)中的某个属性，常量是隐式类型，函数是显式类型。
|
||||
|
||||
Mixer 验证 CEXL 表达式的语法并在配置验证期间解析为一个类型。
|
||||
选择器必须解析为 boolean 类型且 mapping expressions 必须解析为它所映射的类型。当选择器解析为 boolean 类型失败或 mapping expression 解析为不正确的类型时配置验证将失败。
|
||||
|
||||
比如，如果一个操作人员指定了一个 *string* 标签为 `request.size | 200`，这个表达式解析为 integer 类型从而验证将失败。
|
||||
|
||||
## 属性缺失{#missing-attributes}
|
||||
|
||||
如果表达式使用了一个在请求处理期间不可用的属性，则表达式将执行失败。如果属性可能缺失，请使用`|`运算符提供默认值。
|
||||
|
||||
比如，如果表达式 `request.auth.principal` 属性是缺失的则 `request.auth.principal == "user1"` 将执行失败。`|` (或) 运算符可以处理这个问题： `(request.auth.principal | "nobody" ) == "user1"`。
|
||||
|
||||
## 例子{#examples}
|
||||
|
||||
|表达式 |返回类型 |描述|
|
||||
|-----------|------------|-----------|
|
||||
|`request.size` <code>| 200</code> | **int** | `request.size` 在可用时返回其值，否则返回 200。
|
||||
|`request.headers["x-forwarded-host"] == "myhost"`| **boolean**
|
||||
|`(request.headers["x-user-group"] == "admin")` <code>||</code> `(request.auth.principal == "admin")`| **boolean**| user 是 admin 或属于 admin 组时，结果为 true。
|
||||
|`(request.auth.principal` <code>|</code> `"nobody" ) == "user1"` | **boolean** | 如果 `request.auth.principal` 是 "user1" 则结果是 true，且 `request.auth.principal` 属性缺失时不会报错。
|
||||
|`source.labels["app"]=="reviews" && source.labels["version"]=="v3"`| **boolean** | 如果 app label 是 reviews 且 version label 是 v3 则结果是 true，否则是 false。
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -1,141 +0,0 @@
|
|||
---
|
||||
title: 默认监控指标
|
||||
description: 通过 Mixer 从 Istio 导出的默认监控指标。
|
||||
weight: 50
|
||||
---
|
||||
|
||||
此页面展示使用初始配置时，Istio 收集的监控指标（metrics）的详细信息。这些指标是内置的，但您可以随时通过更改配置来添加和删除它们。您可以在[这个文件]({{<github_file>}}/manifests/UPDATING-CHARTS.md)的 "kind: metric” 小节中找到它们。它使用了 [metric 模板](/zh/docs/reference/config/policy-and-telemetry/templates/metric/)来定义指标。
|
||||
|
||||
我们将首先描述监控指标，然后描述每个指标的标签。
|
||||
|
||||
## 监控指标{#metrics}
|
||||
|
||||
Istio 为 HTTP、HTTP/2 和 GRPC 流量创建了下列指标：
|
||||
|
||||
* **Request Count** （`istio_requests_total`）：这是一个 `COUNTER`，随着 Istio 代理处理的每个请求递增。
|
||||
|
||||
* **Request Duration** （`istio_request_duration_seconds`）：这是一个 `DISTRIBUTION`，它测量请求的持续时间。
|
||||
|
||||
* **Request Size** （`istio_request_bytes`）：这是一个 `DISTRIBUTION`，它测量 HTTP 请求的 body 大小。
|
||||
|
||||
* **Response Size**（`istio_response_bytes`）：这是一个 `DISTRIBUTION`，它测量 HTTP 响应 body 的大小。
|
||||
|
||||
对于 TCP 流量，Istio 创建了下列指标：
|
||||
|
||||
* **Tcp Byte Sent**（`istio_tcp_sent_bytes_total`）：这是一个 `COUNTER`，它测量了一条 TCP 连接响应期间发送的总字节数，由服务端代理测量。
|
||||
|
||||
* **Tcp Byte Received**（`istio_tcp_received_bytes_total`）：这是一个 `COUNTER`，它测量了一条 TCP 连接请求期间接收的总字节数，由服务端代理测量。
|
||||
|
||||
* **Tcp Connections Opened**（`istio_tcp_connections_opened_total`）：这是一个 `COUNTER`，它测量已经打开的 TCP 连接总数。
|
||||
|
||||
* **Tcp Connections Closed**（`istio_tcp_connections_closed_total`）：这是一个 `COUNTER`，它测量已经关闭的 TCP 连接总数。
|
||||
|
||||
## 标签{#labels}
|
||||
|
||||
* **Reporter**：这是请求报告者的标识符。报告从服务端 Istio 代理而来时设置为 `destination`，从客户端 Istio 代理而来时设置为 `source`。
|
||||
|
||||
{{< text yaml >}}
|
||||
reporter: conditional((context.reporter.kind | "inbound") == "outbound", "source", "destination")
|
||||
{{< /text >}}
|
||||
|
||||
* **Source Workload**：源工作负载所属控制器的名称。
|
||||
|
||||
{{< text yaml >}}
|
||||
source_workload: source.workload.name | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Source Workload Namespace**：源工作负载所在的命名空间。
|
||||
|
||||
{{< text yaml >}}
|
||||
source_workload_namespace: source.workload.namespace | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Source Principal**：在使用 Peer 身份验证的情况下，流量来源的认证主体。
|
||||
|
||||
{{< text yaml >}}
|
||||
source_principal: source.principal | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Source App**：源工作负载的 `app` 标签。
|
||||
|
||||
{{< text yaml >}}
|
||||
source_app: source.labels["app"] | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Source Version**：标识了源工作负载的版本。
|
||||
|
||||
{{< text yaml >}}
|
||||
source_version: source.labels["version"] | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Destination Workload**：标识了目的工作负载的名称。
|
||||
|
||||
{{< text yaml >}}
|
||||
destination_workload: destination.workload.name | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Destination Workload Namespace**：标识了目的工作负载所在的命名空间。
|
||||
|
||||
{{< text yaml >}}
|
||||
destination_workload_namespace: destination.workload.namespace | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Destination Principal**：在使用 Peer 身份验证的情况下，流量目标的认证主体。
|
||||
|
||||
{{< text yaml >}}
|
||||
destination_principal: destination.principal | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Destination App**：标识了目的应用（基于目的工作负载的 `app` 标签）。
|
||||
|
||||
{{< text yaml >}}
|
||||
destination_app: destination.labels["app"] | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Destination Version**：标识了目的工作负载的版本。
|
||||
|
||||
{{< text yaml >}}
|
||||
destination_version: destination.labels["version"] | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Destination Service**：标识了负责处理传入请求的目标服务。例如：`details.default.svc.cluster.local`。
|
||||
|
||||
{{< text yaml >}}
|
||||
destination_service: destination.service.host | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Destination Service Name**：标识了目标服务的名称。例如：“details”。
|
||||
|
||||
{{< text yaml >}}
|
||||
destination_service_name: destination.service.name | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Destination Service Namespace**：标识了目标服务所在的命名空间。
|
||||
|
||||
{{< text yaml >}}
|
||||
destination_service_namespace: destination.service.namespace | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Request Protocol**：标识了请求协议。当提供了 API 协议时设置为该值，否则设置为请求或连接协议。
|
||||
|
||||
{{< text yaml >}}
|
||||
request_protocol: api.protocol | context.protocol | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
* **Response Code**：标识了请求的响应码。该标签仅在 HTTP 指标中存在。
|
||||
|
||||
{{< text yaml >}}
|
||||
response_code: response.code | 200
|
||||
{{< /text >}}
|
||||
|
||||
* **Connection Security Policy**：这标识了请求的服务身份验证策略。当 Istio 启用通信安全功能，并且报告来自目的地时，它被设置为 `mutual_tls`。如果报告来自源时，因为无法判断安全策略，这个指标的值会被设置为 `unknown`。
|
||||
|
||||
{{< text yaml >}}
|
||||
connection_security_policy: conditional((context.reporter.kind | "inbound") == "outbound", "unknown", conditional(connection.mtls | false, "mutual_tls", "none"))
|
||||
{{< /text >}}
|
||||
|
||||
* **Response Flags**: 来自代理服务器，包含了响应或者连接的额外细节。如果是 Envoy 代理，可以参考 [Envoy 访问日志](https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage#config-access-log-format-response-flags)中的 `%RESPONSE_FLAGS%` 相关说明。
|
||||
|
||||
{{< text yaml >}}
|
||||
response_flags: context.proxy_error_code | "-"
|
||||
{{< /text >}}
|
||||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 22 KiB |
|
|
@ -1,225 +0,0 @@
|
|||
---
|
||||
title: Mixer 配置模型
|
||||
description: 描述 Istio 策略执行和遥测机制的配置模型。
|
||||
weight: 5
|
||||
keywords: [policies,telemetry,control,config]
|
||||
aliases:
|
||||
- /zh/docs/concepts/policy-and-control/mixer.html
|
||||
- /zh/docs/concepts/policy-and-control/mixer-config.html
|
||||
- /zh/docs/concepts/policy-and-control/attributes.html
|
||||
- /zh/docs/concepts/policies-and-telemetry/overview/
|
||||
- /zh/docs/concepts/policies-and-telemetry/config/
|
||||
---
|
||||
|
||||
Istio 提供了一种灵活的模型来强制执行授权策略并为网格中的服务收集遥测数据。
|
||||
|
||||
基础架构后端旨在提供用于构建服务的支持功能。它们包括访问控制系统，遥测捕获系统，配额执行系统，计费系统等。传统上，服务直接与这些后端系统集成，进行强耦合，并引入特定的语义和用法选项。
|
||||
|
||||
Istio 提供了统一抽象，使 Istio 可以与一组开放式基础架构后端进行交互。这样做是为了向操作员提供丰富而深入的控制，同时又不给服务开发人员带来负担。Istio 旨在更改各层之间的边界，以降低系统复杂性，从服务代码中消除策略逻辑并将控制权交给操作者。
|
||||
|
||||
Mixer 是 Istio 的组件，负责提供策略控制和遥测收集：
|
||||
|
||||
{{< image width="55%" link="./topology-without-cache.svg" caption="Mixer Topology" >}}
|
||||
|
||||
在每个请求执行前提条件检查之前，以及在每个请求报告遥测之后，Envoy sidecar 都会在逻辑上调用 Mixer。
|
||||
Sidecar 具有本地缓存，因此大部分的前提检查可以在缓存中执行。此外，sidecar 缓冲传出遥测，使其较少的调用 Mixer。
|
||||
|
||||
总体而言，Mixer 提供：
|
||||
|
||||
* **Backend Abstraction**。Mixer 将 Istio 的其余部分和各个基础架构后端的实现细节隔离开来。
|
||||
|
||||
* **Intermediation**。Mixer 使操作员可以对网格和基础架构后端之间的所有交互进行精细控制。
|
||||
|
||||
策略实施和遥测收集完全由配置驱动。默认情况下，策略检查是禁用的，从而避免了需要通过 Mixer 策略组件的情况。有关更多信息，请参考[安装选项](/zh/docs/reference/config/installation-options/)。
|
||||
|
||||
## 适配器{#adapters}
|
||||
|
||||
Mixer 是高度模块化和可扩展的组件。它的主要功能之一是抽象出不同的策略和遥测后端系统的细节，
|
||||
使 Istio 的其余部分可以不关注这些后端。
|
||||
|
||||
Mixer 处理不同基础架构后端的灵活性来自其通用插件模型。
|
||||
每个插件都被称为 *适配器* ，它们允许 Mixer 与提供基础功能（例如日志记录、监视、配额、ACL 检查等）的不同基础架构后端进行交互。运行时使用的适配器的确切集合是通过配置确定的，可以轻松扩展以针对新的或定制的基础架构后端。
|
||||
|
||||
{{< image width="80%" link="./adapters.svg"
|
||||
alt="Showing Mixer with adapters."
|
||||
caption="Mixer and its Adapters"
|
||||
>}}
|
||||
|
||||
了解有关[适配器支持](/zh/docs/reference/config/policy-and-telemetry/adapters/)的更多信息。
|
||||
|
||||
## 属性{#attributes}
|
||||
|
||||
属性是 Istio 策略和遥测功能的基本概念。
|
||||
属性是一小部分数据，用来描述特定服务请求或请求所需环境的单一特性。例如，属性可以指定特定请求的大小、操作的响应代码、请求来自的 IP 地址等。
|
||||
|
||||
每个属性都有一个名称和一个类型。类型定义属性保存的数据类型。例如，具有 `STRING` 类型的属性代表它有一个文本值，或者具有 `INT64` 类型的属性表示它具有 64 位整数值。
|
||||
|
||||
以下是一些示例属性及其关联值：
|
||||
|
||||
{{< text plain >}}
|
||||
request.path: xyz/abc
|
||||
request.size: 234
|
||||
request.time: 12:34:56.789 04/17/2017
|
||||
source.ip: [192 168 0 1]
|
||||
destination.service.name: example
|
||||
{{< /text >}}
|
||||
|
||||
Mixer 本质上是一种属性处理器。Envoy sidecar 为每个请求调用 Mixer，为 Mixer 提供一组属性，描述请求和请求所需环境。根据其配置和给予的特定属性集，Mixer 生成对各种基础架构后端的调用。
|
||||
|
||||
{{< image width="60%" link="./machine.svg" caption="Attribute Machine" >}}
|
||||
|
||||
### 属性词汇表{#attribute-vocabulary}
|
||||
|
||||
给定的 Istio deployment 具有它了解的固定属性词汇表。该特定词汇表由 deployment 中使用的一组属性生成器确定。尽管专用的 Mixer 适配器也可以生成属性，但 Istio 中主要的属性生成器是 Envoy。
|
||||
|
||||
了解有关 [Istio 中大多数部署可用的通用基准属性集](/zh/docs/reference/config/policy-and-telemetry/attribute-vocabulary/)的更多信息。
|
||||
|
||||
### 属性表达式{#attribute-expressions}
|
||||
|
||||
当配置[实例](#instances)时需要使用使用属性表达式。
|
||||
这是一个使用表达式的示例：
|
||||
|
||||
{{< text yaml >}}
|
||||
destination_service: destination.service.host
|
||||
response_code: response.code
|
||||
destination_version: destination.labels["version"] | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
冒号右侧的序列是属性表达的最简单形式。前两个仅由属性名称组成。`response_code` 标签由 `response.code` 属性分配值。
|
||||
|
||||
这是一个条件表达式的示例：
|
||||
|
||||
{{< text yaml >}}
|
||||
destination_version: destination.labels["version"] | "unknown"
|
||||
{{< /text >}}
|
||||
|
||||
通过上述操作，`destination_version` 标签被分配的值为 `destination.labels ["version"]`。但是，如果属性不存在，将使用 `"unknown"` 值。
|
||||
|
||||
有关更多信息，请参阅[属性表达式](/zh/docs/reference/config/policy-and-telemetry/expression-language/)页面。
|
||||
|
||||
## 配置模型{#configuration-model}
|
||||
|
||||
Istio 的策略和遥测功能通过通用模型进行配置，该模型旨在使操作员可以控制授权策略和遥测收集的各个方面。我们关注于保持模型简单，同时又可以按比例控制 Istio 的许多功能。
|
||||
|
||||
控制策略和遥测功能涉及配置三种类型的资源：
|
||||
|
||||
* 配置一组 *handlers* ，用来确定正在使用的适配器集及其运行方式。如 handler 配置的示例：为 Statsd 后端提供带有 IP 地址的 `statsd` 适配器。
|
||||
|
||||
* 配置一组 *instances* ，用来描述如何将请求属性映射到适配器输入中。
|
||||
Instances 代表一个或多个适配器将在其上操作的数据块。例如。操作员可以从如 `destination.service.host` 和 `response.code` 属性中生成 `requestcount` 指标实例。
|
||||
|
||||
* 配置一组 *rules* ，用来描述何时调用特定的适配器以及给定某个 instance。
|
||||
Rules 由 *match* 表达式和 *actions* 组成。该匹配表达式控制何时调用适配器，而 action 确定提供适配器的实例集。例如，rule 可能会将生成的 `requestcount` 指标实例发送到 `statsd` 适配器。
|
||||
|
||||
配置是基于 *adapters* 和 *templates* ：
|
||||
|
||||
* **Adapters** 封装了 Mixer 与特定基础架构后端交互所需的逻辑。
|
||||
|
||||
* **Templates** 定义用于指定从属性到适配器输入的请求映射的架构。
|
||||
给定的适配器可以支持任意数量的模板。
|
||||
|
||||
### Handlers{#handlers}
|
||||
|
||||
适配器封装了 Mixer 与特定的外部基础结构后端例如 [Prometheus](https://prometheus.io) 或 [Stackdriver](https://cloud.google.com/logging) 交互所需的逻辑。
|
||||
_handler_ 是负责保存适配器所需的配置状态的资源。例如，一个日志适配器可能需要日志收集后端的 IP 地址和端口。
|
||||
|
||||
这是一个示例，显示了如何为适配器创建 handler。`listchecker` 适配器对照列表检查输入值。
|
||||
如果将适配器配置为白名单，则在列表中找到输入值时，它将返回成功。
|
||||
|
||||
{{< text yaml >}}
|
||||
apiVersion: config.istio.io/v1alpha2
|
||||
kind: handler
|
||||
metadata:
|
||||
name: staticversion
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledAdapter: listchecker
|
||||
params:
|
||||
providerUrl: http://white_list_registry/
|
||||
blacklist: false
|
||||
{{< /text >}}
|
||||
|
||||
`params` 中的数据模式取决于所配置的特定适配器。
|
||||
|
||||
某些适配器实现的功能不局限于将 Mixer 连接到后端。
|
||||
例如，`prometheus` 适配器使用指标并以可配置的方式将它们整合为分布式或计数器。
|
||||
|
||||
{{< text yaml >}}
|
||||
apiVersion: config.istio.io/v1alpha2
|
||||
kind: handler
|
||||
metadata:
|
||||
name: promhandler
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledAdapter: prometheus
|
||||
params:
|
||||
metrics:
|
||||
- name: request_count
|
||||
instance_name: requestcount.instance.istio-system
|
||||
kind: COUNTER
|
||||
label_names:
|
||||
- destination_service
|
||||
- destination_version
|
||||
- response_code
|
||||
- name: request_duration
|
||||
instance_name: requestduration.instance.istio-system
|
||||
kind: DISTRIBUTION
|
||||
label_names:
|
||||
- destination_service
|
||||
- destination_version
|
||||
- response_code
|
||||
buckets:
|
||||
explicit_buckets:
|
||||
bounds: [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10]
|
||||
{{< /text >}}
|
||||
|
||||
每个适配器定义自己的特定格式的配置数据。了解更多有关[全部适配器及其特定的配置格式](/zh/docs/reference/config/policy-and-telemetry/adapters/)的信息。
|
||||
|
||||
### Instances{#instances}
|
||||
|
||||
Instance 配置指定了请求属性到适配器输入的映射。
|
||||
以下是一个指标 instance 配置的示例，用来生成 `requestduration` 指标。
|
||||
|
||||
{{< text yaml >}}
|
||||
apiVersion: config.istio.io/v1alpha2
|
||||
kind: instance
|
||||
metadata:
|
||||
name: requestduration
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledTemplate: metric
|
||||
params:
|
||||
value: response.duration | "0ms"
|
||||
dimensions:
|
||||
destination_service: destination.service.host | "unknown"
|
||||
destination_version: destination.labels["version"] | "unknown"
|
||||
response_code: response.code | 200
|
||||
monitored_resource_type: '"UNSPECIFIED"'
|
||||
{{< /text >}}
|
||||
|
||||
请注意，需要在映射中指定了处理程序配置中期望的所有情况。
|
||||
模板定义了各个实例的特定必需内容。了解更多关于[模板及其特定的配置格式](/zh/docs/reference/config/policy-and-telemetry/templates/)的信息。
|
||||
|
||||
### Rules{#rules}
|
||||
|
||||
Rules 指定何时使用特定 instance 调用特定 handler。
|
||||
考虑一个示例，如果目标服务是 `service1` 并且 `x-user` 请求标头具有特定值，您希望把 `requestduration` 指标传递给 `prometheus` 处理程序。
|
||||
|
||||
{{< text yaml >}}
|
||||
apiVersion: config.istio.io/v1alpha2
|
||||
kind: rule
|
||||
metadata:
|
||||
name: promhttp
|
||||
namespace: istio-system
|
||||
spec:
|
||||
match: destination.service.host == "service1.ns.svc.cluster.local" && request.headers["x-user"] == "user1"
|
||||
actions:
|
||||
- handler: promhandler
|
||||
instances: [ requestduration ]
|
||||
{{< /text >}}
|
||||
|
||||
Rule 包含 `match` 条件表达式和条件为 true 时要执行的 action 的列表。
|
||||
action 指定要传递给 handler 的 instance 列表。
|
||||
规则必须使用 handler 和 instance 的标准名称。
|
||||
如果 rule、handlers、instances 都在同一命名空间中,
|
||||
命名空间后缀可以从标准名称中删除，如 `promhandler` 所见。
|
||||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 82 KiB |
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 76 KiB |
|
|
@ -1,13 +0,0 @@
|
|||
---
|
||||
title: 模板
|
||||
description: Mixer 模板用于将数据发送到各个适配器。
|
||||
weight: 50
|
||||
aliases:
|
||||
- /zh/docs/reference/config/template/index.html
|
||||
---
|
||||
|
||||
## 适配器
|
||||
|
||||
下表显示了实现每个受支持模板的[适配器](/zh/docs/reference/config/policy-and-telemetry/adapters)集。
|
||||
|
||||
{{< template_table >}}
|
||||
|
|
@ -1,197 +0,0 @@
|
|||
---
|
||||
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/apigee/istio-mixer-adapter' REPO
|
||||
source_repo: https://github.com/apigee/istio-mixer-adapter
|
||||
title: Analytics
|
||||
description: The Analytics template is used to dispatch runtime telemetry to Apigee.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/analytics.html
|
||||
layout: partner-component
|
||||
generator: protoc-gen-docs
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>analytics</code> template represents a single request reported to Apigee’s analytics processing system.
|
||||
Complete Apigee documentation on the concepts and usage of this adapter is also available on the
|
||||
<a href="https://docs.apigee.com/api-platform/istio-adapter/concepts">Apigee Adapter for Istio</a> site.
|
||||
For more information and product support, please <a href="https://apigee.com/about/support/portal">contact Apigee support</a>.</p>
|
||||
|
||||
<p>Example config:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: config.istio.io/v1alpha2
|
||||
kind: analytics
|
||||
metadata:
|
||||
name: apigee
|
||||
namespace: istio-system
|
||||
spec:
|
||||
api_key: request.api_key | request.headers["x-api-key"] | ""
|
||||
api_proxy: api.service | destination.service | ""
|
||||
response_status_code: response.code | 0
|
||||
client_ip: source.ip | ip("0.0.0.0")
|
||||
request_verb: request.method | ""
|
||||
request_uri: request.path | ""
|
||||
request_path: request.path | ""
|
||||
useragent: request.useragent | ""
|
||||
client_received_start_timestamp: request.time
|
||||
client_received_end_timestamp: request.time
|
||||
target_sent_start_timestamp: request.time
|
||||
target_sent_end_timestamp: request.time
|
||||
target_received_start_timestamp: response.time
|
||||
target_received_end_timestamp: response.time
|
||||
client_sent_start_timestamp: response.time
|
||||
client_sent_end_timestamp: response.time
|
||||
api_claims: # from jwt
|
||||
json_claims: request.auth.raw_claims | ""
|
||||
</code></pre>
|
||||
|
||||
<h2 id="Template">Template</h2>
|
||||
<section>
|
||||
<p>This Template provides Istio telemetry data to the Apigee Analytics engine.
|
||||
For additional information on this adapter or support please contact anchor-prega-support@google.com.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Template-api_proxy">
|
||||
<td><code>apiProxy</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The name of the proxy (usually the Istio API or service name).</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-response_status_code">
|
||||
<td><code>responseStatusCode</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>HTTP response code</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-client_ip">
|
||||
<td><code>clientIp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#IPAddress">istio.policy.v1beta1.IPAddress</a></code></td>
|
||||
<td>
|
||||
<p>Client IP address</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-request_verb">
|
||||
<td><code>requestVerb</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>HTTP request verb</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-request_uri">
|
||||
<td><code>requestUri</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>HTTP request URI</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-request_path">
|
||||
<td><code>requestPath</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>HTTP request path</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-useragent">
|
||||
<td><code>useragent</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>HTTP user agent header</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-client_received_start_timestamp">
|
||||
<td><code>clientReceivedStartTimestamp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">istio.policy.v1beta1.TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>Timestamp of when the api_proxy started receiving the request.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-client_received_end_timestamp">
|
||||
<td><code>clientReceivedEndTimestamp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">istio.policy.v1beta1.TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>Timestamp of when the api_proxy finished receiving the request.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-client_sent_start_timestamp">
|
||||
<td><code>clientSentStartTimestamp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">istio.policy.v1beta1.TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>Timestamp of when the api_proxy started sending the request to the target.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-client_sent_end_timestamp">
|
||||
<td><code>clientSentEndTimestamp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">istio.policy.v1beta1.TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>Timestamp of when the api_proxy finished sending the request to the target.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-target_sent_start_timestamp">
|
||||
<td><code>targetSentStartTimestamp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">istio.policy.v1beta1.TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>Timestamp of when the api_proxy started request to target.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-target_sent_end_timestamp">
|
||||
<td><code>targetSentEndTimestamp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">istio.policy.v1beta1.TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>Timestamp of when the api_proxy finished sending request to target.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-target_received_start_timestamp">
|
||||
<td><code>targetReceivedStartTimestamp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">istio.policy.v1beta1.TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>Timestamp of when the api_proxy started receiving response from target.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-target_received_end_timestamp">
|
||||
<td><code>targetReceivedEndTimestamp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">istio.policy.v1beta1.TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>Timestamp of when the api_proxy finished receiving response from target.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-api_claims">
|
||||
<td><code>apiClaims</code></td>
|
||||
<td><code>map<string, string></code></td>
|
||||
<td>
|
||||
<p>The JWT claims that were used for authenticating the request (if any)
|
||||
Use subkey “json_claims” for passing all claims in as a single JSON field.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-api_key">
|
||||
<td><code>apiKey</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The API KEY that was used for authenticating the request (if any)</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,103 +0,0 @@
|
|||
---
|
||||
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: API Key
|
||||
description: A template that represents a single API key.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/apikey.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
aliases:
|
||||
- /zh/docs/reference/config/template/apikey.html
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>apikey</code> template represents a single API key, which is used for authorization checks.</p>
|
||||
|
||||
<p>Example config:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: instance
|
||||
metadata:
|
||||
name: validate-apikey
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledTemplate: apikey
|
||||
params:
|
||||
api: api.service | ""
|
||||
api_version: api.version | ""
|
||||
api_operation: api.operation | ""
|
||||
api_key: api.key | ""
|
||||
timestamp: request.time
|
||||
</code></pre>
|
||||
|
||||
<h2 id="Template">Template</h2>
|
||||
<section>
|
||||
<p>The <code>apikey</code> template represents a single API key, used to authorize API calls.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Template-api">
|
||||
<td><code>api</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The API being called (api.service).</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-api_version">
|
||||
<td><code>apiVersion</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The version of the API (api.version).</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-api_operation">
|
||||
<td><code>apiOperation</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The API operation is being called.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-api_key">
|
||||
<td><code>apiKey</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>API key used in API call.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-timestamp">
|
||||
<td><code>timestamp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>Timestamp of API call.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,211 +0,0 @@
|
|||
---
|
||||
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: Authorization
|
||||
description: A template used to represent an access control query.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/authorization.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
aliases:
|
||||
- /zh/docs/reference/config/template/authorization.html
|
||||
number_of_entries: 3
|
||||
---
|
||||
<p>The <code>authorization</code> template defines parameters for performing policy
|
||||
enforcement within Istio. It is primarily concerned with enabling Mixer</p>
|
||||
|
||||
<p>Example config:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: instance
|
||||
metadata:
|
||||
name: authinfo
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledTemplate: authorization
|
||||
params:
|
||||
subject:
|
||||
user: source.principal | request.auth.principal | ""
|
||||
groups: request.auth.claims["groups"] | ""
|
||||
properties:
|
||||
iss: request.auth.claims["iss"]
|
||||
action:
|
||||
namespace: destination.namespace | "default"
|
||||
service: destination.service.host | ""
|
||||
path: request.path | "/"
|
||||
method: request.method | "post"
|
||||
properties:
|
||||
version: destination.labels[version] | ""
|
||||
</code></pre>
|
||||
|
||||
<h2 id="Action">Action</h2>
|
||||
<section>
|
||||
<p>An action defines “how a resource is accessed”.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Action-namespace">
|
||||
<td><code>namespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Namespace the target action is taking place in.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Action-service">
|
||||
<td><code>service</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The Service the action is being taken on.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Action-method">
|
||||
<td><code>method</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>What action is being taken.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Action-path">
|
||||
<td><code>path</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>HTTP REST path within the service</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Action-properties">
|
||||
<td><code>properties</code></td>
|
||||
<td><code>map<string, <a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">Value</a>></code></td>
|
||||
<td>
|
||||
<p>Additional data about the action for use in policy.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Subject">Subject</h2>
|
||||
<section>
|
||||
<p>A subject contains a list of attributes that identify
|
||||
the caller identity.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Subject-user">
|
||||
<td><code>user</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The user name/ID that the subject represents.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Subject-groups">
|
||||
<td><code>groups</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Groups the subject belongs to depending on the authentication mechanism,
|
||||
“groups” are normally populated from JWT claim or client certificate.
|
||||
The operator can define how it is populated when creating an instance of
|
||||
the template.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Subject-properties">
|
||||
<td><code>properties</code></td>
|
||||
<td><code>map<string, <a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">Value</a>></code></td>
|
||||
<td>
|
||||
<p>Additional attributes about the subject.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Template">Template</h2>
|
||||
<section>
|
||||
<p>The <code>authorization</code> template defines parameters for performing policy
|
||||
enforcement within Istio. It is primarily concerned with enabling Mixer
|
||||
adapters to make decisions about who is allowed to do what.
|
||||
In this template, the “who” is defined in a Subject message. The “what” is
|
||||
defined in an Action message. During a Mixer Check call, these values
|
||||
will be populated based on configuration from request attributes and
|
||||
passed to individual authorization adapters to adjudicate.</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Template-subject">
|
||||
<td><code>subject</code></td>
|
||||
<td><code><a href="#Subject">Subject</a></code></td>
|
||||
<td>
|
||||
<p>A subject contains a list of attributes that identify
|
||||
the caller identity.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-action">
|
||||
<td><code>action</code></td>
|
||||
<td><code><a href="#Action">Action</a></code></td>
|
||||
<td>
|
||||
<p>An action defines “how a resource is accessed”.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
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: Check Nothing
|
||||
description: A template that carries no data, useful for testing.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/checknothing.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
aliases:
|
||||
- /zh/docs/reference/config/template/checknothing.html
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>checknothing</code> template represents an empty block of data, which can be useful
|
||||
in different testing scenarios.</p>
|
||||
|
||||
<p>Example config:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: instance
|
||||
metadata:
|
||||
name: denyrequest
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledTemplate: checknothing
|
||||
</code></pre>
|
||||
|
||||
<h2 id="Template">Template</h2>
|
||||
<section>
|
||||
<p>CheckNothing represents an empty block of data that is used for Check-capable
|
||||
adapters which don’t require any parameters. This is primarily intended for testing
|
||||
scenarios.</p>
|
||||
|
||||
</section>
|
||||
|
|
@ -1,205 +0,0 @@
|
|||
---
|
||||
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: Edge
|
||||
description: A template designed to report observed communication edges between workloads.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/edge.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>edge</code> template represents an edge in the mesh graph.</p>
|
||||
|
||||
<h2 id="Template">Template</h2>
|
||||
<section>
|
||||
<p>The <code>edge</code> template represents an edge in the mesh graph</p>
|
||||
|
||||
<p>When writing the configuration, the value for the fields associated
|
||||
with this template can either be a literal or an
|
||||
<a href="/zh/docs/reference/config/policy-and-telemetry/expression-language/">expression</a>. Please
|
||||
note that if the datatype of a field is not
|
||||
istio.mixer.adapter.model.v1beta1.Value, then the expression’s
|
||||
<a href="/zh/docs/reference/config/policy-and-telemetry/expression-language/#type-checking">inferred type</a>
|
||||
must match the datatype of the field.</p>
|
||||
|
||||
<p>Example config:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: instance
|
||||
metadata:
|
||||
name: default
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledTemplate: edge
|
||||
params:
|
||||
timestamp: request.time
|
||||
sourceUid: source.uid | "Unknown"
|
||||
sourceOwner: source.owner | "Unknown"
|
||||
sourceWorkloadName: source.workload.name | "Unknown"
|
||||
sourceWorkloadNamespace: source.workload.namespace | "Unknown"
|
||||
destinationUid: destination.uid | "Unknown"
|
||||
destinationOwner: destination.owner | "Unknown"
|
||||
destinationWorkloadName: destination.workload.name | "Unknown"
|
||||
destinationWorkloadNamespace: destination.workload.namespace | "Unknown"
|
||||
destinationServiceName: destination.service.name | "Unknown"
|
||||
destinationServiceNamespace: destination.service.namespace | "Unknown"
|
||||
apiProtocol: api.protocol | "Unknown"
|
||||
contextProtocol: context.protocol | "Unknown"
|
||||
</code></pre>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Template-timestamp">
|
||||
<td><code>timestamp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>Timestamp of the edge</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-source_workload_namespace">
|
||||
<td><code>sourceWorkloadNamespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Namespace of the source workload</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-source_workload_name">
|
||||
<td><code>sourceWorkloadName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Name of the source workload</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-source_owner">
|
||||
<td><code>sourceOwner</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Owner of the source workload (often k8s deployment)</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-source_uid">
|
||||
<td><code>sourceUid</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>UID of the source workload</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-destination_workload_namespace">
|
||||
<td><code>destinationWorkloadNamespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Namespace of the destination workload</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-destination_workload_name">
|
||||
<td><code>destinationWorkloadName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Name of the destination workload</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-destination_owner">
|
||||
<td><code>destinationOwner</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Owner of the destination workload (often k8s deployment)</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-destination_uid">
|
||||
<td><code>destinationUid</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>UID of the destination workload</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-destination_service_namespace">
|
||||
<td><code>destinationServiceNamespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Namespace of the destination Service</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-destination_service_name">
|
||||
<td><code>destinationServiceName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Name of the destination Service</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-context_protocol">
|
||||
<td><code>contextProtocol</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Protocol used for communication (http, tcp)</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-api_protocol">
|
||||
<td><code>apiProtocol</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>The protocol type of the API call (http, https, grpc)</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,391 +0,0 @@
|
|||
---
|
||||
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: Kubernetes
|
||||
description: A template that is used to control the production of Kubernetes-specific attributes.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/kubernetes.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
number_of_entries: 2
|
||||
---
|
||||
<p>The <code>kubernetes</code> template holds data that controls the production of Kubernetes-specific
|
||||
attributes.</p>
|
||||
|
||||
<p>Example config:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: kubernetes
|
||||
metadata:
|
||||
name: attributes
|
||||
namespace: istio-system
|
||||
spec:
|
||||
# Pass the required attribute data to the adapter
|
||||
source_uid: source.uid | ""
|
||||
source_ip: source.ip | ip("0.0.0.0") # default to unspecified ip addr
|
||||
destination_uid: destination.uid | ""
|
||||
destination_ip: destination.ip | ip("0.0.0.0") # default to unspecified ip addr
|
||||
attribute_bindings:
|
||||
# Fill the new attributes from the adapter produced output.
|
||||
# $out refers to an instance of OutputTemplate message
|
||||
source.ip: $out.source_pod_ip
|
||||
source.labels: $out.source_labels
|
||||
source.namespace: $out.source_namespace
|
||||
source.service: $out.source_service
|
||||
source.serviceAccount: $out.source_service_account_name
|
||||
destination.ip: $out.destination_pod_ip
|
||||
destination.labels: $out.destination_labels
|
||||
destination.namespace: $out.destination_mamespace
|
||||
destination.service: $out.destination_service
|
||||
destination.serviceAccount: $out.destination_service_account_name
|
||||
</code></pre>
|
||||
|
||||
<h2 id="OutputTemplate">OutputTemplate</h2>
|
||||
<section>
|
||||
<p>OutputTemplate refers to the output from the adapter. It is used inside the attribute_binding section of the config
|
||||
to assign values to the generated attributes using the <code>$out.<field name of the OutputTemplate></code> syntax.
|
||||
Next ID: 33</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="OutputTemplate-source_pod_uid">
|
||||
<td><code>sourcePodUid</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to the source.uid for a pod. This is for TCP use cases where the attribute is not present.
|
||||
attribute<em>bindings can refer to this field using $out.source</em>pod_uid</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-source_pod_ip">
|
||||
<td><code>sourcePodIp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#IPAddress">IPAddress</a></code></td>
|
||||
<td>
|
||||
<p>Refers to source pod ip address. attribute<em>bindings can refer to this field using $out.source</em>pod_ip</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-source_pod_name">
|
||||
<td><code>sourcePodName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to source pod name. attribute<em>bindings can refer to this field using $out.source</em>pod_name</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-source_labels">
|
||||
<td><code>sourceLabels</code></td>
|
||||
<td><code>map<string, string></code></td>
|
||||
<td>
|
||||
<p>Refers to source pod labels. attribute<em>bindings can refer to this field using $out.source</em>labels</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-source_namespace">
|
||||
<td><code>sourceNamespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to source pod namespace. attribute<em>bindings can refer to this field using $out.source</em>namespace</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-source_service_account_name">
|
||||
<td><code>sourceServiceAccountName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to source pod service account name. attribute<em>bindings can refer to this field using $out.source</em>service<em>account</em>name</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-source_host_ip">
|
||||
<td><code>sourceHostIp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#IPAddress">IPAddress</a></code></td>
|
||||
<td>
|
||||
<p>Refers to source pod host ip address. attribute<em>bindings can refer to this field using $out.source</em>host_ip</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-source_workload_uid">
|
||||
<td><code>sourceWorkloadUid</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to the Istio workload identifier for the source pod. Attribute<em>bindings can refer to this field using $out.source</em>workload_uid</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-source_workload_name">
|
||||
<td><code>sourceWorkloadName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to the Istio workload name for the source pod. Attribute<em>bindings can refer to this field using $out.source</em>workload_name</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-source_workload_namespace">
|
||||
<td><code>sourceWorkloadNamespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to the Istio workload namespace for the source pod. Attribute<em>bindings can refer to this field using $out.source</em>workload_namespace</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-source_owner">
|
||||
<td><code>sourceOwner</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to the (controlling) owner of the source pod. Attribute<em>bindings can refer to this field using $out.source</em>owner</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-destination_pod_uid">
|
||||
<td><code>destinationPodUid</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to the destination.uid for a pod. This is for TCP use cases where the attribute is not present.
|
||||
attribute<em>bindings can refer to this field using $out.destination</em>pod_uid</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-destination_pod_ip">
|
||||
<td><code>destinationPodIp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#IPAddress">IPAddress</a></code></td>
|
||||
<td>
|
||||
<p>Refers to destination pod ip address. attribute<em>bindings can refer to this field using $out.destination</em>pod_ip</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-destination_pod_name">
|
||||
<td><code>destinationPodName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to destination pod name. attribute<em>bindings can refer to this field using $out.destination</em>pod_name</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-destination_container_name">
|
||||
<td><code>destinationContainerName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to destination container name. attribute<em>bindings can refer to this field using $out.destination</em>container_name</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-destination_labels">
|
||||
<td><code>destinationLabels</code></td>
|
||||
<td><code>map<string, string></code></td>
|
||||
<td>
|
||||
<p>Refers to destination pod labels. attribute<em>bindings can refer to this field using $out.destination</em>labels</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-destination_namespace">
|
||||
<td><code>destinationNamespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to destination pod namespace. attribute<em>bindings can refer to this field using $out.destination</em>namespace</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-destination_service_account_name">
|
||||
<td><code>destinationServiceAccountName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to destination pod service account name. attribute<em>bindings can refer to this field using $out.destination</em>service<em>account</em>name</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-destination_host_ip">
|
||||
<td><code>destinationHostIp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#IPAddress">IPAddress</a></code></td>
|
||||
<td>
|
||||
<p>Refers to destination pod host ip address. attribute<em>bindings can refer to this field using $out.destination</em>host_ip</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-destination_owner">
|
||||
<td><code>destinationOwner</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to the (controlling) owner of the destination pod. Attribute<em>bindings can refer to this field using $out.destination</em>owner</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-destination_workload_uid">
|
||||
<td><code>destinationWorkloadUid</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to the Istio workload identifier for the destination pod. Attribute<em>bindings can refer to this field using $out.destination</em>workload_uid</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-destination_workload_name">
|
||||
<td><code>destinationWorkloadName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to the Istio workload name for the destination pod. Attribute<em>bindings can refer to this field using $out.destination</em>workload_name</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="OutputTemplate-destination_workload_namespace">
|
||||
<td><code>destinationWorkloadNamespace</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Refers to the Istio workload name for the destination pod. Attribute<em>bindings can refer to this field using $out.destination</em>workload_namespace</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<h2 id="Template">Template</h2>
|
||||
<section>
|
||||
<p>The <code>kubernetes</code> template represents data used to generate kubernetes-derived attributes.</p>
|
||||
|
||||
<p>The values provided controls the manner in which the kubernetesenv adapter discovers and
|
||||
generates values related to pod information.
|
||||
Next ID: 8</p>
|
||||
|
||||
<table class="message-fields">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Template-source_uid">
|
||||
<td><code>sourceUid</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Source pod’s uid. Must be of the form: “kubernetes://pod.namespace”</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-source_ip">
|
||||
<td><code>sourceIp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#IPAddress">IPAddress</a></code></td>
|
||||
<td>
|
||||
<p>Source pod’s ip.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-destination_uid">
|
||||
<td><code>destinationUid</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Destination pod’s uid. Must be of the form: “kubernetes://pod.namespace”</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-destination_ip">
|
||||
<td><code>destinationIp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#IPAddress">IPAddress</a></code></td>
|
||||
<td>
|
||||
<p>Destination pod’s ip.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-destination_port">
|
||||
<td><code>destinationPort</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>Destination container’s port number.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,61 +0,0 @@
|
|||
---
|
||||
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: List Entry
|
||||
description: A template designed to let you perform list checking operations.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/listentry.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
aliases:
|
||||
- /zh/docs/reference/config/template/listentry.html
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>listentry</code> template is designed to let you perform list check operations
|
||||
with the <a href="/zh/docs/reference/config/policy-and-telemetry/adapters/list/">list</a> adapter.</p>
|
||||
|
||||
<p>Example config:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: instance
|
||||
metadata:
|
||||
name: appversion
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledTemplate: listentry
|
||||
params:
|
||||
value: source.labels["version"]
|
||||
</code></pre>
|
||||
|
||||
<h2 id="Template">Template</h2>
|
||||
<section>
|
||||
<p>The <code>listentry</code> template is used to verify the presence/absence of a string
|
||||
within a list.</p>
|
||||
|
||||
<p>When writing the configuration, the value for the fields associated with this template can either be a
|
||||
literal or an <a href="/zh/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="/zh/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>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Template-value">
|
||||
<td><code>value</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">Value</a></code></td>
|
||||
<td>
|
||||
<p>Specifies the entry to verify in the list. This value can either be a string or an IP address.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,120 +0,0 @@
|
|||
---
|
||||
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: Log Entry
|
||||
description: A template that represents a single runtime log entry.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/logentry.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
aliases:
|
||||
- /zh/docs/reference/config/template/logentry.html
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>logentry</code> template represents an individual entry within a log.</p>
|
||||
|
||||
<p>Example config:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: instance
|
||||
metadata:
|
||||
name: accesslog
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledTemplate: logentry
|
||||
params:
|
||||
severity: '"Default"'
|
||||
timestamp: request.time
|
||||
variables:
|
||||
sourceIp: source.ip | ip("0.0.0.0")
|
||||
destinationIp: destination.ip | ip("0.0.0.0")
|
||||
sourceUser: source.principal | ""
|
||||
method: request.method | ""
|
||||
url: request.path | ""
|
||||
protocol: request.scheme | "http"
|
||||
responseCode: response.code | 0
|
||||
responseSize: response.size | 0
|
||||
requestSize: request.size | 0
|
||||
latency: response.duration | "0ms"
|
||||
monitored_resource_type: '"UNSPECIFIED"'
|
||||
</code></pre>
|
||||
|
||||
<h2 id="Template">Template</h2>
|
||||
<section>
|
||||
<p>The <code>logentry</code> template represents an individual entry within a log.</p>
|
||||
|
||||
<p>When writing the configuration, the value for the fields associated with this template can either be a
|
||||
literal or an <a href="/zh/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="/zh/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>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Template-variables">
|
||||
<td><code>variables</code></td>
|
||||
<td><code>map<string, <a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">Value</a>></code></td>
|
||||
<td>
|
||||
<p>Variables that are delivered for each log entry.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-timestamp">
|
||||
<td><code>timestamp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>Timestamp is the time value for the log entry</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-severity">
|
||||
<td><code>severity</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Severity indicates the importance of the log entry.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</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 log entry is being recorded on.
|
||||
If the logging backend supports monitored resources, these fields are used to populate that resource.
|
||||
Otherwise these fields will be ignored by the adapter.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-monitored_resource_dimensions">
|
||||
<td><code>monitoredResourceDimensions</code></td>
|
||||
<td><code>map<string, <a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">Value</a>></code></td>
|
||||
<td>
|
||||
<p>Optional. A set of expressions that will form the dimensions of the monitored resource this log entry is being
|
||||
recorded on. If the logging backend supports monitored resources, these fields are used to populate that resource.
|
||||
Otherwise these fields will be ignored by the adapter.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,103 +0,0 @@
|
|||
---
|
||||
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:
|
||||
- /zh/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="/zh/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="/zh/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>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Template-value">
|
||||
<td><code>value</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">Value</a></code></td>
|
||||
<td>
|
||||
<p>The value being reported.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-dimensions">
|
||||
<td><code>dimensions</code></td>
|
||||
<td><code>map<string, <a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">Value</a>></code></td>
|
||||
<td>
|
||||
<p>The unique identity of the particular metric to report.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</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>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-monitored_resource_dimensions">
|
||||
<td><code>monitoredResourceDimensions</code></td>
|
||||
<td><code>map<string, <a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">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>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,63 +0,0 @@
|
|||
---
|
||||
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: Quota
|
||||
description: A template that represents a quota allocation request.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/quota.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
aliases:
|
||||
- /zh/docs/reference/config/template/quota.html
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>quota</code> template represents an item for which to check quota.</p>
|
||||
|
||||
<p>Example config:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: instance
|
||||
metadata:
|
||||
name: requestcount
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledTemplate: quota
|
||||
params:
|
||||
dimensions:
|
||||
source: source.name | "unknown"
|
||||
sourceVersion: source.labels["version"] | "unknown"
|
||||
destination: destination.labels["app"] | destination.service.host | "unknown"
|
||||
destinationVersion: destination.labels["version"] | "unknown"
|
||||
</code></pre>
|
||||
|
||||
<h2 id="Template">Template</h2>
|
||||
<section>
|
||||
<p>The <code>quota</code> template represents a piece of data to check Quota for.</p>
|
||||
|
||||
<p>When writing the configuration, the value for the fields associated with this template can either be a
|
||||
literal or an <a href="/zh/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="/zh/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>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Template-dimensions">
|
||||
<td><code>dimensions</code></td>
|
||||
<td><code>map<string, <a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">Value</a>></code></td>
|
||||
<td>
|
||||
<p>The unique identity of the particular quota to manipulate.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
---
|
||||
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: Report Nothing
|
||||
description: A template that carries no data, useful for testing.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/reportnothing.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
aliases:
|
||||
- /zh/docs/reference/config/template/reportnothing.html
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>reportnothing</code> template represents an empty block of data, which can be useful
|
||||
in different testing scenarios.</p>
|
||||
|
||||
<p>Example config:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: instance
|
||||
metadata:
|
||||
name: reportrequest
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledTemplate: reportnothing
|
||||
</code></pre>
|
||||
|
||||
<h2 id="Template">Template</h2>
|
||||
<section>
|
||||
<p>ReportNothing represents an empty block of data that is used for Report-capable
|
||||
adapters which don’t require any parameters. This is primarily intended for testing
|
||||
scenarios.</p>
|
||||
|
||||
</section>
|
||||
|
|
@ -1,331 +0,0 @@
|
|||
---
|
||||
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: Trace Span
|
||||
description: A template that represents an individual span within a distributed trace.
|
||||
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/tracespan.html
|
||||
layout: protoc-gen-docs
|
||||
generator: protoc-gen-docs
|
||||
number_of_entries: 1
|
||||
---
|
||||
<p>The <code>tracespan</code> template represents an individual span within a distributed trace.</p>
|
||||
|
||||
<p>Example config:</p>
|
||||
|
||||
<pre><code class="language-yaml">apiVersion: "config.istio.io/v1alpha2"
|
||||
kind: instance
|
||||
metadata:
|
||||
name: default
|
||||
namespace: istio-system
|
||||
spec:
|
||||
compiledTemplate: tracespan
|
||||
params:
|
||||
traceId: request.headers["x-b3-traceid"]
|
||||
spanId: request.headers["x-b3-spanid"] | ""
|
||||
parentSpanId: request.headers["x-b3-parentspanid"] | ""
|
||||
spanName: request.path | "/"
|
||||
startTime: request.time
|
||||
endTime: response.time
|
||||
clientSpan: (context.reporter.kind | "inbound") == "outbound"
|
||||
rewriteClientSpanId: "false"
|
||||
spanTags:
|
||||
http.method: request.method | ""
|
||||
http.status_code: response.code | 200
|
||||
http.url: request.path | ""
|
||||
request.size: request.size | 0
|
||||
response.size: response.size | 0
|
||||
source.principal: source.principal | ""
|
||||
source.version: source.labels["version"] | ""
|
||||
</code></pre>
|
||||
|
||||
<p>See also: <a href="/zh/docs/tasks/observability/distributed-tracing/">Distributed Tracing</a>
|
||||
for information on tracing within Istio.</p>
|
||||
|
||||
<h2 id="Template">Template</h2>
|
||||
<section>
|
||||
<p>TraceSpan represents an individual span within a distributed trace.</p>
|
||||
|
||||
<p>When writing the configuration, the value for the fields associated with this template can either be a
|
||||
literal or an <a href="/zh/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="/zh/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>
|
||||
<th>Required</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr id="Template-trace_id">
|
||||
<td><code>traceId</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Trace ID is the unique identifier for a trace. All spans from the same
|
||||
trace share the same Trace ID.</p>
|
||||
|
||||
<p>Required.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-span_id">
|
||||
<td><code>spanId</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Span ID is the unique identifier for a span within a trace. It is assigned
|
||||
when the span is created.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-parent_span_id">
|
||||
<td><code>parentSpanId</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Parent Span ID is the unique identifier for a parent span of this span
|
||||
instance. If this is a root span, then this field MUST be empty.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-span_name">
|
||||
<td><code>spanName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Span name is a description of the span’s operation.</p>
|
||||
|
||||
<p>For example, the name can be a qualified method name or a file name
|
||||
and a line number where the operation is called. A best practice is to use
|
||||
the same display name within an application and at the same call point.
|
||||
This makes it easier to correlate spans in different traces.</p>
|
||||
|
||||
<p>Required.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-start_time">
|
||||
<td><code>startTime</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>The start time of the span.</p>
|
||||
|
||||
<p>Required.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-end_time">
|
||||
<td><code>endTime</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#TimeStamp">TimeStamp</a></code></td>
|
||||
<td>
|
||||
<p>The end time of the span.</p>
|
||||
|
||||
<p>Required.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-span_tags">
|
||||
<td><code>spanTags</code></td>
|
||||
<td><code>map<string, <a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#Value">Value</a>></code></td>
|
||||
<td>
|
||||
<p>Span tags are a set of < key, value > pairs that provide metadata for the
|
||||
entire span. The values can be specified in the form of expressions.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-httpStatusCode">
|
||||
<td><code>httpStatusCode</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>HTTP status code used to set the span status. If unset or set to 0, the
|
||||
span status will be assumed to be successful.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-client_span">
|
||||
<td><code>clientSpan</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>client_span indicates the span kind. True for client spans and False or
|
||||
not provided for server spans. Using bool instead of enum is a temporary
|
||||
work around since mixer expression language does not yet support enum
|
||||
type.</p>
|
||||
|
||||
<p>Optional</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-rewrite_client_span_id">
|
||||
<td><code>rewriteClientSpanId</code></td>
|
||||
<td><code>bool</code></td>
|
||||
<td>
|
||||
<p>rewrite<em>client</em>span_id is used to indicate whether to create a new client
|
||||
span id to accommodate Zipkin shared span model. Some tracing systems like
|
||||
Stackdriver separates a RPC into client span and server span. To solve this
|
||||
incompatibility, deterministically rewriting both span id of client span and
|
||||
parent span id of server span to the same newly generated id.</p>
|
||||
|
||||
<p>Optional</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-source_name">
|
||||
<td><code>sourceName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Identifies the source (client side) of this span.
|
||||
Should usually be set to <code>source.workload.name</code>.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-source_ip">
|
||||
<td><code>sourceIp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#IPAddress">IPAddress</a></code></td>
|
||||
<td>
|
||||
<p>Client IP address. Should usually be set to <code>source.ip</code>.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-destination_name">
|
||||
<td><code>destinationName</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>Identifies the destination (server side) of this span.
|
||||
Should usually be set to <code>destination.workload.name</code>.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-destination_ip">
|
||||
<td><code>destinationIp</code></td>
|
||||
<td><code><a href="/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html#IPAddress">IPAddress</a></code></td>
|
||||
<td>
|
||||
<p>Server IP address. Should usually be set to <code>destination.ip</code>.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-request_size">
|
||||
<td><code>requestSize</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>Request body size. Should usually be set to <code>request.size</code>.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-request_total_size">
|
||||
<td><code>requestTotalSize</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>Total request size (headers and body).
|
||||
Should usually be set to <code>request.total_size</code>.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-response_size">
|
||||
<td><code>responseSize</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>Response body size. Should usually be set to <code>response.size</code>.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-response_total_size">
|
||||
<td><code>responseTotalSize</code></td>
|
||||
<td><code>int64</code></td>
|
||||
<td>
|
||||
<p>Response total size (headers and body).
|
||||
Should usually be set to <code>response.total_size</code>.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="Template-api_protocol">
|
||||
<td><code>apiProtocol</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>
|
||||
<p>One of “http”, “https”, or “grpc” or any other value of
|
||||
the <code>api.protocol</code> attribute. Should usually be set to <code>api.protocol</code>.</p>
|
||||
|
||||
<p>Optional.</p>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
No
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
Loading…
Reference in New Issue