dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove references to Open Census (#1212) 

* Correct the language about OpenTelemetry protocol

* Remove references to OpenCensus

* Update tracing-overview.md

* Update jaeger.md

* Update zipkin.md

* Update setup-tracing.md

* Update setup-tracing.md

Co-authored-by: Mark Fussell <mfussell@microsoft.com>
This commit is contained in:
Nghia Tran 2021-02-14 13:42:51 -08:00 committed by GitHub
parent 6a5e1c9d8a
commit 7f37a4914f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 26 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
daprdocs/content/en/developing-applications/building-blocks/observability/tracing-overview.md
View File

@ -14,7 +14,7 @@ Dapr uses the Zipkin protocol for distributed traces and metrics collection. Due
Dapr adds a HTTP/gRPC middleware to the Dapr sidecar. The middleware intercepts all Dapr and application traffic and automatically injects correlation IDs to trace distributed transactions. This design has several benefits:
* No need for code instrumentation. All traffic is automatically traced (with configurable tracing levels).
* No need for code instrumentation. All traffic is automatically traced with configurable tracing levels.
* Consistent tracing behavior across microservices. Tracing is configured and managed on Dapr sidecar so that it remains consistent across services made by different teams and potentially written in different programming languages.
* Configurable and extensible. By leveraging the Zipkin API and the OpenTelemetry Collector, Dapr tracing can be configured to work with popular tracing backends, including custom backends a customer may have.
* You can define and enable multiple exporters at the same time.
@ -27,7 +27,7 @@ Read [W3C distributed tracing]({{< ref w3c-tracing >}}) for more background on W
## Configuration
Dapr uses [probabilistic sampling](https://opencensus.io/tracing/sampling/probabilistic/) as defined by OpenCensus. The sample rate defines the probability a tracing span will be sampled and can have a value between 0 and 1 (inclusive). The deafault sample rate is 0.0001 (i.e. 1 in 10,000 spans is sampled).
Dapr uses probabilistic sampling. The sample rate defines the probability a tracing span will be sampled and can have a value between 0 and 1 (inclusive). The default sample rate is 0.0001 (i.e. 1 in 10,000 spans is sampled).
To change the default tracing behavior, use a configuration file (in self hosted mode) or a Kubernetes configuration object (in Kubernetes mode). For example, the following configuration object changes the sample rate to 1 (i.e. every span is sampled), and sends trace using Zipkin protocol to the Zipkin server at http://zipkin.default.svc.cluster.local
@ -44,7 +44,7 @@ spec:
endpointAddress: "http://zipkin.default.svc.cluster.local:9411/api/v2/spans"
```
Changing `samplingRate` to 0 will disable tracing altogether.
Note: Changing `samplingRate` to 0 disables tracing altogether.
See the [References](#references) section for more details on how to configure tracing on local environment and Kubernetes environment.

14
daprdocs/content/en/operations/monitoring/tracing/backends/jaeger.md
View File

@ -6,9 +6,10 @@ weight: 3000
description: "Set up Jaeger for distributed tracing"
type: docs
---
Dapr currently supports two kind of tracing protocol: OpenCensus and
Zipkin. Since Jaeger is compatible with Zipkin, the Zipkin
protocol can be used to talk to Jaeger.
Dapr currently supports the Zipkin protocol. Since Jaeger is
compatible with Zipkin, the Zipkin protocol can be used to talk to
Jaeger.
## Configure self hosted mode
@ -54,8 +55,7 @@ dapr run --app-id mynode --app-port 3000 node app.js --config config.yaml
```
### Viewing Traces
To view traces, in your browser go to http://localhost:16686 and you
will see the Zipkin UI.
To view traces, in your browser go to http://localhost:16686 and you will see the Jaeger UI.
## Configure Kubernetes
The following steps shows you how to configure Dapr to send distributed tracing data to Jaeger running as a container in your Kubernetes cluster, how to view them.
@ -68,7 +68,7 @@ First create the following YAML file to install Jaeger
apiVersion: jaegertracing.io/v1
kind: "Jaeger"
metadata:
name: "jaeger"
name: jaeger
spec:
strategy: allInOne
ingress:
@ -121,7 +121,7 @@ annotations:
dapr.io/config: "tracing"
```
That's it! your sidecar is now configured for use with Jaeger.
That's it! Your Dapr sidecar is now configured for use with Jaeger.
### Viewing Tracing Data

9
daprdocs/content/en/operations/monitoring/tracing/backends/zipkin.md
View File

@ -36,7 +36,7 @@ Launch Zipkin using Docker:
docker run -d -p 9411:9411 openzipkin/zipkin
```
3. The applications launched with `dapr run` will by default reference the config file in `$HOME/.dapr/config.yaml` or `%USERPROFILE%\.dapr\config.yaml` and can be overridden with the Dapr CLI using the `--config` param:
3. The applications launched with `dapr run` by default reference the config file in `$HOME/.dapr/config.yaml` or `%USERPROFILE%\.dapr\config.yaml` and can be overridden with the Dapr CLI using the `--config` param:
```bash
dapr run --app-id mynode --app-port 3000 node app.js
@ -46,7 +46,7 @@ To view traces, in your browser go to http://localhost:9411 and you will see the
## Configure Kubernetes
The following steps shows you how to configure Dapr to send distributed tracing data to Zipkin running as a container in your Kubernetes cluster, how to view them.
The following steps shows you how to configure Dapr to send distributed tracing data to Zipkin running as a container in your Kubernetes cluster, and how to view them.
### Setup
@ -92,11 +92,11 @@ annotations:
dapr.io/config: "tracing"
```
That's it! your sidecar is now configured for use with Open Census and Zipkin.
That's it! Your sidecar is now configured to send traces to Zipkin.
### Viewing Tracing Data
To view traces, connect to the Zipkin Service and open the UI:
To view traces, connect to the Zipkin service and open the UI:
```bash
kubectl port-forward svc/zipkin 9411:9411
@ -107,4 +107,5 @@ In your browser, go to `http://localhost:9411` and you will see the Zipkin UI.
![zipkin](/images/zipkin_ui.png)
## References
- [Zipkin for distributed tracing](https://zipkin.io/)
- [W3C distributed tracing]({{< ref w3c-tracing >}})

18
daprdocs/content/en/operations/monitoring/tracing/setup-tracing.md
View File

@ -6,8 +6,10 @@ weight: 100
description: "Configure Dapr to send distributed tracing data"
---
It is recommended to run Dapr with tracing enabled for any production scenario.
Since Dapr uses Open Census, you can configure various exporters for tracing and telemetry data based on your environment, whether it is running in the cloud or on-premises.
It is recommended to run Dapr with tracing enabled for any production
scenario. You can configure Dapr to send tracing and telemetry data
to many backends based on your environment, whether it is running in
the cloud or on-premises.
## Tracing configuration
@ -29,13 +31,13 @@ The following table lists the properties for tracing:
| `zipkin.endpointAddress` | string | Set the Zipkin server address.
## Zipkin in stand-alone mode
## Zipkin in self hosted mode
The following steps show you how to configure Dapr to send distributed tracing data to Zipkin running as a container on your local machine and view them.
For Standalone mode, create a Dapr configuration file locally and reference it with the Dapr CLI.
For self hosted mode, create a Dapr configuration file locally and reference it with the Dapr CLI.
1. Create the following YAML file:
1. Create the following `config.yaml` YAML file:
```yaml
apiVersion: dapr.io/v1alpha1
@ -56,7 +58,7 @@ For Standalone mode, create a Dapr configuration file locally and reference it w
docker run -d -p 9411:9411 openzipkin/zipkin
```
3. Launch Dapr with the `--config` param:
3. Launch Dapr with the `--config` param with the path for where the `config.yaml` is saved :
```bash
dapr run --app-id mynode --app-port 3000 --config ./config.yaml node app.js
@ -109,7 +111,7 @@ annotations:
dapr.io/config: "zipkin"
```
That's it! Your sidecar is now configured for use with Open Census and Zipkin.
That's it! Your sidecar is now configured for use with Zipkin.
### Viewing Tracing Data
@ -123,3 +125,5 @@ On your browser, go to ```http://localhost:9411``` and you should see the Zipkin
![zipkin](/images/zipkin_ui.png)
## References
- [Zipkin for distributed tracing](https://zipkin.io/)