TykTechnologies / tyk / 6932

DEFAULT BRANCH: master
Ran
Jobs 1
Files 0
Run time –
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
6932

push

travis-ci

buger 
add opentracing support (#2384)

Looks good!

This  adds initial support for opentracing in the api gateway.

## requirements

For this feature to work properly we need an opentracing server implementation.
Please see the options available and  support status

Tracer | Supported 
-------|--------------
jaeger | :white_check_mark:
[zipkin](https://github.com/openzipkin/zipkin-go) | :white_check_mark:
[Datadog](https://github.com/DataDog/dd-opentracing-go) | :heavy_multiplication_x:
[Instana](https://github.com/instana/go-sensor/blob/master/README.md) | :heavy_multiplication_x:
[LightStep](https://github.com/lightstep/lightstep-tracer-go) | :heavy_multiplication_x:


# Configuring

A new configuration option has been added to the tyk config.

```json
    "tracing": {
        "name": "$tracer_name",
        "enabled": true,
        "options": {}
    }
```

`$tracer_name` is the name of the tracer to use. This can be one of the tracers
 supported (see support table), for example `jaeger`

 `enabled` if true then opentracing is enabled in the gateway, defaults to false.

 `options`: arbitrary json object used to initialize a tracer. Each tracer requires different setting to initialize so the shape of the will vary based on the support implementation of the tracer.

 This is how it looks like, when you enable `jaeger` tracer.

```json
    "tracing": {
        "name": "jaeger",
        "enabled": true,
        "options": {
            "serviceName": "tyk-gateway",
            "disabled": false,
            "rpc_metrics": false,
            "tags": null,
            "sampler": {
                "type": "const",
                "param": 1,
                "samplingServerURL": "",
                "maxOperations": 0,
                "samplingRefreshInterval": 0
            },
            "reporter": {
                "queueSize": 0,
                "BufferFlushInterval": 0,
                "logSpans": tru... (continued)
Jobs
ID Job ID Ran Files Coverage
2 6932.2 (LATEST_GO=true) 0
Travis Job 6932.2
Source Files on build 6932
Coverage ∆ File Lines Relevant Covered Missed Hits/Line