Skip to content

Commit

Permalink
Docs: Remove opentracing and zipkin from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@LucasAndFlores
LucasAndFlores committed May 15, 2024
1 parent 689b993 commit 2b26337
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 325 deletions.
20 changes: 0 additions & 20 deletions docs/user-guide/nginx-configuration/annotations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,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/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-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/opentelemetry-trust-incoming-span](#opentelemetry-trust-incoming-spans)|"true" or "false"|
|[nginx.ingress.kubernetes.io/use-regex](#use-regex)|bool|
Expand Down Expand Up @@ -830,24 +828,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"
```

### 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

Opentelemetry can be enabled or disabled globally through the ConfigMap but this will sometimes need to be overridden
Expand Down
42 changes: 0 additions & 42 deletions docs/user-guide/nginx-configuration/configmap.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,13 +134,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" ||
|[proxy-add-original-uri-header](#proxy-add-original-uri-header)| bool | "false" ||
|[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-port](#jaeger-collector-port)| int | 6831 ||
|[jaeger-endpoint](#jaeger-endpoint)| string | "" ||
Expand Down Expand Up @@ -944,41 +937,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

## 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

Specifies the host to use when uploading traces. It must be a valid URL.
Expand Down
263 changes: 0 additions & 263 deletions docs/user-guide/third-party-addons/opentracing.md
View file

This file was deleted.

0 comments on commit 2b26337

Please sign in to comment.