Update tracing.md (#54)

* Update tracing.md

* Minor updates. Please review
This commit is contained in:
Yaron Schneider 2019-10-04 09:21:50 -07:00 committed by GitHub
parent 081e5b032c
commit f70137c47a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 15 deletions

View File

@ -1,14 +1,13 @@
# Tracing
Actions integrates seamlessly with Open Census for telemtry and tracing.
Visit our [Distributed Tracing](../distributed_tracing.md) section for more info.
Dapr integrates with Open Census for telemtry and tracing.
It is recommended to run Actions with tracing enabled for any production scenario.
Since Actions uses Open Census, you can configure various exporters for tracing and telemtry 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.
Since Dapr uses Open Census, you can configure various exporters for tracing and telemtry data based on your environment, whether it is running in the cloud or on-premises.
## Distributed Tracing with Zipkin on Kubernetes
The following steps will show you how to configure Actions to send distributed tracing data to Zipkin running as a container in your Kubernetes cluster, and how to view them.
The following steps show 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
@ -28,7 +27,7 @@ kubectl expose deploy zipkin --type ClusterIP --port 9411
Next, create the following YAML file locally:
```
apiVersion: actions.io/v1alpha1
apiVersion: dapr.io/v1alpha1
kind: Configuration
metadata:
name: zipkin
@ -41,24 +40,24 @@ spec:
includeBody: true
```
Finally, deploy the Actions configuration:
Finally, deploy the Dapr configuration:
```
kubectl apply -f config.yaml
```
In order to enable this configuration for your Actions sidecar, add the following annotation to your pod spec template:
In order to enable this configuration for your Dapr sidecar, add the following annotation to your pod spec template:
```
annotations:
actions.io/config: "zipkin"
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 Open Census and 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:
```
kubectl port-forward svc/zipkin 9411:9411
@ -69,13 +68,15 @@ On your browser, go to ```http://localhost:9411``` and you should see the Zipkin
![zipkin](../imgs/zipkin_ui.png)
## Distributed Tracing with Zipkin - Standalone 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 an Actions Configuration CRD file locally and reference it with the Actions CLI.
For Standalone mode, create a Dapr configuration file locally and reference it with the Dapr CLI.
1. Create the following YAML file:
```
apiVersion: actions.io/v1alpha1
apiVersion: dapr.io/v1alpha1
kind: Configuration
metadata:
name: zipkin
@ -94,10 +95,10 @@ spec:
docker run -d -p 9411:9411 openzipkin/zipkin
```
3. Launch Actions with the `--config` param:
3. Launch Dapr with the `--config` param:
```
actions run --app-id mynode --app-port 3000 --config ./cofig.yaml node app.js
dapr run --app-id mynode --app-port 3000 --config ./cofig.yaml node app.js
```
## Tracing Configuration