Jaeger Tracer

Description

The jaeger tracer is used to collect tracing information from the gateway and send them to a Jaeger instance.

Installation

You can build the tracer plugin from the source or you can download it from here

Then, put the ZIP file in your gateway plugins folder. (More information)

Compatibility with APIM

Plugin version	APIM version
2.x	3.x
3.x	4.0 to latest

Configuration

In your APIM Gateway configuration file, you have to add a new block of settings, so the plugin will be able to send tracing data to your Jaeger instance.

Example

Simple configuration

services:
  tracing:
    enabled: true
    type: jaeger
    jaeger:
      host: localhost
      port: 14250

Full configuration

services:
  tracing:
    enabled: (default is false)
    type: jaeger
    jaeger:
      host: (default is localhost)
      port: (default is 14250)
      ssl:
        enabled: (default is false)
        ## following fields are only mandatory if ssl.enabled is true
        trustall: (default is false)
        verifyHostname: (default is true)
        keystore:
          type: (default is null) # Supports jks, pem, pkcs12
          path: (default is null)
          password: (default is null)
        truststore:
          type: (default is null) # Supports jks, pem, pkcs12
          path: (default is null)
          password: (default is null)

Tip	Don’t forget to activate the tracing service with: tracing: enabled: true