From 3fc24f9ba7ccec1d87a25db932efdaf7604a7027 Mon Sep 17 00:00:00 2001 From: Shalabh Mohan Shrivastava Date: Fri, 1 May 2020 10:00:15 -0700 Subject: [PATCH] updating the document for tracing configuration --- concepts/observability/traces.md | 2 +- howto/diagnose-with-tracing/azure-monitor.md | 20 ++++++++------------ 2 files changed, 9 insertions(+), 13 deletions(-) diff --git a/concepts/observability/traces.md b/concepts/observability/traces.md index 0b9258122..855802618 100644 --- a/concepts/observability/traces.md +++ b/concepts/observability/traces.md @@ -39,7 +39,7 @@ spec: ``` `samplingRate` is used to enable or disable the tracing. To disable the sampling rate , -set `samplingRate : "0"` in the configuration. The valid range of samplingRate is between 0 and 1 inclusive. The sampling rate determines whether a trace span should be sampled or not based. By default, the sampling rate is 1 in 10,000. +set `samplingRate : "0"` in the configuration. The valid range of samplingRate is between 0 and 1 inclusive. The sampling rate determines whether a trace span should be sampled or not based on vallue. `samplingRate : "1"` will always sample the traces.By default, the sampling rate is 1 in 10,000 Please see the [References](#references) section for more details on how to configure tracing on local environment and Kubernetes environment. diff --git a/howto/diagnose-with-tracing/azure-monitor.md b/howto/diagnose-with-tracing/azure-monitor.md index 72adcdbf1..c6ceeeafc 100644 --- a/howto/diagnose-with-tracing/azure-monitor.md +++ b/howto/diagnose-with-tracing/azure-monitor.md @@ -65,9 +65,7 @@ metadata: name: tracing spec: tracing: - enabled: true - expandParams: true - includeBody: true + samplingRate: "1" ``` 3. When running in the local self hosted mode, you need to launch Dapr with the `--config` parameter: @@ -121,9 +119,7 @@ metadata: name: tracing spec: tracing: - enabled: true - expandParams: true - includeBody: true + samplingRate: "1" ``` 5. Use kubectl to apply the above CRD files: @@ -168,15 +164,15 @@ The `tracing` section under the `Configuration` spec contains the following prop ```yml tracing: - enabled: true - expandParams: true - includeBody: true + samplingRate: "1" ``` The following table lists the different properties. Property | Type | Description ---- | ------- | ----------- -enabled | bool | Set tracing to be enabled or disabled -expandParams | bool | When true, expands parameters passed to HTTP endpoints -includeBody | bool | When true, includes the request body in the tracing event +samplingRate | string | Set sampling rate for tracing to be enabled or disabled. + + +`samplingRate` is used to enable or disable the tracing. To disable the sampling rate , +set `samplingRate : "0"` in the configuration. The valid range of samplingRate is between 0 and 1 inclusive. The sampling rate determines whether a trace span should be sampled or not based on vallue. `samplingRate : "1"` will always sample the traces.By default, the sampling rate is 1 in 10,000