diff --git a/daprdocs/content/en/concepts/middleware-concept.md b/daprdocs/content/en/concepts/middleware-concept.md index 8c04043e2..bdb37806c 100644 --- a/daprdocs/content/en/concepts/middleware-concept.md +++ b/daprdocs/content/en/concepts/middleware-concept.md @@ -12,7 +12,7 @@ Dapr allows custom processing pipelines to be defined by chaining a series of mi ## Customize processing pipeline -When launched, a Dapr sidecar constructs a middleware processing pipeline. By default the pipeline consists of [tracing middleware]({{< ref tracing.md >}}) and CORS middleware. Additional middleware, configured by a Dapr [configuration]({{< ref configuration-concept.md >}}), can be added to the pipeline in the order they are defined. The pipeline applies to all Dapr API endpoints, including state, pub/sub, service invocation, bindings, security and others. +When launched, a Dapr sidecar constructs a middleware processing pipeline. By default the pipeline consists of [tracing middleware]({{< ref tracing-overview.md >}}) and CORS middleware. Additional middleware, configured by a Dapr [configuration]({{< ref configuration-concept.md >}}), can be added to the pipeline in the order they are defined. The pipeline applies to all Dapr API endpoints, including state, pub/sub, service invocation, bindings, security and others. > **NOTE:** Dapr provides a **middleware.http.uppercase** pre-registered component that changes all text in a request body to uppercase. You can use it to test/verify if your custom pipeline is in place. diff --git a/daprdocs/content/en/developing-applications/building-blocks/observability/metrics.md b/daprdocs/content/en/developing-applications/building-blocks/observability/metrics-overview.md similarity index 100% rename from daprdocs/content/en/developing-applications/building-blocks/observability/metrics.md rename to daprdocs/content/en/developing-applications/building-blocks/observability/metrics-overview.md diff --git a/daprdocs/content/en/developing-applications/building-blocks/observability/tracing.md b/daprdocs/content/en/developing-applications/building-blocks/observability/tracing-overview.md similarity index 100% rename from daprdocs/content/en/developing-applications/building-blocks/observability/tracing.md rename to daprdocs/content/en/developing-applications/building-blocks/observability/tracing-overview.md diff --git a/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-howto.md b/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-howto.md index 2cf0026bf..41559467b 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-howto.md +++ b/daprdocs/content/en/developing-applications/building-blocks/observability/w3c-tracing/w3c-tracing-howto.md @@ -10,7 +10,7 @@ type: docs # How to use trace context Dapr uses W3C trace context for distributed tracing for both service invocation and pub/sub messaging. Dapr does all the heavy lifting of generating and propagating the trace context information and there are very few cases where you need to either propagate or create a trace context. First read scenarios in the [W3C distributed tracing]({{< ref w3c-tracing >}}) article to understand whether you need to propagate or create a trace context. -To view traces, read the [how to diagnose with tracing]({{< ref tracing.md >}}) article. +To view traces, read the [how to diagnose with tracing]({{< ref tracing-overview.md >}}) article. ## How to retrieve trace context from a response `Note: There are no helper methods exposed in Dapr SDKs to propagate and retrieve trace context. You need to use http/gRPC clients to propagate and retrieve trace headers through http headers and gRPC metadata.` diff --git a/daprdocs/content/en/operations/configuration/configuration-overview.md b/daprdocs/content/en/operations/configuration/configuration-overview.md index 770ff8f5c..38b6ceb46 100644 --- a/daprdocs/content/en/operations/configuration/configuration-overview.md +++ b/daprdocs/content/en/operations/configuration/configuration-overview.md @@ -73,7 +73,7 @@ The following table lists the properties for tracing: `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 value. `samplingRate : "1"` samples all traces. By default, the sampling rate is (0.0001) or 1 in 10,000 traces. -See [Observability distributed tracing]({{< ref "tracing.md" >}}) for more information +See [Observability distributed tracing]({{< ref "tracing-overview.md" >}}) for more information #### Metrics @@ -92,7 +92,7 @@ The following table lists the properties for metrics: |--------------|--------|-------------| | `enabled` | boolean | Whether metrics should to be enabled. -See [metrics documentation]({{< ref "metrics.md" >}}) for more information +See [metrics documentation]({{< ref "metrics-overview.md" >}}) for more information #### Middleware diff --git a/daprdocs/content/en/operations/monitoring/logging/_index.md b/daprdocs/content/en/operations/monitoring/logging/_index.md new file mode 100644 index 000000000..444f4cc9c --- /dev/null +++ b/daprdocs/content/en/operations/monitoring/logging/_index.md @@ -0,0 +1,8 @@ +--- +type: docs +title: "Logging" +linkTitle: "Logging" +weight: 400 +description: "How to setup loggings for Dapr sidecar, and your application" +--- + diff --git a/daprdocs/content/en/operations/monitoring/fluentd.md b/daprdocs/content/en/operations/monitoring/logging/fluentd.md similarity index 98% rename from daprdocs/content/en/operations/monitoring/fluentd.md rename to daprdocs/content/en/operations/monitoring/logging/fluentd.md index 134ec35a4..c2c0bdea2 100644 --- a/daprdocs/content/en/operations/monitoring/fluentd.md +++ b/daprdocs/content/en/operations/monitoring/logging/fluentd.md @@ -187,3 +187,4 @@ Handling connection for 5601 * [Elastic search helm chart](https://github.com/elastic/helm-charts/tree/master/elasticsearch) * [Kibana helm chart](https://github.com/elastic/helm-charts/tree/master/kibana) * [Kibana Query Language](https://www.elastic.co/guide/en/kibana/current/kuery-query.html) +* [Troubleshooting using Logs]({{< ref "logs-troubleshooting.md" >}}) diff --git a/daprdocs/content/en/operations/monitoring/metrics/_index.md b/daprdocs/content/en/operations/monitoring/metrics/_index.md new file mode 100644 index 000000000..dd7496e72 --- /dev/null +++ b/daprdocs/content/en/operations/monitoring/metrics/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Metrics" +linkTitle: "Metrics" +weight: 300 +description: "How to view Dapr metrics" +--- diff --git a/daprdocs/content/en/operations/monitoring/grafana.md b/daprdocs/content/en/operations/monitoring/metrics/grafana.md similarity index 100% rename from daprdocs/content/en/operations/monitoring/grafana.md rename to daprdocs/content/en/operations/monitoring/metrics/grafana.md diff --git a/daprdocs/content/en/operations/monitoring/prometheus.md b/daprdocs/content/en/operations/monitoring/metrics/prometheus.md similarity index 100% rename from daprdocs/content/en/operations/monitoring/prometheus.md rename to daprdocs/content/en/operations/monitoring/metrics/prometheus.md diff --git a/daprdocs/content/en/operations/monitoring/tracing/_index.md b/daprdocs/content/en/operations/monitoring/tracing/_index.md new file mode 100644 index 000000000..bd0871cde --- /dev/null +++ b/daprdocs/content/en/operations/monitoring/tracing/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Tracing" +linkTitle: "Tracing" +weight: 100 +description: "How to setup your trace backend to receive application traces from Dapr" +--- diff --git a/daprdocs/content/en/operations/monitoring/tracing/backends/_index.md b/daprdocs/content/en/operations/monitoring/tracing/backends/_index.md new file mode 100644 index 000000000..d336cb776 --- /dev/null +++ b/daprdocs/content/en/operations/monitoring/tracing/backends/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Common Tracing Backends" +linkTitle: "Common Tracing Backends" +weight: 3000 +description: "How to setup various common tracing backends" +--- diff --git a/daprdocs/content/en/operations/monitoring/azure-monitor.md b/daprdocs/content/en/operations/monitoring/tracing/backends/azure-monitor.md similarity index 100% rename from daprdocs/content/en/operations/monitoring/azure-monitor.md rename to daprdocs/content/en/operations/monitoring/tracing/backends/azure-monitor.md diff --git a/daprdocs/content/en/operations/monitoring/jaeger.md b/daprdocs/content/en/operations/monitoring/tracing/backends/jaeger.md similarity index 100% rename from daprdocs/content/en/operations/monitoring/jaeger.md rename to daprdocs/content/en/operations/monitoring/tracing/backends/jaeger.md diff --git a/daprdocs/content/en/operations/monitoring/newrelic.md b/daprdocs/content/en/operations/monitoring/tracing/backends/newrelic.md similarity index 100% rename from daprdocs/content/en/operations/monitoring/newrelic.md rename to daprdocs/content/en/operations/monitoring/tracing/backends/newrelic.md diff --git a/daprdocs/content/en/operations/monitoring/zipkin.md b/daprdocs/content/en/operations/monitoring/tracing/backends/zipkin.md similarity index 100% rename from daprdocs/content/en/operations/monitoring/zipkin.md rename to daprdocs/content/en/operations/monitoring/tracing/backends/zipkin.md diff --git a/daprdocs/content/en/operations/monitoring/open-telemetry-collector.md b/daprdocs/content/en/operations/monitoring/tracing/open-telemetry-collector.md similarity index 100% rename from daprdocs/content/en/operations/monitoring/open-telemetry-collector.md rename to daprdocs/content/en/operations/monitoring/tracing/open-telemetry-collector.md diff --git a/daprdocs/content/en/operations/troubleshooting/setup-tracing.md b/daprdocs/content/en/operations/monitoring/tracing/setup-tracing.md similarity index 96% rename from daprdocs/content/en/operations/troubleshooting/setup-tracing.md rename to daprdocs/content/en/operations/monitoring/tracing/setup-tracing.md index 468c819b4..64ca058c6 100644 --- a/daprdocs/content/en/operations/troubleshooting/setup-tracing.md +++ b/daprdocs/content/en/operations/monitoring/tracing/setup-tracing.md @@ -1,8 +1,8 @@ --- type: docs -title: "Tracing" -linkTitle: "Tracing" -weight: 3000 +title: "Configure Dapr to send distributed tracing data" +linkTitle: "Enable Dapr tracing for your application" +weight: 100 description: "Configure Dapr to send distributed tracing data" --- diff --git a/daprdocs/content/en/operations/troubleshooting/logs-troubleshooting.md b/daprdocs/content/en/operations/troubleshooting/logs-troubleshooting.md index 441beebe8..cec974ecd 100644 --- a/daprdocs/content/en/operations/troubleshooting/logs-troubleshooting.md +++ b/daprdocs/content/en/operations/troubleshooting/logs-troubleshooting.md @@ -178,3 +178,7 @@ time="2019-09-04T00:21:57Z" level=info msg="host added: 10.244.1.89" ### Non Kubernetes Environments The examples above are specific specific to Kubernetes, but the principal is the same for any kind of container based environment: simply grab the container ID of the Dapr sidecar and/or system component (if applicable) and view its logs. + +## References + +* [How to setup loggings for Dapr sidecar, and your application]({{< ref "logging.md" >}})