Docs: Remove opentracing and zipkin from docs (#11405)
Co-authored-by: Lucas Andrade Flores <lcs.oliveira93@gmail.com>
This commit is contained in:
Marco Ebert
GitHub
parent
7520982b4e
commit
047fa58e26
3 changed files with 0 additions and 325 deletions
|
|
@ -123,8 +123,6 @@ You can add these Kubernetes annotations to specific Ingress objects to customiz
|
||||||
|[nginx.ingress.kubernetes.io/ssl-prefer-server-ciphers](#ssl-ciphers)|"true" or "false"|
|
|[nginx.ingress.kubernetes.io/ssl-prefer-server-ciphers](#ssl-ciphers)|"true" or "false"|
|
||||||
|[nginx.ingress.kubernetes.io/connection-proxy-header](#connection-proxy-header)|string|
|
|[nginx.ingress.kubernetes.io/connection-proxy-header](#connection-proxy-header)|string|
|
||||||
|[nginx.ingress.kubernetes.io/enable-access-log](#enable-access-log)|"true" or "false"|
|
|[nginx.ingress.kubernetes.io/enable-access-log](#enable-access-log)|"true" or "false"|
|
||||||
|[nginx.ingress.kubernetes.io/enable-opentracing](#enable-opentracing)|"true" or "false"|
|
|
||||||
|[nginx.ingress.kubernetes.io/opentracing-trust-incoming-span](#opentracing-trust-incoming-span)|"true" or "false"|
|
|
||||||
|[nginx.ingress.kubernetes.io/enable-opentelemetry](#enable-opentelemetry)|"true" or "false"|
|
|[nginx.ingress.kubernetes.io/enable-opentelemetry](#enable-opentelemetry)|"true" or "false"|
|
||||||
|[nginx.ingress.kubernetes.io/opentelemetry-trust-incoming-span](#opentelemetry-trust-incoming-spans)|"true" or "false"|
|
|[nginx.ingress.kubernetes.io/opentelemetry-trust-incoming-span](#opentelemetry-trust-incoming-spans)|"true" or "false"|
|
||||||
|[nginx.ingress.kubernetes.io/use-regex](#use-regex)|bool|
|
|[nginx.ingress.kubernetes.io/use-regex](#use-regex)|bool|
|
||||||
|
|
@ -813,24 +811,6 @@ Note that rewrite logs are sent to the error_log file at the notice level. To en
|
||||||
nginx.ingress.kubernetes.io/enable-rewrite-log: "true"
|
nginx.ingress.kubernetes.io/enable-rewrite-log: "true"
|
||||||
```
|
```
|
||||||
|
|
||||||
### Enable Opentracing
|
|
||||||
|
|
||||||
Opentracing can be enabled or disabled globally through the ConfigMap but this will sometimes need to be overridden
|
|
||||||
to enable it or disable it for a specific ingress (e.g. to turn off tracing of external health check endpoints)
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
nginx.ingress.kubernetes.io/enable-opentracing: "true"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Opentracing Trust Incoming Span
|
|
||||||
|
|
||||||
The option to trust incoming trace spans can be enabled or disabled globally through the ConfigMap but this will
|
|
||||||
sometimes need to be overridden to enable it or disable it for a specific ingress (e.g. only enable on a private endpoint)
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
nginx.ingress.kubernetes.io/opentracing-trust-incoming-span: "true"
|
|
||||||
```
|
|
||||||
|
|
||||||
### Enable Opentelemetry
|
### Enable Opentelemetry
|
||||||
|
|
||||||
Opentelemetry can be enabled or disabled globally through the ConfigMap but this will sometimes need to be overridden
|
Opentelemetry can be enabled or disabled globally through the ConfigMap but this will sometimes need to be overridden
|
||||||
|
|
|
||||||
|
|
@ -133,13 +133,6 @@ The following table shows a configuration option's name, type, and the default v
|
||||||
|[compute-full-forwarded-for](#compute-full-forwarded-for)|bool|"false"||
|
|[compute-full-forwarded-for](#compute-full-forwarded-for)|bool|"false"||
|
||||||
|[proxy-add-original-uri-header](#proxy-add-original-uri-header)|bool|"false"||
|
|[proxy-add-original-uri-header](#proxy-add-original-uri-header)|bool|"false"||
|
||||||
|[generate-request-id](#generate-request-id)|bool|"true"||
|
|[generate-request-id](#generate-request-id)|bool|"true"||
|
||||||
|[enable-opentracing](#enable-opentracing)|bool|"false"||
|
|
||||||
|[opentracing-operation-name](#opentracing-operation-name)|string|""||
|
|
||||||
|[opentracing-location-operation-name](#opentracing-location-operation-name)|string|""||
|
|
||||||
|[zipkin-collector-host](#zipkin-collector-host)|string|""||
|
|
||||||
|[zipkin-collector-port](#zipkin-collector-port)|int|9411||
|
|
||||||
|[zipkin-service-name](#zipkin-service-name)|string|"nginx"||
|
|
||||||
|[zipkin-sample-rate](#zipkin-sample-rate)|float|1.0||
|
|
||||||
|[jaeger-collector-host](#jaeger-collector-host)|string|""||
|
|[jaeger-collector-host](#jaeger-collector-host)|string|""||
|
||||||
|[jaeger-collector-port](#jaeger-collector-port)|int|6831||
|
|[jaeger-collector-port](#jaeger-collector-port)|int|6831||
|
||||||
|[jaeger-endpoint](#jaeger-endpoint)|string|""||
|
|[jaeger-endpoint](#jaeger-endpoint)|string|""||
|
||||||
|
|
@ -935,41 +928,6 @@ Adds an X-Original-Uri header with the original request URI to the backend reque
|
||||||
|
|
||||||
Ensures that X-Request-ID is defaulted to a random value, if no X-Request-ID is present in the request
|
Ensures that X-Request-ID is defaulted to a random value, if no X-Request-ID is present in the request
|
||||||
|
|
||||||
## enable-opentracing
|
|
||||||
|
|
||||||
Enables the nginx Opentracing extension. _**default:**_ is disabled
|
|
||||||
|
|
||||||
_References:_
|
|
||||||
[https://github.com/opentracing-contrib/nginx-opentracing](https://github.com/opentracing-contrib/nginx-opentracing)
|
|
||||||
|
|
||||||
## opentracing-operation-name
|
|
||||||
|
|
||||||
Specifies a custom name for the server span. _**default:**_ is empty
|
|
||||||
|
|
||||||
For example, set to "HTTP $request_method $uri".
|
|
||||||
|
|
||||||
## opentracing-location-operation-name
|
|
||||||
|
|
||||||
Specifies a custom name for the location span. _**default:**_ is empty
|
|
||||||
|
|
||||||
For example, set to "HTTP $request_method $uri".
|
|
||||||
|
|
||||||
## zipkin-collector-host
|
|
||||||
|
|
||||||
Specifies the host to use when uploading traces. It must be a valid URL.
|
|
||||||
|
|
||||||
## zipkin-collector-port
|
|
||||||
|
|
||||||
Specifies the port to use when uploading traces. _**default:**_ 9411
|
|
||||||
|
|
||||||
## zipkin-service-name
|
|
||||||
|
|
||||||
Specifies the service name to use for any traces created. _**default:**_ nginx
|
|
||||||
|
|
||||||
## zipkin-sample-rate
|
|
||||||
|
|
||||||
Specifies sample rate for any traces created. _**default:**_ 1.0
|
|
||||||
|
|
||||||
## jaeger-collector-host
|
## jaeger-collector-host
|
||||||
|
|
||||||
Specifies the host to use when uploading traces. It must be a valid URL.
|
Specifies the host to use when uploading traces. It must be a valid URL.
|
||||||
|
|
|
||||||
|
|
@ -1,263 +0,0 @@
|
||||||
# OpenTracing
|
|
||||||
|
|
||||||
Enables requests served by NGINX for distributed tracing via The OpenTracing Project.
|
|
||||||
|
|
||||||
Using the third party module [opentracing-contrib/nginx-opentracing](https://github.com/opentracing-contrib/nginx-opentracing) the Ingress-Nginx Controller can configure NGINX to enable [OpenTracing](http://opentracing.io) instrumentation.
|
|
||||||
By default this feature is disabled.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
To enable the instrumentation we must enable OpenTracing in the configuration ConfigMap:
|
|
||||||
```
|
|
||||||
data:
|
|
||||||
enable-opentracing: "true"
|
|
||||||
```
|
|
||||||
|
|
||||||
To enable or disable instrumentation for a single Ingress, use
|
|
||||||
the `enable-opentracing` annotation:
|
|
||||||
```
|
|
||||||
kind: Ingress
|
|
||||||
metadata:
|
|
||||||
annotations:
|
|
||||||
nginx.ingress.kubernetes.io/enable-opentracing: "true"
|
|
||||||
```
|
|
||||||
|
|
||||||
We must also set the host to use when uploading traces:
|
|
||||||
|
|
||||||
```
|
|
||||||
zipkin-collector-host: zipkin.default.svc.cluster.local
|
|
||||||
jaeger-collector-host: jaeger-agent.default.svc.cluster.local
|
|
||||||
datadog-collector-host: datadog-agent.default.svc.cluster.local
|
|
||||||
```
|
|
||||||
NOTE: While the option is called `jaeger-collector-host`, you will need to point this to a `jaeger-agent`, and not the `jaeger-collector` component.
|
|
||||||
Alternatively, you can set `jaeger-endpoint` and specify the full endpoint for uploading traces. This will use TCP and should be used for a collector rather than an agent.
|
|
||||||
|
|
||||||
Next you will need to deploy a distributed tracing system which uses OpenTracing.
|
|
||||||
[Zipkin](https://github.com/openzipkin/zipkin) and
|
|
||||||
[Jaeger](https://github.com/jaegertracing/jaeger) and
|
|
||||||
[Datadog](https://github.com/DataDog/dd-opentracing-cpp)
|
|
||||||
have been tested.
|
|
||||||
|
|
||||||
Other optional configuration options:
|
|
||||||
```
|
|
||||||
# specifies the name to use for the server span
|
|
||||||
opentracing-operation-name
|
|
||||||
|
|
||||||
# specifies specifies the name to use for the location span
|
|
||||||
opentracing-location-operation-name
|
|
||||||
|
|
||||||
# sets whether or not to trust incoming tracing spans
|
|
||||||
opentracing-trust-incoming-span
|
|
||||||
|
|
||||||
# specifies the port to use when uploading traces, Default: 9411
|
|
||||||
zipkin-collector-port
|
|
||||||
|
|
||||||
# specifies the service name to use for any traces created, Default: nginx
|
|
||||||
zipkin-service-name
|
|
||||||
|
|
||||||
# specifies sample rate for any traces created, Default: 1.0
|
|
||||||
zipkin-sample-rate
|
|
||||||
|
|
||||||
# specifies the port to use when uploading traces, Default: 6831
|
|
||||||
jaeger-collector-port
|
|
||||||
|
|
||||||
# specifies the endpoint to use when uploading traces to a collector instead of an agent
|
|
||||||
jaeger-endpoint
|
|
||||||
|
|
||||||
# specifies the service name to use for any traces created, Default: nginx
|
|
||||||
jaeger-service-name
|
|
||||||
|
|
||||||
# specifies the traceparent/tracestate propagation format
|
|
||||||
jaeger-propagation-format
|
|
||||||
|
|
||||||
# specifies the sampler to be used when sampling traces.
|
|
||||||
# The available samplers are: const, probabilistic, ratelimiting, remote, Default: const
|
|
||||||
jaeger-sampler-type
|
|
||||||
|
|
||||||
# specifies the argument to be passed to the sampler constructor, Default: 1
|
|
||||||
jaeger-sampler-param
|
|
||||||
|
|
||||||
# Specifies the custom remote sampler host to be passed to the sampler constructor. Must be a valid URL.
|
|
||||||
# Default: http://127.0.0.1
|
|
||||||
jaeger-sampler-host
|
|
||||||
|
|
||||||
# Specifies the custom remote sampler port to be passed to the sampler constructor. Must be a number. Default: 5778
|
|
||||||
jaeger-sampler-port
|
|
||||||
|
|
||||||
# Specifies the header name used for passing trace context. Must be a string. Default: uber-trace-id
|
|
||||||
jaeger-trace-context-header-name
|
|
||||||
|
|
||||||
# Specifies the header name used for force sampling. Must be a string. Default: jaeger-debug-id
|
|
||||||
jaeger-debug-header
|
|
||||||
|
|
||||||
# Specifies the header name used to submit baggage if there is no root span. Must be a string. Default: jaeger-baggage
|
|
||||||
jaeger-baggage-header
|
|
||||||
|
|
||||||
# Specifies the header prefix used to propagate baggage. Must be a string. Default: uberctx-
|
|
||||||
jaeger-tracer-baggage-header-prefix
|
|
||||||
|
|
||||||
# specifies the port to use when uploading traces, Default 8126
|
|
||||||
datadog-collector-port
|
|
||||||
|
|
||||||
# specifies the service name to use for any traces created, Default: nginx
|
|
||||||
datadog-service-name
|
|
||||||
|
|
||||||
# specifies the environment this trace belongs to, Default: prod
|
|
||||||
datadog-environment
|
|
||||||
|
|
||||||
# specifies the operation name to use for any traces collected, Default: nginx.handle
|
|
||||||
datadog-operation-name-override
|
|
||||||
|
|
||||||
# Specifies to use client-side sampling for distributed priority sampling and ignore sample rate, Default: true
|
|
||||||
datadog-priority-sampling
|
|
||||||
|
|
||||||
# specifies sample rate for any traces created, Default: 1.0
|
|
||||||
datadog-sample-rate
|
|
||||||
```
|
|
||||||
|
|
||||||
All these options (including host) allow environment variables, such as `$HOSTNAME` or `$HOST_IP`. In the case of Jaeger, if you have a Jaeger agent running on each machine in your cluster, you can use something like `$HOST_IP` (which can be 'mounted' with the `status.hostIP` fieldpath, as described [here](https://kubernetes.io/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/#capabilities-of-the-downward-api)) to make sure traces will be sent to the local agent.
|
|
||||||
|
|
||||||
|
|
||||||
Note that you can also set whether to trust incoming spans (global default is true) per-location using annotations like the following:
|
|
||||||
```
|
|
||||||
kind: Ingress
|
|
||||||
metadata:
|
|
||||||
annotations:
|
|
||||||
nginx.ingress.kubernetes.io/opentracing-trust-incoming-span: "true"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
The following examples show how to deploy and test different distributed tracing systems. These example can be performed using Minikube.
|
|
||||||
|
|
||||||
### Zipkin
|
|
||||||
|
|
||||||
In the [rnburn/zipkin-date-server](https://github.com/rnburn/zipkin-date-server)
|
|
||||||
GitHub repository is an example of a dockerized date service. To install the example and Zipkin collector run:
|
|
||||||
|
|
||||||
```
|
|
||||||
kubectl create -f https://raw.githubusercontent.com/rnburn/zipkin-date-server/master/kubernetes/zipkin.yaml
|
|
||||||
kubectl create -f https://raw.githubusercontent.com/rnburn/zipkin-date-server/master/kubernetes/deployment.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
Also we need to configure the Ingress-NGINX controller ConfigMap with the required values:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ echo '
|
|
||||||
apiVersion: v1
|
|
||||||
kind: ConfigMap
|
|
||||||
data:
|
|
||||||
enable-opentracing: "true"
|
|
||||||
zipkin-collector-host: zipkin.default.svc.cluster.local
|
|
||||||
metadata:
|
|
||||||
name: ingress-nginx-controller
|
|
||||||
namespace: kube-system
|
|
||||||
' | kubectl replace -f -
|
|
||||||
```
|
|
||||||
|
|
||||||
In the Zipkin interface we can see the details:
|
|
||||||
|
|
||||||
|
|
||||||
### Jaeger
|
|
||||||
|
|
||||||
1. Enable Ingress addon in Minikube:
|
|
||||||
```
|
|
||||||
$ minikube addons enable ingress
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Add Minikube IP to /etc/hosts:
|
|
||||||
```
|
|
||||||
$ echo "$(minikube ip) example.com" | sudo tee -a /etc/hosts
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Apply a basic Service and Ingress Resource:
|
|
||||||
```
|
|
||||||
# Create Echoheaders Deployment
|
|
||||||
$ kubectl run echoheaders --image=registry.k8s.io/echoserver:1.4 --replicas=1 --port=8080
|
|
||||||
|
|
||||||
# Expose as a Cluster-IP
|
|
||||||
$ kubectl expose deployment echoheaders --port=80 --target-port=8080 --name=echoheaders-x
|
|
||||||
|
|
||||||
# Apply the Ingress Resource
|
|
||||||
$ echo '
|
|
||||||
apiVersion: networking.k8s.io/v1
|
|
||||||
kind: Ingress
|
|
||||||
metadata:
|
|
||||||
name: echo-ingress
|
|
||||||
spec:
|
|
||||||
ingressClassName: nginx
|
|
||||||
rules:
|
|
||||||
- host: example.com
|
|
||||||
http:
|
|
||||||
paths:
|
|
||||||
- path: /echo
|
|
||||||
pathType: Prefix
|
|
||||||
backend:
|
|
||||||
service:
|
|
||||||
name: echoheaders-x
|
|
||||||
port:
|
|
||||||
number: 80
|
|
||||||
' | kubectl apply -f -
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Enable OpenTracing and set the jaeger-collector-host:
|
|
||||||
```
|
|
||||||
$ echo '
|
|
||||||
apiVersion: v1
|
|
||||||
kind: ConfigMap
|
|
||||||
data:
|
|
||||||
enable-opentracing: "true"
|
|
||||||
jaeger-collector-host: jaeger-agent.default.svc.cluster.local
|
|
||||||
metadata:
|
|
||||||
name: ingress-nginx-controller
|
|
||||||
namespace: kube-system
|
|
||||||
' | kubectl replace -f -
|
|
||||||
```
|
|
||||||
|
|
||||||
5. Apply the Jaeger All-In-One Template:
|
|
||||||
```
|
|
||||||
$ kubectl apply -f https://raw.githubusercontent.com/jaegertracing/jaeger-kubernetes/master/all-in-one/jaeger-all-in-one-template.yml
|
|
||||||
```
|
|
||||||
|
|
||||||
6. Make a few requests to the Service:
|
|
||||||
```
|
|
||||||
$ curl example.com/echo -d "meow"
|
|
||||||
|
|
||||||
CLIENT VALUES:
|
|
||||||
client_address=172.17.0.5
|
|
||||||
command=POST
|
|
||||||
real path=/echo
|
|
||||||
query=nil
|
|
||||||
request_version=1.1
|
|
||||||
request_uri=http://example.com:8080/echo
|
|
||||||
|
|
||||||
SERVER VALUES:
|
|
||||||
server_version=nginx: 1.10.0 - lua: 10001
|
|
||||||
|
|
||||||
HEADERS RECEIVED:
|
|
||||||
accept=*/*
|
|
||||||
connection=close
|
|
||||||
content-length=4
|
|
||||||
content-type=application/x-www-form-urlencoded
|
|
||||||
host=example.com
|
|
||||||
user-agent=curl/7.54.0
|
|
||||||
x-forwarded-for=192.168.99.1
|
|
||||||
x-forwarded-host=example.com
|
|
||||||
x-forwarded-port=80
|
|
||||||
x-forwarded-proto=http
|
|
||||||
x-original-uri=/echo
|
|
||||||
x-real-ip=192.168.99.1
|
|
||||||
x-scheme=http
|
|
||||||
BODY:
|
|
||||||
meow
|
|
||||||
```
|
|
||||||
|
|
||||||
7. View the Jaeger UI:
|
|
||||||
```
|
|
||||||
$ minikube service jaeger-query --url
|
|
||||||
|
|
||||||
http://192.168.99.100:30183
|
|
||||||
```
|
|
||||||
|
|
||||||
In the Jaeger interface we can see the details:
|
|
||||||
|
|
||||||
Loading…
Reference in a new issue