Rename Tasks/Telemetry to Tasks/Observability (#4968)
Matches a similar effort started in #4448. Fixes #4730.
|
@ -51,21 +51,21 @@ Below is our list of existing features and their current phases. This informatio
|
|||
|
||||
The `Sidecar` runtime is considered Beta. However, its API is still subject to a backwards incompatible change. Due to this, we advertise it as Alpha.
|
||||
|
||||
### Telemetry
|
||||
### Observability
|
||||
|
||||
| Feature | Phase
|
||||
|-------------------|-------------------
|
||||
| [Prometheus Integration](/docs/tasks/telemetry/metrics/querying-metrics/) | Stable
|
||||
| [Local Logging (STDIO)](/docs/tasks/telemetry/logs/collecting-logs/) | Stable
|
||||
| [Prometheus Integration](/docs/tasks/observability/metrics/querying-metrics/) | Stable
|
||||
| [Local Logging (STDIO)](/docs/tasks/observability/logs/collecting-logs/) | Stable
|
||||
| [Statsd Integration](/docs/reference/config/policy-and-telemetry/adapters/statsd/) | Stable
|
||||
| [Client and Server Telemetry Reporting](/docs/reference/config/policy-and-telemetry/) | Stable
|
||||
| [Service Dashboard in Grafana](/docs/tasks/telemetry/metrics/using-istio-dashboard/) | Stable
|
||||
| [Istio Component Dashboard in Grafana](/docs/tasks/telemetry/metrics/using-istio-dashboard/) | Stable
|
||||
| [Distributed Tracing](/docs/tasks/telemetry/distributed-tracing/) | Stable
|
||||
| [Service Dashboard in Grafana](/docs/tasks/observability/metrics/using-istio-dashboard/) | Stable
|
||||
| [Istio Component Dashboard in Grafana](/docs/tasks/observability/metrics/using-istio-dashboard/) | Stable
|
||||
| [Distributed Tracing](/docs/tasks/observability/distributed-tracing/) | Stable
|
||||
| [Stackdriver Integration](/docs/reference/config/policy-and-telemetry/adapters/stackdriver/) | Beta
|
||||
| [Distributed Tracing to Zipkin / Jaeger](/docs/tasks/telemetry/distributed-tracing/) | Beta
|
||||
| [Logging with Fluentd](/docs/tasks/telemetry/logs/fluentd/) | Beta
|
||||
| [Trace Sampling](/docs/tasks/telemetry/distributed-tracing/overview/#trace-sampling) | Beta
|
||||
| [Distributed Tracing to Zipkin / Jaeger](/docs/tasks/observability/distributed-tracing/) | Beta
|
||||
| [Logging with Fluentd](/docs/tasks/observability/logs/fluentd/) | Beta
|
||||
| [Trace Sampling](/docs/tasks/observability/distributed-tracing/overview/#trace-sampling) | Beta
|
||||
|
||||
### Security and Policy Enforcement
|
||||
|
||||
|
|
|
@ -301,7 +301,7 @@ In the next section you will configure TLS origination for accessing an external
|
|||
|
||||
1. Access the web page of the application and verify that the book details are displayed without errors.
|
||||
|
||||
1. [Enable Envoy’s access logging](/docs/tasks/telemetry/logs/access-log/#enable-envoy-s-access-logging)
|
||||
1. [Enable Envoy’s access logging](/docs/tasks/observability/logs/access-log/#enable-envoy-s-access-logging)
|
||||
|
||||
1. Check the log of of the sidecar proxy of _details v2_ and see the HTTP request.
|
||||
|
||||
|
|
|
@ -448,7 +448,7 @@ enable Mixer policy enforcement based on that identity. By enabling mutual TLS y
|
|||
|
||||
1. Refresh the web page of the application again and verify that the ratings are still displayed correctly.
|
||||
|
||||
1. [Enable Envoy’s access logging](/docs/tasks/telemetry/logs/access-log/#enable-envoy-s-access-logging)
|
||||
1. [Enable Envoy’s access logging](/docs/tasks/observability/logs/access-log/#enable-envoy-s-access-logging)
|
||||
|
||||
1. Check the log of the egress gateway's Envoy and see a line that corresponds to your
|
||||
requests to the MongoDB service. If Istio is deployed in the `istio-system` namespace, the command to print the
|
||||
|
@ -1038,7 +1038,7 @@ to hold the configuration of the Nginx SNI proxy:
|
|||
|
||||
1. Refresh the web page of the application again and verify that the ratings are still displayed correctly.
|
||||
|
||||
1. [Enable Envoy’s access logging](/docs/tasks/telemetry/logs/access-log/#enable-envoy-s-access-logging)
|
||||
1. [Enable Envoy’s access logging](/docs/tasks/observability/logs/access-log/#enable-envoy-s-access-logging)
|
||||
|
||||
1. Check the log of the egress gateway's Envoy proxy. If Istio is deployed in the `istio-system` namespace, the command
|
||||
to print the log is:
|
||||
|
|
|
@ -39,15 +39,15 @@ will prevent any possibility for a malicious application to access the forbidden
|
|||
* The [Egress Gateway with TLS Origination](/docs/tasks/traffic-management/egress/egress-gateway-tls-origination/) example
|
||||
demonstrates how to allow applications to send HTTP requests to external servers that require HTTPS, while directing
|
||||
traffic through egress gateway.
|
||||
* The [Collecting Metrics](/docs/tasks/telemetry/metrics/collecting-metrics/) task describes how to configure metrics for services in a mesh.
|
||||
* The [Visualizing Metrics with Grafana](/docs/tasks/telemetry/metrics/using-istio-dashboard/)
|
||||
* The [Collecting Metrics](/docs/tasks/observability/metrics/collecting-metrics/) task describes how to configure metrics for services in a mesh.
|
||||
* The [Visualizing Metrics with Grafana](/docs/tasks/observability/metrics/using-istio-dashboard/)
|
||||
describes the Istio Dashboard to monitor mesh traffic.
|
||||
* The [Basic Access Control](/docs/tasks/policy-enforcement/denial-and-list/) task shows how to control access to
|
||||
in-mesh services.
|
||||
* The [Denials and White/Black Listing](/docs/tasks/policy-enforcement/denial-and-list/) task shows how to configure
|
||||
access policies using black or white list checkers.
|
||||
|
||||
As opposed to the telemetry and security tasks above, this blog post describes Istio's monitoring and access policies
|
||||
As opposed to the observability and security tasks above, this blog post describes Istio's monitoring and access policies
|
||||
applied exclusively to the egress traffic.
|
||||
|
||||
## Before you begin
|
||||
|
|
|
@ -76,7 +76,7 @@ istio-system1 istio-pilot-5bb6b7669c-779vb 2/2 Running 0
|
|||
{{< /text >}}
|
||||
|
||||
The Istio [sidecar](/docs/setup/additional-setup/sidecar-injection/)
|
||||
and [addons](/docs/tasks/telemetry/), if required, manifests must also be
|
||||
and [addons](/docs/tasks/observability/), if required, manifests must also be
|
||||
deployed to match the configured `namespace` in use by the tenant's Istio
|
||||
control plane.
|
||||
|
||||
|
@ -289,8 +289,8 @@ $ kubectl get pods -n ns-1
|
|||
Error from server (Forbidden): pods is forbidden: User "dev-admin" cannot list pods in the namespace "ns-1"
|
||||
{{< /text >}}
|
||||
|
||||
If the [add-on tools](/docs/tasks/telemetry/), example
|
||||
[Prometheus](/docs/tasks/telemetry/metrics/querying-metrics/), are deployed
|
||||
If the [add-on tools](/docs/tasks/observability/), example
|
||||
[Prometheus](/docs/tasks/observability/metrics/querying-metrics/), are deployed
|
||||
(also limited by an Istio `namespace`) the statistical results returned would represent only
|
||||
that traffic seen from that tenant's application namespace.
|
||||
|
||||
|
|
|
@ -75,7 +75,7 @@ Additionally, Istio's egress traffic control provides the following advantages:
|
|||
|
||||
- Define access policies in the same language for ingress, egress, and in-cluster traffic. You
|
||||
need to learn a single policy and configuration language for all types of traffic.
|
||||
- Out-of-the-Box integration of Istio's egress traffic control with Istio's policy and telemetry adapters.
|
||||
- Out-of-the-Box integration of Istio's egress traffic control with Istio's policy and observability adapters.
|
||||
- Write the adapters to use external monitoring or access control systems with Istio only once and
|
||||
apply them for all types of traffic: ingress, egress, and in-cluster.
|
||||
- Use Istio's [traffic management features](/docs/concepts/traffic-management/) for egress traffic:
|
||||
|
@ -143,7 +143,7 @@ Istio is the only solution I'm aware of that lets you:
|
|||
In my opinion, secure control of egress traffic is a great choice if you are looking for your first Istio use case.
|
||||
In this case, Istio already provides you some benefits even before you start using all other Istio features:
|
||||
[traffic management](/docs/tasks/traffic-management/), [security](/docs/tasks/security/),
|
||||
[policies](/docs/tasks/policy-enforcement/) and [telemetry](/docs/tasks/telemetry/), applied to traffic between
|
||||
[policies](/docs/tasks/policy-enforcement/) and [observability](/docs/tasks/observability/), applied to traffic between
|
||||
microservices inside the cluster.
|
||||
|
||||
So, if you haven't had the chance to work with Istio yet, [install Istio](/docs/setup/install/) on your cluster
|
||||
|
|
|
@ -22,7 +22,7 @@ providing a flexible fine-grained access control mechanism. [Learn more](https:/
|
|||
[Learn more](/docs/concepts/security/#authorization)
|
||||
|
||||
- **Fluentd**. Mixer now has an adapter for log collection through [Fluentd](https://www.fluentd.org).
|
||||
[Learn more](/docs/tasks/telemetry/logs/fluentd/)
|
||||
[Learn more](/docs/tasks/observability/logs/fluentd/)
|
||||
|
||||
- **Stdio**. The stdio adapter now lets you log to files with support for log rotation & backup, along with a host
|
||||
of controls.
|
||||
|
|
|
@ -12,7 +12,7 @@
|
|||
|
||||
- Pilot performance and scalability has been greatly enhanced. Pilot now delivers endpoint updates to 500 sidecars in under 1 second.
|
||||
|
||||
- Default [trace sampling](/docs/tasks/telemetry/distributed-tracing/overview/#trace-sampling) is set to 1%.
|
||||
- Default [trace sampling](/docs/tasks/observability/distributed-tracing/overview/#trace-sampling) is set to 1%.
|
||||
|
||||
## Policy and telemetry
|
||||
|
||||
|
|
|
@ -124,7 +124,7 @@ concise list of things you should know before upgrading your deployment to Istio
|
|||
|
||||
- **Kiali**. Replaced the [Service Graph addon](https://github.com/istio/istio/issues/9066)
|
||||
with [Kiali](https://www.kiali.io) to provide a richer visualization
|
||||
experience. See the [Kiali task](/docs/tasks/telemetry/kiali/) for more
|
||||
experience. See the [Kiali task](/docs/tasks/observability/kiali/) for more
|
||||
details.
|
||||
|
||||
- **Reduced Overhead**. Added several performance and scale improvements
|
||||
|
@ -151,7 +151,7 @@ concise list of things you should know before upgrading your deployment to Istio
|
|||
|
||||
- Trace ids are now 128 bit wide.
|
||||
|
||||
- Added support for sending trace data to [LightStep](/docs/tasks/telemetry/distributed-tracing/lightstep/)
|
||||
- Added support for sending trace data to [LightStep](/docs/tasks/observability/distributed-tracing/lightstep/)
|
||||
|
||||
- Added the option to disable tracing for Mixer-backed services entirely.
|
||||
|
||||
|
@ -162,7 +162,7 @@ concise list of things you should know before upgrading your deployment to Istio
|
|||
- **Reduced Load Balancer Requirements for Addons**. Stopped exposing addons
|
||||
via separate load balancers. Instead, addons are exposed via the Istio
|
||||
gateway. To expose addons externally using either HTTP or HTTPS protocols,
|
||||
please use the [Addon Gateway documentation](/docs/tasks/telemetry/gateways/).
|
||||
please use the [Addon Gateway documentation](/docs/tasks/observability/gateways/).
|
||||
|
||||
- **Secure Addon Credentials**. Changed storage of the addon credentials.
|
||||
Grafana, Kiali, and Jaeger passwords and username are now stored in
|
||||
|
|
|
@ -30,7 +30,7 @@
|
|||
- **Added** Full support for control over Envoy stats generation, based on stats prefixes, suffixes, and regular expressions through the use of annotations.
|
||||
- **Changed** Prometheus generated traffic is excluded from metrics.
|
||||
- **Added** support for sending traces to Datadog.
|
||||
- **Graduated** [distributed tracing](/docs/tasks/telemetry/distributed-tracing/) from Beta to Stable.
|
||||
- **Graduated** [distributed tracing](/docs/tasks/observability/distributed-tracing/) from Beta to Stable.
|
||||
|
||||
## Policy
|
||||
|
||||
|
|
|
@ -75,13 +75,13 @@ envoy_cluster_internal_upstream_rq{response_code="503",cluster_name="xds-grpc"}
|
|||
|
||||
In addition to the proxy-level metrics, Istio provides a set of service-oriented metrics for monitoring service communications. These metrics cover the four
|
||||
basic service monitoring needs: latency, traffic, errors, and saturation. Istio ships with a default set of
|
||||
[dashboards](/docs/tasks/telemetry/metrics/using-istio-dashboard/) for monitoring service behaviors based on these metrics.
|
||||
[dashboards](/docs/tasks/observability/metrics/using-istio-dashboard/) for monitoring service behaviors based on these metrics.
|
||||
|
||||
The [default Istio metrics](/docs/reference/config/policy-and-telemetry/metrics/) are defined by a set of configuration artifacts that ship with Istio and are
|
||||
exported to [Prometheus](/docs/reference/config/policy-and-telemetry/adapters/prometheus/) by default. Operators are free to modify the
|
||||
shape and content of these metrics, as well as to change their collection mechanism, to meet their individual monitoring needs.
|
||||
|
||||
The [Collecting Metrics](/docs/tasks/telemetry/metrics/collecting-metrics/) task provides more information on customizing Istio metrics generation.
|
||||
The [Collecting Metrics](/docs/tasks/observability/metrics/collecting-metrics/) task provides more information on customizing Istio metrics generation.
|
||||
|
||||
Use of the service-level metrics is entirely optional. Operators may choose to turn off generation and collection of these metrics to meet their individual
|
||||
needs.
|
||||
|
@ -131,8 +131,8 @@ Traces empower mesh operators to understand service dependencies and the sources
|
|||
Istio supports distributed tracing through the Envoy proxies. The proxies automatically generate trace spans on behalf of the applications they proxy,
|
||||
requiring only that the applications forward the appropriate request context.
|
||||
|
||||
Istio supports a number of tracing backends, including [Zipkin](/docs/tasks/telemetry/distributed-tracing/zipkin/),
|
||||
[Jaeger](/docs/tasks/telemetry/distributed-tracing/jaeger/), [LightStep](/docs/tasks/telemetry/distributed-tracing/lightstep/), and
|
||||
Istio supports a number of tracing backends, including [Zipkin](/docs/tasks/observability/distributed-tracing/zipkin/),
|
||||
[Jaeger](/docs/tasks/observability/distributed-tracing/jaeger/), [LightStep](/docs/tasks/observability/distributed-tracing/lightstep/), and
|
||||
[Datadog](https://www.datadoghq.com/blog/monitor-istio-with-datadog/). Operators control the sampling rate for trace generation (that is, the rate at
|
||||
which tracing data is generated per request). This allows operators to control the amount and rate of tracing data being produced for their mesh.
|
||||
|
||||
|
@ -140,7 +140,7 @@ More information about Distributed Tracing with Istio is found in our [FAQ on Di
|
|||
|
||||
Example Istio-generated distributed trace for a single request:
|
||||
|
||||
{{< image link="/docs/tasks/telemetry/distributed-tracing/zipkin/istio-tracing-details-zipkin.png" caption="Distributed Trace for a single request" >}}
|
||||
{{< image link="/docs/tasks/observability/distributed-tracing/zipkin/istio-tracing-details-zipkin.png" caption="Distributed Trace for a single request" >}}
|
||||
|
||||
## Access Logs
|
||||
|
||||
|
@ -149,9 +149,9 @@ Access logs provide a way to monitor and understand behavior from the perspectiv
|
|||
Istio can generate access logs for service traffic in a configurable set of formats, providing operators with full control of the how, what, when and where of
|
||||
logging. Istio exposes a full set of source and destination metadata to the access logging mechanisms, allowing detailed audit of network transactions.
|
||||
|
||||
Access logs may be generated locally or exported to custom backends, including [Fluentd](/docs/tasks/telemetry/logs/fluentd/).
|
||||
Access logs may be generated locally or exported to custom backends, including [Fluentd](/docs/tasks/observability/logs/fluentd/).
|
||||
|
||||
More information on access logging is provided in the [Collecting Logs](/docs/tasks/telemetry/logs/collecting-logs/) and the [Getting Envoy's Access Logs](/docs/tasks/telemetry/logs/access-log/) tasks.
|
||||
More information on access logging is provided in the [Collecting Logs](/docs/tasks/observability/logs/collecting-logs/) and the [Getting Envoy's Access Logs](/docs/tasks/observability/logs/access-log/) tasks.
|
||||
|
||||
Example Istio access log (formatted in JSON):
|
||||
|
||||
|
|
|
@ -31,7 +31,7 @@ Istio provides behavioral insights and operational control over the service mesh
|
|||
|
||||
## Why use Istio?
|
||||
|
||||
Istio makes it easy to create a network of deployed services with load balancing, service-to-service authentication, monitoring, and more, with [few](/docs/tasks/telemetry/distributed-tracing/overview/#trace-context-propagation) or no code changes
|
||||
Istio makes it easy to create a network of deployed services with load balancing, service-to-service authentication, monitoring, and more, with [few](/docs/tasks/observability/distributed-tracing/overview/#trace-context-propagation) or no code changes
|
||||
in service code. You add Istio support to services by deploying a special sidecar proxy throughout your environment that intercepts all network communication
|
||||
between microservices, then configure and manage Istio using its control plane functionality, which includes:
|
||||
|
||||
|
|
|
@ -9,7 +9,7 @@ aliases:
|
|||
The Envoy proxy keeps detailed statistics about network traffic.
|
||||
|
||||
Envoy's statistics only cover the traffic for a particular Envoy instance. See
|
||||
[Telemetry](/docs/tasks/telemetry/) for persistent per-service Istio telemetry. The
|
||||
[Observability](/docs/tasks/observability/) for persistent per-service Istio telemetry. The
|
||||
statistics the Envoy proxies record can provide more information about specific pod instances.
|
||||
|
||||
To see the statistics for a pod:
|
||||
|
|
|
@ -38,7 +38,7 @@ spec:
|
|||
source.version: source.labels["version"] | ""
|
||||
</code></pre>
|
||||
|
||||
<p>See also: <a href="/docs/tasks/telemetry/distributed-tracing/">Distributed Tracing</a>
|
||||
<p>See also: <a href="/docs/tasks/observability/distributed-tracing/">Distributed Tracing</a>
|
||||
for information on tracing within Istio.</p>
|
||||
|
||||
<h2 id="Template">Template</h2>
|
||||
|
|
|
@ -25,13 +25,13 @@ tasks are a good place to start:
|
|||
- [Request routing](/docs/tasks/traffic-management/request-routing/)
|
||||
- [Fault injection](/docs/tasks/traffic-management/fault-injection/)
|
||||
- [Traffic shifting](/docs/tasks/traffic-management/traffic-shifting/)
|
||||
- [Querying metrics](/docs/tasks/telemetry/metrics/querying-metrics/)
|
||||
- [Visualizing metrics](/docs/tasks/telemetry/metrics/using-istio-dashboard/)
|
||||
- [Collecting logs](/docs/tasks/telemetry/logs/collecting-logs/)
|
||||
- [Querying metrics](/docs/tasks/observability/metrics/querying-metrics/)
|
||||
- [Visualizing metrics](/docs/tasks/observability/metrics/using-istio-dashboard/)
|
||||
- [Collecting logs](/docs/tasks/observability/logs/collecting-logs/)
|
||||
- [Rate limiting](/docs/tasks/policy-enforcement/rate-limiting/)
|
||||
- [Ingress gateways](/docs/tasks/traffic-management/ingress/ingress-control/)
|
||||
- [Accessing external services](/docs/tasks/traffic-management/egress/egress-control/)
|
||||
- [Visualizing your mesh](/docs/tasks/telemetry/kiali/)
|
||||
- [Visualizing your mesh](/docs/tasks/observability/kiali/)
|
||||
|
||||
The tasks above provide a good basic understanding of Istio's features but,
|
||||
explore more [tasks](/docs/tasks/) depending on what interests you. Before you
|
||||
|
|
|
@ -1,7 +1,8 @@
|
|||
---
|
||||
title: Telemetry
|
||||
title: Observability
|
||||
description: Demonstrates how to collect telemetry information from the mesh.
|
||||
weight: 30
|
||||
aliases:
|
||||
- /docs/examples/telemetry/
|
||||
- /docs/tasks/telemetry/
|
||||
---
|
|
@ -3,4 +3,6 @@ title: Distributed Tracing
|
|||
description: This task shows you how to configure Istio-enabled applications to collect trace spans.
|
||||
weight: 30
|
||||
keywords: [telemetry,tracing]
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/distributed-tracing/
|
||||
---
|
|
@ -3,6 +3,8 @@ title: Jaeger
|
|||
description: Learn how to configure the proxies to send tracing requests to Jaeger.
|
||||
weight: 10
|
||||
keywords: [telemetry,tracing,jaeger,span,port-forwarding]
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/distributed-tracing/jaeger/
|
||||
---
|
||||
|
||||
After completing this task, you understand how to have your application participate in tracing with [Jaeger](https://www.jaegertracing.io/),
|
||||
|
@ -30,7 +32,7 @@ To learn how Istio handles tracing, visit this task's [overview](../overview/).
|
|||
|
||||
## Accessing the dashboard
|
||||
|
||||
[Remotely Accessing Telemetry Addons](/docs/tasks/telemetry/gateways) details how to configure access to the Istio addons through a gateway. Alternatively, to use a Kubernetes ingress, specify the Helm chart option `--set tracing.ingress.enabled=true` during install.
|
||||
[Remotely Accessing Telemetry Addons](/docs/tasks/observability/gateways) details how to configure access to the Istio addons through a gateway. Alternatively, to use a Kubernetes ingress, specify the Helm chart option `--set tracing.ingress.enabled=true` during install.
|
||||
|
||||
For testing (and temporary access), you may also use port-forwarding. Use the following, assuming you've deployed Jaeger to the `istio-system` namespace:
|
||||
|
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 96 KiB |
Before Width: | Height: | Size: 159 KiB After Width: | Height: | Size: 159 KiB |
|
@ -3,6 +3,8 @@ title: LightStep
|
|||
description: How to configure the proxies to send tracing requests to LightStep.
|
||||
weight: 11
|
||||
keywords: [telemetry,tracing,lightstep]
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/distributed-tracing/lightstep/
|
||||
---
|
||||
|
||||
This task shows you how to configure Istio to collect trace spans and send them to [LightStep Tracing](https://lightstep.com/products/) or [LightStep [𝑥]PM](https://lightstep.com/products/).
|
Before Width: | Height: | Size: 323 KiB After Width: | Height: | Size: 323 KiB |
Before Width: | Height: | Size: 342 KiB After Width: | Height: | Size: 342 KiB |
|
@ -3,6 +3,8 @@ title: Overview
|
|||
description: Overview of distributed tracing in Istio.
|
||||
weight: 1
|
||||
keywords: [telemetry,tracing]
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/distributed-tracing/overview/
|
||||
---
|
||||
|
||||
Distributed tracing enables users to track a request through mesh that is distributed across multiple services.
|
||||
|
@ -11,7 +13,7 @@ This allows a deeper understanding about request latency, serialization and para
|
|||
Istio leverages [Envoy's distributed tracing](https://www.envoyproxy.io/docs/envoy/v1.10.0/intro/arch_overview/tracing) feature
|
||||
to provide tracing integration out of the box. Specifically, Istio provides options to install various tracing backend
|
||||
and configure proxies to send trace spans to them automatically.
|
||||
See [Zipkin](../zipkin/), [Jaeger](../jaeger/) and [LightStep](/docs/tasks/telemetry/distributed-tracing/lightstep/) task docs about how Istio works with those tracing systems.
|
||||
See [Zipkin](../zipkin/), [Jaeger](../jaeger/) and [LightStep](/docs/tasks/observability/distributed-tracing/lightstep/) task docs about how Istio works with those tracing systems.
|
||||
|
||||
## Trace context propagation
|
||||
|
|
@ -32,7 +32,7 @@ To learn how Istio handles tracing, visit this task's [overview](../overview/).
|
|||
|
||||
## Accessing the dashboard
|
||||
|
||||
[Remotely Accessing Telemetry Addons](/docs/tasks/telemetry/gateways) details how to configure access to the Istio addons through a gateway. Alternatively, to use a Kubernetes ingress, specify the Helm chart option `--set tracing.ingress.enabled=true` during install.
|
||||
[Remotely Accessing Telemetry Addons](/docs/tasks/observability/gateways) details how to configure access to the Istio addons through a gateway. Alternatively, to use a Kubernetes ingress, specify the Helm chart option `--set tracing.ingress.enabled=true` during install.
|
||||
|
||||
For testing (and temporary access), you may also use port-forwarding. Use the following, assuming you've deployed Zipkin to the `istio-system` namespace:
|
||||
|
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
Before Width: | Height: | Size: 111 KiB After Width: | Height: | Size: 111 KiB |
|
@ -3,6 +3,8 @@ title: Remotely Accessing Telemetry Addons
|
|||
description: This task shows you how to configure external access to the set of Istio telemetry addons.
|
||||
weight: 99
|
||||
keywords: [telemetry,gateway,jaeger,zipkin,tracing,kiali,prometheus,addons]
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/gateways/
|
||||
---
|
||||
|
||||
This task shows how to configure Istio to expose and access the telemetry addons outside of
|
|
@ -3,6 +3,8 @@ title: Visualizing Your Mesh
|
|||
description: This task shows you how to visualize your services within an Istio mesh.
|
||||
weight: 49
|
||||
keywords: [telemetry,visualization]
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/kiali/
|
||||
---
|
||||
|
||||
This task shows you how to visualize different aspects of your Istio mesh.
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 76 KiB |
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 53 KiB |
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
|
@ -2,4 +2,6 @@
|
|||
title: Logs
|
||||
description: Demonstrates the configuration, collection, and processing of Istio mesh logs.
|
||||
weight: 20
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/logs/
|
||||
---
|
|
@ -5,6 +5,7 @@ weight: 10
|
|||
keywords: [telemetry]
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/access-log
|
||||
- /docs/tasks/telemetry/logs/access-log/
|
||||
---
|
||||
|
||||
The simplest kind of Istio logging is
|
|
@ -3,6 +3,8 @@ title: Collecting Logs
|
|||
description: This task shows you how to configure Istio to collect and customize logs.
|
||||
weight: 10
|
||||
keywords: [telemetry,logs]
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/logs/collecting-logs/
|
||||
---
|
||||
|
||||
This task shows how to configure Istio to automatically gather telemetry for
|
|
@ -5,6 +5,7 @@ weight: 90
|
|||
keywords: [telemetry,logging]
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/fluentd/
|
||||
- /docs/tasks/telemetry/logs/fluentd/
|
||||
---
|
||||
|
||||
This task shows how to configure Istio to create custom log entries
|
|
@ -2,4 +2,6 @@
|
|||
title: Metrics
|
||||
description: Demonstrates the configuration, collection, and processing of Istio mesh metrics.
|
||||
weight: 1
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/metrics/
|
||||
---
|
|
@ -6,6 +6,7 @@ keywords: [telemetry,metrics]
|
|||
aliases:
|
||||
- /docs/tasks/metrics-logs.html
|
||||
- /docs/tasks/telemetry/metrics-logs/
|
||||
- /docs/tasks/telemetry/metrics/collecting-metrics/
|
||||
---
|
||||
|
||||
This task shows how to configure Istio to automatically gather telemetry for
|
||||
|
@ -72,7 +73,7 @@ as the example application throughout this task.
|
|||
{{< /text >}}
|
||||
|
||||
For more on querying Prometheus for metric values, see the
|
||||
[Querying Istio Metrics](/docs/tasks/telemetry/metrics/querying-metrics/) task.
|
||||
[Querying Istio Metrics](/docs/tasks/observability/metrics/querying-metrics/) task.
|
||||
|
||||
## Understanding the metrics configuration
|
||||
|
|
@ -5,6 +5,7 @@ weight: 30
|
|||
keywords: [telemetry,metrics]
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/querying-metrics/
|
||||
- /docs/tasks/telemetry/metrics/querying-metrics/
|
||||
---
|
||||
|
||||
This task shows you how to query for Istio Metrics using Prometheus. As part of
|
Before Width: | Height: | Size: 114 KiB After Width: | Height: | Size: 114 KiB |
|
@ -5,6 +5,7 @@ weight: 20
|
|||
keywords: [telemetry,metrics,tcp]
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/tcp-metrics
|
||||
- /docs/tasks/telemetry/metrics/tcp-metrics/
|
||||
---
|
||||
|
||||
This task shows how to configure Istio to automatically gather telemetry for TCP
|
||||
|
@ -141,7 +142,7 @@ automatically generate and report a new metric for all traffic to a TCP service
|
|||
within the mesh.
|
||||
|
||||
Similar to the [Collecting Metrics and
|
||||
Logs](/docs/tasks/telemetry/metrics/collecting-metrics/) Task, the new
|
||||
Logs](/docs/tasks/observability/metrics/collecting-metrics/) Task, the new
|
||||
configuration consisted of _instances_, a _handler_, and a _rule_. Please see
|
||||
that Task for a complete description of the components of metric collection.
|
||||
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
Before Width: | Height: | Size: 97 KiB After Width: | Height: | Size: 97 KiB |
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
|
@ -5,6 +5,7 @@ weight: 40
|
|||
keywords: [telemetry,visualization]
|
||||
aliases:
|
||||
- /docs/tasks/telemetry/using-istio-dashboard/
|
||||
- /docs/tasks/telemetry/metrics/using-istio-dashboard/
|
||||
---
|
||||
|
||||
This task shows you how to setup and use the Istio Dashboard to monitor mesh
|
Before Width: | Height: | Size: 111 KiB After Width: | Height: | Size: 111 KiB |
Before Width: | Height: | Size: 87 KiB After Width: | Height: | Size: 87 KiB |
|
@ -20,7 +20,7 @@ and mutual TLS traffic.
|
|||
You can configure Istio services to send mutual
|
||||
TLS traffic to that service while connections from legacy services will not
|
||||
lose communication. Moreover, you can use the
|
||||
[Grafana dashboard](/docs/tasks/telemetry/metrics/using-istio-dashboard/) to check which services are
|
||||
[Grafana dashboard](/docs/tasks/observability/metrics/using-istio-dashboard/) to check which services are
|
||||
still sending plaintext traffic to the service in "PERMISSIVE" mode and choose to lock
|
||||
down once the migration is done.
|
||||
|
||||
|
@ -105,7 +105,7 @@ $ for from in "foo" "bar" "legacy"; do kubectl exec $(kubectl get pod -l app=sle
|
|||
|
||||
You can also specify a subset of the clients' request to use `ISTIO_MUTUAL` mutual TLS in
|
||||
[`DestinationRule`](/docs/reference/config/networking/v1alpha3/destination-rule/).
|
||||
After verifying it works by checking [Grafana to monitor](/docs/tasks/telemetry/metrics/using-istio-dashboard/),
|
||||
After verifying it works by checking [Grafana to monitor](/docs/tasks/observability/metrics/using-istio-dashboard/),
|
||||
then increase the rollout scope and finally apply to all Istio client services.
|
||||
|
||||
## Lock down to mutual TLS (optional)
|
||||
|
|
|
@ -4,4 +4,4 @@ weight: 40
|
|||
---
|
||||
|
||||
Istio, via Envoy, currently supports a percentage-based sampling strategy for trace generation.
|
||||
Please see [this section](/docs/tasks/telemetry/distributed-tracing/overview/#trace-sampling) for more information on how to set this sampling rate.
|
||||
Please see [this section](/docs/tasks/observability/distributed-tracing/overview/#trace-sampling) for more information on how to set this sampling rate.
|
||||
|
|
|
@ -15,6 +15,6 @@ $ kubectl -n istio-system edit deployment istio-telemetry
|
|||
# Now, manually remove instances of trace_zipkin_url from the file and save it.
|
||||
{{< /text >}}
|
||||
|
||||
Then follow the steps of the [cleanup section of the Distributed Tracing task](/docs/tasks/telemetry/distributed-tracing/zipkin/#cleanup).
|
||||
Then follow the steps of the [cleanup section of the Distributed Tracing task](/docs/tasks/observability/distributed-tracing/zipkin/#cleanup).
|
||||
|
||||
If you don’t want tracing functionality at all, then [disable tracing](/docs/tasks/telemetry/distributed-tracing/zipkin/#before-you-begin) when installing Istio.
|
||||
If you don’t want tracing functionality at all, then [disable tracing](/docs/tasks/observability/distributed-tracing/zipkin/#before-you-begin) when installing Istio.
|
||||
|
|
|
@ -5,5 +5,5 @@ weight: 0
|
|||
|
||||
Istio integrates with distributed tracing systems in two different ways: [Envoy-based](#how-envoy-based-tracing-works) and [Mixer-based](#how-mixer-based-tracing-works) tracing integrations. For both tracing integration approaches, [applications are responsible for forwarding tracing headers](#istio-copy-headers) for subsequent outgoing requests.
|
||||
|
||||
You can find additional information in the Istio Distributed Tracing ([Jaeger](/docs/tasks/telemetry/distributed-tracing/jaeger/), [LightStep](/docs/tasks/telemetry/distributed-tracing/lightstep/), [Zipkin](/docs/tasks/telemetry/distributed-tracing/zipkin/)) Tasks and
|
||||
You can find additional information in the Istio Distributed Tracing ([Jaeger](/docs/tasks/observability/distributed-tracing/jaeger/), [LightStep](/docs/tasks/observability/distributed-tracing/lightstep/), [Zipkin](/docs/tasks/observability/distributed-tracing/zipkin/)) Tasks and
|
||||
in the [Envoy tracing docs](https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/observability/tracing).
|
||||
|
|
|
@ -12,4 +12,4 @@ Envoy:
|
|||
- sends the generated trace spans to the tracing backends
|
||||
- forwards the trace headers to the proxied application
|
||||
|
||||
Istio supports the Envoy-based integrations of [LightStep](/docs/tasks/telemetry/distributed-tracing/lightstep/) and [Zipkin](/docs/tasks/telemetry/distributed-tracing/zipkin/), as well as all Zipkin API-compatible backends, including [Jaeger](/docs/tasks/telemetry/distributed-tracing/jaeger/).
|
||||
Istio supports the Envoy-based integrations of [LightStep](/docs/tasks/observability/distributed-tracing/lightstep/) and [Zipkin](/docs/tasks/observability/distributed-tracing/zipkin/), as well as all Zipkin API-compatible backends, including [Jaeger](/docs/tasks/observability/distributed-tracing/jaeger/).
|
||||
|
|
|
@ -19,4 +19,4 @@ If you are using LightStep, you will also need to forward the following headers:
|
|||
|
||||
- `x-ot-span-context`
|
||||
|
||||
Header propagation may be accomplished through client libraries, such as [Zipkin](https://zipkin.io/pages/tracers_instrumentation.html) or [Jaeger](https://github.com/jaegertracing/jaeger-client-java/tree/master/jaeger-core#b3-propagation). It may also be accomplished manually, as documented in the [Distributed Tracing Task](/docs/tasks/telemetry/distributed-tracing/overview#trace-context-propagation).
|
||||
Header propagation may be accomplished through client libraries, such as [Zipkin](https://zipkin.io/pages/tracers_instrumentation.html) or [Jaeger](https://github.com/jaegertracing/jaeger-client-java/tree/master/jaeger-core#b3-propagation). It may also be accomplished manually, as documented in the [Distributed Tracing Task](/docs/tasks/observability/distributed-tracing/overview#trace-context-propagation).
|
|
@ -5,7 +5,7 @@ weight: 30
|
|||
|
||||
Since Istio 1.0.3, the default sampling rate for tracing has been reduced to 1% when installing Istio using the Helm chart. This means that only 1 out of 100 trace
|
||||
instances captured by Istio will be reported to the tracing backend. The sampling rate in the `istio-demo.yaml` is still set to 100%. See
|
||||
[this section](/docs/tasks/telemetry/distributed-tracing/overview/#trace-sampling) for more information on how to set the sampling rate.
|
||||
[this section](/docs/tasks/observability/distributed-tracing/overview/#trace-sampling) for more information on how to set the sampling rate.
|
||||
|
||||
If you still do not see any trace data, please confirm that your ports conform to the Istio [port naming conventions](/faq/traffic-management/#naming-port-convention) and that the appropriate container port is exposed (via pod spec, for example) to enable
|
||||
traffic capture by the sidecar proxy (Envoy).
|
||||
|
|
|
@ -3,5 +3,5 @@ title: Can Istio metrics be accessed through REST?
|
|||
weight: 0
|
||||
---
|
||||
|
||||
You can collect telemetry data about Istio using [Prometheus](/docs/tasks/telemetry/metrics/querying-metrics/). And then use
|
||||
You can collect telemetry data about Istio using [Prometheus](/docs/tasks/observability/metrics/querying-metrics/). And then use
|
||||
[Prometheus’s HTTP API](https://prometheus.io/docs/prometheus/latest/querying/api/) to query that data.
|
||||
|
|
|
@ -3,7 +3,7 @@ title: How to figure out what happened to a request in Istio?
|
|||
weight: 80
|
||||
---
|
||||
|
||||
You can enable [tracing](/docs/tasks/telemetry/distributed-tracing/) to determine the flow of a request in Istio.
|
||||
You can enable [tracing](/docs/tasks/observability/distributed-tracing/) to determine the flow of a request in Istio.
|
||||
|
||||
Additionally, you can use the following commands to know more about the state of the mesh:
|
||||
|
||||
|
|