Jaeger

The Jaeger plugin can be used to retrieve traces from a configured Jaeger instance. You can specify the service, operation and tags for which you want to retrieve traces. You can also view the details of a trace and compare it with another trace.

Configuration

The following configuration can be used to access a Jaeger instances running on jaeger.kobs.io and is protected using token based authentication. The token is loaded from the JAEGER_TOKEN environment variable.

plugins:
  jaeger:
    - name: Jaeger
      description: Jaeger can be used for the traces of your application.
      address: https://jaeger.kobs.io
      token: ${JAEGER_TOKEN}

Field	Type	Description	Required
name	string	Name of the Jaeger instance.	Yes
displayName	string	Name of the Jaeger as it is shown in the UI.	Yes
description	string	Description of the Jaeger instance.	No
home	boolean	When this is true the plugin will be added to the home page.	No
address	string	Address of the Jaeger instance.	Yes
username	string	Username to access a Jaeger instance via basic authentication.	No
password	string	Password to access a Jaeger instance via basic authentication.	No
token	string	Token to access a Jaeger instance via token based authentication.	No
publicAddress	string	The public accessible address of the Jaeger instance.	No

Options

The following options can be used for a panel with the Jaeger plugin:

Field	Type	Description	Required
showChart	boolean	If this is true the chart with the traces will be shown.	No
queries	[]Query	A list of Jaeger queries, which can be selected by the user.	Yes

Query

Field	Type	Description	Required
name	string	A name for the Jaeger query, which is displayed in the select box.	Yes
limit	string	The maximum number of traces which should be shown. The default value is 20.	No
maxDuration	string	The maximum duration for the retrieved traces (e.g. 1s).	No
minDuration	string	The minimum duration for the retrieved traces (e.g. 100ms).	No
service	string	The service to retrieve traces for.	Yes
operation	string	An optional operation to retrieve traces for.	No
tags	string	Tags, which the traces must be contain.	No

For example the following dashboard shows all requests and all slow requests from Jaeger for the specified service (e.g. reviews.bookinfo).

---
apiVersion: kobs.io/v1
kind: Dashboard
spec:
  placeholders:
    - name: service
      description: The service name
  rows:
    - size: -1
      panels:
        - title: Traces
          colSpan: 12
          plugin:
            name: jaeger
            options:
              showChart: true
              queries:
                - name: "{% .service %} requests"
                  service: "{% .service %}"
                - name: "{% .service %} slow requests"
                  service: "{% .service %}"
                  minDuration: 1000ms