mirror of https://github.com/istio/istio.io.git
[zh] sync and improve lightstep (#14671)
Signed-off-by: xin.li <xin.li@daocloud.io>
This commit is contained in:
my-git9
GitHub
parent
5c06f93ea1
commit
dfe78e46f6
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Lightstep
|
title: Lightstep
|
||||||
description: 怎样配置代理才能把追踪请求发送到 Lightstep。
|
description: 怎样配置代理才能把链路追踪请求发送到 Lightstep。
|
||||||
weight: 11
|
weight: 11
|
||||||
keywords: [telemetry, tracing, lightstep]
|
keywords: [telemetry, tracing, lightstep]
|
||||||
aliases:
|
aliases:
|
||||||
|
|
@ -12,44 +12,44 @@ test: no
|
||||||
{{< boilerplate telemetry-tracing-tips >}}
|
{{< boilerplate telemetry-tracing-tips >}}
|
||||||
|
|
||||||
此任务介绍如何配置 Istio 才能收集追踪 span，并且把收集到的 span 发送到
|
此任务介绍如何配置 Istio 才能收集追踪 span，并且把收集到的 span 发送到
|
||||||
[Lightstep](https://lightstep.com/products/)。Lightstep 可以分析来自大规模生产级软件的
|
[Lightstep](https://lightstep.com/products/) 中。Lightstep 可以分析来自大规模生产级软件的
|
||||||
100% 未采样的事务数据，并做出容易理解的分布式追踪和指标信息，这有助于解释性能行为和并加速根因分析。
|
100% 未采样的事务数据，以生成有意义的分布式链路追踪和指标，从而帮助解释性能行为、加速根本原因分析。
|
||||||
在此任务的结尾，Istio 将追踪 span 从代理发送到 Lightstep Satellite 池，
|
在此任务的结尾，Istio 将追踪 span 从代理发送到 Lightstep Satellite 池中，
|
||||||
以让它们在 web UI 上展示。默认情况下，所有的 HTTP 请求都被捕获（为了看到端到端的追踪，
|
以让它们在 Web UI 上被展示。默认情况下，所有的 HTTP 请求都将被捕获（为了看到端到端的追踪，
|
||||||
您的代码需要转发 OT 头，即使它没有参与到追踪）。
|
您的代码需要转发 OT 头，即使它没有参与到链路追踪中）。
|
||||||
|
|
||||||
如果您只想直接从 Istio 收集追踪 span（而不是直接向您的代码添加特定的检测），那么您不需要配置任何追踪器，
|
如果您只想直接从 Istio 收集追踪 span（而不是直接向您的代码添加特定的检测），那么您不需要配置任何追踪器，
|
||||||
只要您的服务转发[追踪器产生的 HTTP 请求头](https://www.envoyproxy.io/docs/envoy/latest/configuration/http_conn_man/headers#config-http-conn-man-headers-x-ot-span-context)。
|
只要让您的服务转发[追踪器产生的 HTTP 请求头](https://www.envoyproxy.io/docs/envoy/latest/configuration/http_conn_man/headers#config-http-conn-man-headers-x-ot-span-context)。
|
||||||
|
|
||||||
此任务使用 [Bookinfo](/zh/docs/examples/bookinfo/) 的样例代码作为示例。
|
此任务使用 [Bookinfo](/zh/docs/examples/bookinfo/) 的样例代码作为示例。
|
||||||
|
|
||||||
## 开始之前{#before-you-begin}
|
## 开始之前 {#before-you-begin}
|
||||||
|
|
||||||
1. 确保您有一个 Lightstep 账户。这里可以免费[注册](https://lightstep.com/products/tracing/)试用 Lightstep。
|
1. 确保您有一个 Lightstep 账户，这里可以免费[注册](https://lightstep.com/products/tracing/)试用 Lightstep。
|
||||||
|
|
||||||
1. 如果您使用的是[本地 Satellite](https://docs.lightstep.com/docs/learn-about-satellites#on-premise-satellites)，
|
1. 如果您使用的是[本地 Satellite](https://docs.lightstep.com/docs/learn-about-satellites#on-premise-satellites)，
|
||||||
请确保您有一个配置了 TLS 证书的 Satellite 池和一个公开的安全 GRPC 端口。
|
请确保您有一个配置了 TLS 证书的 Satellite 池和一个公开的安全 GRPC 端口。
|
||||||
请参阅[安装和配置 Satellite](https://docs.lightstep.com/docs/install-and-configure-satellites)
|
请参阅[安装和配置 Satellite](https://docs.lightstep.com/docs/install-and-configure-satellites)
|
||||||
获取更多有关设置 Satellite 的细节。
|
获取有关 Satellite 配置的更多细节。
|
||||||
|
|
||||||
对于 [Lightstep 公共 Satellite](https://docs.lightstep.com/docs/learn-about-satellites#public-satellites)
|
对于[公共 Lightstep Satellite](https://docs.lightstep.com/docs/learn-about-satellites#public-satellites)
|
||||||
或[开发者模式 Satellite](https://docs.lightstep.com/docs/learn-about -satellites#developer-satellites)，
|
或[开发者模式 Satellite](https://docs.lightstep.com/docs/learn-about -satellites#developer-satellites)来说，
|
||||||
您的 Satellite 已经配置好了。但是，您需要将[此证书](https://docs.lightstep.com/docs/instrument-with-istio-as-your-service-mesh#cacertpem-file)下载到本地目录。
|
请确保您的 Satellite 已经配置完成，并将[此证书](https://docs.lightstep.com/docs/instrument-with-istio-as-your-service-mesh#cacertpem-file)下载到本地目录。
|
||||||
|
|
||||||
1. 确保您有 Lightstep 的[访问令牌](https://docs.lightstep.com/docs/create-and-manage-access-tokens)。
|
1. 确保您有 Lightstep 的[访问令牌](https://docs.lightstep.com/docs/create-and-manage-access-tokens)，
|
||||||
访问令牌允许您的应用程序与您的 Lightstep 项目进行通信。
|
访问令牌允许您的应用程序与您的 Lightstep 项目进行通信。
|
||||||
|
|
||||||
## 部署 Istio{#deploy-istio}
|
## 部署 Istio {#deploy-istio}
|
||||||
|
|
||||||
如何部署 Istio 取决于您使用的 Satellite 类型。
|
如何部署 Istio 取决于您使用的 Satellite 类型。
|
||||||
|
|
||||||
### 使用本地 Satellite 部署 Istio{#deploy-istio-with-on-premise- satellites}
|
### 使用本地 Satellite 部署 Istio {#deploy-istio-with-on-premise- satellites}
|
||||||
|
|
||||||
这些说明不假定使用 TLS。如果您为 Satellite 池使用 TLS，
|
这些说明假定不使用 TLS。如果您为 Satellite 池使用 TLS，
|
||||||
请遵循[公共 Satellite 池](#deploy-istio-with-public-or-developer-mode-satellites)的配置，
|
请遵循[公共 Satellite 池](#deploy-istio-with-public-or-developer-mode-satellites)的配置，
|
||||||
但使用您自己的证书和您自己的池的端点（`host:port`）。
|
但需使用您自己的证书和您自己的池的端点（`host:port`）。
|
||||||
|
|
||||||
1. 您需要用 Satellite 地址部署 Istio，地址格式为`<主机>：<端口>`，例如 `lightstep-satellite.lightstep:9292`。
|
1. 您需要用 Satellite 地址部署 Istio，地址格式为`<主机>:<端口>`，例如 `lightstep-satellite.lightstep:9292`。
|
||||||
可以在您的[配置](https://docs.lightstep.com/docs/satellite-configuration-parameters#ports)文件中找到这个地址。
|
可以在您的[配置](https://docs.lightstep.com/docs/satellite-configuration-parameters#ports)文件中找到这个地址。
|
||||||
|
|
||||||
1. 使用以下指定的配置参数部署 Istio：
|
1. 使用以下指定的配置参数部署 Istio：
|
||||||
|
|
@ -69,13 +69,15 @@ test: no
|
||||||
--set meshConfig.defaultConfig.tracing.lightstep.accessToken="<access-token>" \
|
--set meshConfig.defaultConfig.tracing.lightstep.accessToken="<access-token>" \
|
||||||
{{< /text >}}
|
{{< /text >}}
|
||||||
|
|
||||||
### 使用公共或开发者模式 Satellite 部署 Istio{#deploy-istio-with-public-or-developer-mode-satellites}
|
### 使用公共或开发者模式 Satellite 部署 Istio {#deploy-istio-with-public-or-developer-mode-satellites}
|
||||||
|
|
||||||
如果您使用的是公共或开发者模式 Satellite，或者如果您使用的是带有 TLS 证书的本地 Satellite，请按照这些步骤操作。
|
如果您使用的是公共或开发者模式 Satellite，或者如果您使用的是带有 TLS 证书的本地 Satellite，
|
||||||
|
请按照这些步骤操作。
|
||||||
|
|
||||||
1. 把 Satellite 池证书颁发机构发的证书作为一个 Secret 存储在默认的命名空间下。
|
1. 把 Satellite 池证书颁发机构发的证书作为一个 Secret 存储在 `default` 和 `istio-system` 命名空间下，
|
||||||
对于 Lightstep Tracing 用户，要在这里下载并使用[这个证书](https://docs.lightstep.com/docs/instrument-with-istio-as-your-service-mesh)。
|
后者供 Istio 网关使用。
|
||||||
如果您把 Bookinfo 应用程序部署在了其它的命名空间下，就要在对应的命名空间下创建相应的 Secret。
|
下载并使用[这个证书](https://docs.lightstep.com/docs/instrument-with-istio-as-your-service-mesh)。
|
||||||
|
如果您把 Bookinfo 应用程序部署在了其它命名空间中，就要在对应的命名空间中创建相应的 Secret。
|
||||||
|
|
||||||
{{< text bash >}}
|
{{< text bash >}}
|
||||||
$ CACERT=$(cat Cert_Auth.crt | base64) # Cert_Auth.crt contains the necessary CACert
|
$ CACERT=$(cat Cert_Auth.crt | base64) # Cert_Auth.crt contains the necessary CACert
|
||||||
|
|
@ -112,12 +114,12 @@ test: no
|
||||||
sampling: 100
|
sampling: 100
|
||||||
tlsSettings
|
tlsSettings
|
||||||
mode: "SIMPLE"
|
mode: "SIMPLE"
|
||||||
# Specifying ca certificate here will moute `lightstep.cacert` secret volume
|
# 默认情况下，在此处指定 CA 证书将在所有 Sidecar 上挂载
|
||||||
# at all sidecars by default.
|
# "lightstep.cacert" Secret 卷。
|
||||||
caCertificates="/etc/lightstep/cacert.pem"
|
caCertificates="/etc/lightstep/cacert.pem"
|
||||||
components:
|
components:
|
||||||
ingressGateways:
|
ingressGateways:
|
||||||
# `lightstep.cacert` secret volume needs to be mount at gateways via k8s overlay.
|
# `lightstep.cacert` Secret 卷需要通过 k8s 覆盖安装在网关上。
|
||||||
- name: istio-ingressgateway
|
- name: istio-ingressgateway
|
||||||
enabled: true
|
enabled: true
|
||||||
k8s:
|
k8s:
|
||||||
|
|
@ -138,60 +140,64 @@ test: no
|
||||||
optional: true
|
optional: true
|
||||||
{{< /text >}}
|
{{< /text >}}
|
||||||
|
|
||||||
## 安装并运行 Bookinfo 应用程序{#install-and-run-the-bookinfo-app}
|
## 安装并运行 Bookinfo 应用程序 {#install-and-run-the-bookinfo-app}
|
||||||
|
|
||||||
1. 按照[部署 Bookinfo 示例应用程序的说明](/zh/docs/examples/bookinfo/#deploying-the-application).
|
1. 参照[部署 Bookinfo 示例应用程序的说明](/zh/docs/examples/bookinfo/#deploying-the-application)。
|
||||||
|
|
||||||
1. 按照[为 Bookinfo 应用程序创建 Ingress 网关说明](/zh/docs/examples/bookinfo/#determine-the-ingress-ip-and-port)操作。
|
1. 参照[为 Bookinfo 应用程序创建 Ingress 网关说明](/zh/docs/examples/bookinfo/#determine-the-ingress-ip-and-port)操作。
|
||||||
|
|
||||||
1. 为了验证上一步是否成功，请确认您在 shell 的环境变量中中设置了 `GATEWAY_URL`。
|
1. 为了验证上一步是否成功，请确认您在 shell 的环境变量中设置了 `GATEWAY_URL`。
|
||||||
|
|
||||||
1. 发送流量到示例应用程序。
|
1. 发送请求到示例应用：
|
||||||
|
|
||||||
{{< text bash >}}
|
{{< text bash >}}
|
||||||
$ curl http://$GATEWAY_URL/productpage
|
$ curl http://$GATEWAY_URL/productpage
|
||||||
{{< /text >}}
|
{{< /text >}}
|
||||||
|
|
||||||
## 可视化追踪数据{#visualize-trace-data}
|
## 可视化追踪数据 {#visualize-trace-data}
|
||||||
|
|
||||||
1. 打开 Lightstep [web UI](https://app.lightstep.com/)。您会在服务目录中看到三个 Bookinfo 服务。
|
1. 打开 Lightstep [Web UI](https://app.lightstep.com/)，您会在服务目录中看到三个 Bookinfo 服务：
|
||||||
|
|
||||||
{{< image link="./istio-services.png" caption="Bookfinder services in the Service Directory" >}}
|
{{< image link="./istio-services.png" caption="Bookfinder services in the Service Directory" >}}
|
||||||
|
|
||||||
1. 导航到 Explorer 视图。
|
1. 导航到 Explorer 视图：
|
||||||
|
|
||||||
{{< image link="./istio-explorer.png" caption="Explorer view" >}}
|
{{< image link="./istio-explorer.png" caption="Explorer view" >}}
|
||||||
|
|
||||||
1. 在顶部找到查询栏，在这里您可以用 **Service** 、**Operation** 和 **Tag** 的值进行过滤查询。
|
1. 在顶部找到查询栏，在这里您可以用 **Service** 、**Operation** 和 **Tag** 的值进行过滤查询：
|
||||||
|
|
||||||
1. 从 **Service** 下拉列表中选择 `productpage.default`。
|
1. 从 **Service** 下拉列表中选择 `productpage.default`。
|
||||||
|
|
||||||
1. 点击 **Run** 。可以看到如下类似的内容：
|
1. 点击 **Run**，可以看到如下类似的内容：
|
||||||
|
|
||||||
{{< image link="./istio-tracing-list-lightstep.png" caption="Explorer" >}}
|
{{< image link="./istio-tracing-list-lightstep.png" caption="Explorer" >}}
|
||||||
|
|
||||||
1. 在延迟直方图下面点击示例追踪表格的第一行，就可以查看 `/productpage` 刷新后的详细信息。该页面类似下面：
|
1. 在延迟直方图下面点击示例追踪表格的第一行，就可以查看 `/productpage` 刷新后的详细信息，该页面类似下面：
|
||||||
|
|
||||||
{{< image link="./istio-tracing-details-lightstep.png" caption="Detailed Trace View" >}}
|
{{< image link="./istio-tracing-details-lightstep.png" caption="Detailed Trace View" >}}
|
||||||
|
|
||||||
这个截图显示了该追踪是由一组 span 组成。每一个 span 对应着在执行 `/productpage` 请求期间调用的一个 Bookinfo 服务。
|
这个截图显示了该追踪是由一组 span 组成，每一个 span 对应着在执行 `/productpage`
|
||||||
|
请求期间调用的一个 Bookinfo 服务。
|
||||||
|
|
||||||
追踪中的两个 span 表示一个 RPC 请求。例如从 `productpage` 到 `reviews` 的请求调用，
|
链路追踪中的两个 span 表示一个 RPC 请求。例如从 `productpage` 到 `reviews` 的请求调用，
|
||||||
以操作标签 `reviews.default.svc.cluster.local:9080/*` 和服务标签
|
以操作标签 `reviews.default.svc.cluster.local:9080/*` 和服务标签
|
||||||
`productpage.default: proxy client` 的 span 开始。该服务表示是这个调用的客户端 span。
|
`productpage.default: proxy client` 的 span 开始。该服务表示是这个调用的客户端 span，
|
||||||
截图显示此次调用耗时 15.30 毫秒。第二个 span 标记有操作标签 `reviews.default.svc.cluster.local:9080/*`
|
截图显示此次调用耗时 15.30 毫秒。第二个 span 标记有操作标签 `reviews.default.svc.cluster.local:9080/*`、
|
||||||
操作和服务标签 `reviews.default: proxy server`。第二个 span 是第一个 span 的下一级，
|
操作和服务标签 `reviews.default: proxy server`。
|
||||||
表示调用的服务端 span。截图显示此次调用耗时 14.60 毫秒。
|
第二个 span 是第一个 span 的下一级，表示调用的服务端 span，
|
||||||
|
截图显示此次调用耗时 14.60 毫秒。
|
||||||
|
|
||||||
## 追踪采样{#trace-sampling}
|
## 追踪采样 {#trace-sampling}
|
||||||
|
|
||||||
Istio 通过配置追踪采样百分比来捕获追踪信息。想了解如何修改追踪采样百分比，
|
Istio 通过配置追踪采样百分比来捕获追踪信息。想了解如何修改追踪采样百分比，
|
||||||
请访问[分布式追踪采样部分](/zh/docs/tasks/observability/distributed-tracing/mesh-and-proxy-config/#customizing-trace-sampling)。
|
请访问[分布式追踪采样部分](/zh/docs/tasks/observability/distributed-tracing/mesh-and-proxy-config/#customizing-trace-sampling)。
|
||||||
使用 Lightstep 时，我们不建议将追踪采样的百分比降低到 100% 以下。要处理高流量的网格，请考虑扩大您的 Satellite 池的大小。
|
使用 Lightstep 时，我们不建议将追踪采样的百分比降低到 100% 以下。要处理高流量的网格，
|
||||||
|
请考虑扩大您的 Satellite 池的大小。
|
||||||
|
|
||||||
## 清除{#cleanup}
|
## 清除 {#cleanup}
|
||||||
|
|
||||||
如果您不想继续执测试操作任务，可以从集群中删除 Bookinfo 示例应用程序和所有的 Lightstep Secret。
|
如果您不想继续执测试操作任务，可以从集群中删除 Bookinfo 示例应用程序和所有的
|
||||||
|
Lightstep Secret。
|
||||||
|
|
||||||
1. 删除 Bookinfo 应用程序，请参阅[清除 Bookinfo](/zh/docs/examples/bookinfo/#cleanup) 说明。
|
1. 删除 Bookinfo 应用程序，请参阅[清除 Bookinfo](/zh/docs/examples/bookinfo/#cleanup) 说明。
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue