Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-11-06 20:16:28 -05:00
Code Issues Packages Projects Releases Wiki Activity

plugin/trace: cleanup README.md (#4280)

Browse Source 
Various improvements to the documentation. Started because `⚠️`
isn't a markdown feature (replace with Note:).

Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
2020-11-19 12:19:50 +01:00
committed by GitHub
parent 839c264a2b
commit 99f79817ac
1 changed files with 7 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
plugin/trace/README.md
View File

@@ -6,8 +6,8 @@
## Description ## Description
With *trace* you enable OpenTracing of how a request flows through CoreDNS. With *trace* you enable OpenTracing of how a request flows through CoreDNS. Enable the *debug*
Enable *debug* plugin to get logs from the trace plugin. plugin to get logs from the trace plugin.
## Syntax ## Syntax
@@ -20,7 +20,7 @@ trace [ENDPOINT-TYPE] [ENDPOINT]
* **ENDPOINT-TYPE** is the type of tracing destination. Currently only `zipkin` and `datadog` are supported. * **ENDPOINT-TYPE** is the type of tracing destination. Currently only `zipkin` and `datadog` are supported.
Defaults to `zipkin`. Defaults to `zipkin`.
* **ENDPOINT** is the tracing destination, and defaults to `localhost:9411`. For Zipkin, if * **ENDPOINT** is the tracing destination, and defaults to `localhost:9411`. For Zipkin, if
ENDPOINT does not begin with `http`, then it will be transformed to `http://ENDPOINT/api/v1/spans`. **ENDPOINT** does not begin with `http`, then it will be transformed to `http://ENDPOINT/api/v1/spans`.
With this form, all queries will be traced. With this form, all queries will be traced.
@@ -31,12 +31,6 @@ trace [ENDPOINT-TYPE] [ENDPOINT] {
every AMOUNT every AMOUNT
service NAME service NAME
client_server client_server
}
~~~
~~~
trace datadog {
every AMOUNT
service NAME
datadog_analytics_rate RATE datadog_analytics_rate RATE
} }
~~~ ~~~
@@ -47,16 +41,18 @@ trace datadog {
Default is `coredns`. Default is `coredns`.
* `client_server` will enable the `ClientServerSameSpan` OpenTracing feature. * `client_server` will enable the `ClientServerSameSpan` OpenTracing feature.
* `datadog_analytics_rate` **RATE** will enable [trace analytics](https://docs.datadoghq.com/tracing/app_analytics) on the traces sent * `datadog_analytics_rate` **RATE** will enable [trace analytics](https://docs.datadoghq.com/tracing/app_analytics) on the traces sent
from *0* to *1*, *1* being every trace sent will be analyzed. This is a datadog only feature. from *0* to *1*, *1* being every trace sent will be analyzed. This is a datadog only feature
(**ENDPOINT-TYPE** needs to be `datadog`)
## Zipkin ## Zipkin
You can run Zipkin on a Docker host like this: You can run Zipkin on a Docker host like this:
``` ```
docker run -d -p 9411:9411 openzipkin/zipkin docker run -d -p 9411:9411 openzipkin/zipkin
``` ```
:warning: The zipkin provider does not support the v1 API since coredns 1.7.1 Note the zipkin provider does not support the v1 API since coredns 1.7.1.
## Examples ## Examples