mirror of https://github.com/knative/docs.git
Update to include support for deploying Jaeger and accessing its UI (#1154)
* Update to include support for deploying Jaeger and accessing its UI * Update table * Update docs/serving/installing-logging-metrics-traces.md Co-Authored-By: objectiser <gary@brownuk.com> * Applied review comments * nitpick * Changed url version from 0.5.0 to 0.6.0 * Fix Jaeger UI URL
This commit is contained in:
Gary Brown
Knative Prow Robot
parent
7d4d5bedab
commit
0f93e2b513
|
|
@ -171,6 +171,8 @@ The following Knative installation files are available:
|
|||
- https://github.com/knative/serving/releases/download/v0.5.2/monitoring.yaml
|
||||
- https://github.com/knative/serving/releases/download/v0.5.2/monitoring-logs-elasticsearch.yaml
|
||||
- https://github.com/knative/serving/releases/download/v0.5.2/monitoring-metrics-prometheus.yaml
|
||||
- https://github.com/knative/serving/releases/download/v0.6.0/monitoring-tracing-jaeger.yaml
|
||||
- https://github.com/knative/serving/releases/download/v0.6.0/monitoring-tracing-jaeger-in-mem.yaml
|
||||
- https://github.com/knative/serving/releases/download/v0.5.2/monitoring-tracing-zipkin.yaml
|
||||
- https://github.com/knative/serving/releases/download/v0.5.2/monitoring-tracing-zipkin-in-mem.yaml
|
||||
- **Build Component**:
|
||||
|
|
@ -206,8 +208,10 @@ files from the Knative repositories:
|
|||
| [`monitoring.yaml`][1.2]† | Installs the [ELK stack][2], [Prometheus][2.1], [Grafana][2.2], and [Zipkin][2.3]**\*** | Serving component |
|
||||
| [`monitoring-logs-elasticsearch.yaml`][1.3] | Installs only the [ELK stack][2]**\*** | Serving component |
|
||||
| [`monitoring-metrics-prometheus.yaml`][1.4] | Installs only [Prometheus][2.1]**\*** | Serving component |
|
||||
| [`monitoring-tracing-zipkin.yaml`][1.5] | Installs only [Zipkin][2.3].**\*** | Serving component, ELK stack (monitoring-logs-elasticsearch.yaml) |
|
||||
| [`monitoring-tracing-zipkin-in-mem.yaml`][1.6] | Installs only [Zipkin in-memory][2.3]**\*** | Serving component |
|
||||
| [`monitoring-tracing-jaeger.yaml`][1.5] | Installs only [Jaeger][2.4].**\*** | Serving component, ELK stack (monitoring-logs-elasticsearch.yaml) |
|
||||
| [`monitoring-tracing-jaeger-in-mem.yaml`][1.6] | Installs only [Jaeger in-memory][2.4]**\*** | Serving component |
|
||||
| [`monitoring-tracing-zipkin.yaml`][1.7] | Installs only [Zipkin][2.3].**\*** | Serving component, ELK stack (monitoring-logs-elasticsearch.yaml) |
|
||||
| [`monitoring-tracing-zipkin-in-mem.yaml`][1.8] | Installs only [Zipkin in-memory][2.3]**\*** | Serving component |
|
||||
| **knative/build** | | |
|
||||
| [`build.yaml`][3.1]† | Installs the Build component. | Cluster roles enabled, if interacting with Serving |
|
||||
| **knative/eventing** | | |
|
||||
|
|
@ -241,13 +245,18 @@ for details about installing the various supported observability plugins.
|
|||
[1.4]:
|
||||
https://github.com/knative/serving/releases/download/v0.5.2/monitoring-metrics-prometheus.yaml
|
||||
[1.5]:
|
||||
https://github.com/knative/serving/releases/download/v0.5.2/monitoring-tracing-zipkin.yaml
|
||||
https://github.com/knative/serving/releases/download/v0.6.0/monitoring-tracing-jaeger.yaml
|
||||
[1.6]:
|
||||
https://github.com/knative/serving/releases/download/v0.6.0/monitoring-tracing-jaeger-in-mem.yaml
|
||||
[1.7]:
|
||||
https://github.com/knative/serving/releases/download/v0.5.2/monitoring-tracing-zipkin.yaml
|
||||
[1.8]:
|
||||
https://github.com/knative/serving/releases/download/v0.5.2/monitoring-tracing-zipkin-in-mem.yaml
|
||||
[2]: https://www.elastic.co/elk-stack
|
||||
[2.1]: https://prometheus.io
|
||||
[2.2]: https://grafana.com
|
||||
[2.3]: https://zipkin.io/
|
||||
[2.4]: https://jaegertracing.io/
|
||||
[3]: https://github.com/knative/build/releases/tag/v0.5.2
|
||||
[3.1]: https://github.com/knative/build/releases/download/v0.5.0/build.yaml
|
||||
[4]: https://github.com/knative/eventing/releases/tag/v0.5.2
|
||||
|
|
|
|||
|
|
@ -5,10 +5,14 @@ weight: 15
|
|||
type: "docs"
|
||||
---
|
||||
|
||||
Depending on the request tracing tool that you have installed on your Knative Serving cluster, see the corresponding section for details about how to visualize and trace your requests.
|
||||
|
||||
If you have not yet installed the logging and monitoring components, go through
|
||||
the [installation instructions](./installing-logging-metrics-traces.md) to set
|
||||
up the necessary components.
|
||||
|
||||
## Zipkin
|
||||
|
||||
In order to access request traces, you use the Zipkin visualization tool.
|
||||
|
||||
1. To open the Zipkin UI, enter the following command:
|
||||
|
|
@ -29,6 +33,27 @@ In order to access request traces, you use the Zipkin visualization tool.
|
|||
|
||||
<!--TODO: Consider adding a video here. -->
|
||||
|
||||
## Jaeger
|
||||
|
||||
In order to access request traces, you use the Jaeger visualization tool.
|
||||
|
||||
1. To open the Jaeger UI, enter the following command:
|
||||
|
||||
```shell
|
||||
kubectl proxy
|
||||
```
|
||||
|
||||
This command starts a local proxy of Jaeger on port 8001. For security
|
||||
reasons, the Jaeger UI is exposed only within the cluster.
|
||||
|
||||
1. Navigate to the
|
||||
[Jaeger UI](http://localhost:8001/api/v1/namespaces/istio-system/services/jaeger-query:16686/proxy/search/).
|
||||
|
||||
1. Select the service of interest and click "Find Traces" to see the latest traces. Click on a trace to see a
|
||||
detailed view of a specific call.
|
||||
|
||||
<!--TODO: Consider adding a video here. -->
|
||||
|
||||
---
|
||||
|
||||
Except as otherwise noted, the content of this page is licensed under the
|
||||
|
|
|
|||
|
|
@ -226,7 +226,13 @@ To configure and setup monitoring:
|
|||
See [Accessing Logs](./accessing-logs.md) for more information about logs in
|
||||
Knative.
|
||||
|
||||
## End to end traces
|
||||
## End to end request tracing
|
||||
|
||||
You can choose from one of the following options to enable request tracing in your Knative Serving cluster.
|
||||
|
||||
**Important**: Your cluster supports only a single request trace tool. If you want to replace a currently installed request trace tool, you must first uninstall that tool before installing the new tool.
|
||||
|
||||
### Zipkin
|
||||
|
||||
- If Elasticsearch is not installed or if you don't want to persist end to end
|
||||
traces, run:
|
||||
|
|
@ -253,6 +259,33 @@ Knative.
|
|||
Visit [Accessing Traces](./accessing-traces.md) for more information on end to
|
||||
end traces.
|
||||
|
||||
### Jaeger
|
||||
|
||||
- If Elasticsearch is not installed or if you don't want to persist end to end
|
||||
traces, run:
|
||||
|
||||
```shell
|
||||
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/monitoring-tracing-jaeger-in-mem.yaml
|
||||
```
|
||||
|
||||
- If Elasticsearch is installed and you want to persist end to end traces, first
|
||||
run:
|
||||
|
||||
```shell
|
||||
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.5.0/monitoring-tracing-jaeger.yaml
|
||||
```
|
||||
|
||||
Next, create an Elasticsearch index for end to end traces:
|
||||
|
||||
- Open Kibana UI as described in
|
||||
[Create Elasticsearch Indices](#create-elasticsearch-indices) section.
|
||||
- Select `Create Index Pattern` button on top left of the page. Enter
|
||||
`jaeger*` to `Index pattern` and select `timestamp_millis` from
|
||||
`Time Filter field name` and click on `Create` button.
|
||||
|
||||
Visit [Accessing Traces](./accessing-traces.md) for more information on end to
|
||||
end traces.
|
||||
|
||||
## Learn More
|
||||
|
||||
- Learn more about accessing logs, metrics, and traces:
|
||||
|
|
|
|||
Loading…
Reference in New Issue