Skip to content

Provide a performance bar link to the Jaeger UI

Andrew Newdigate requested to merge an-peek-jaeger into master

What does this MR do?

Provide a performance bar link to the Jaeger UI

Untitled_2

👇

image

Jaeger is a distributed tracing tool. This change adds a "Tracing" link to the performance bar to directly link to a current request in Jaeger.

This is useful for two reasons:

  1. It provides affordance to developers that the distributed tracing tool is available, so that it can quickly be discovered.
  2. It allows developers to quickly find a specific trace without having to manually navigate to a second user-interface.

When used alongside gitlab-development-kit!611 (merged)

Video demonstration: https://youtu.be/6QC9-kdb3MA

How does it work?

The URL of a distributed trace UI is configured via the GITLAB_TRACING_URL environment variable. This variable contains a template:

  • {{ correlation_id }} will expand to the current correlation ID
  • {{ service }} will expand to the current service name

When running Jaeger locally, the following URL can be used:

http://localhost:16686/search?service=%{service}}&tags=%7B"correlation_id"%3A"%{correlation_id}"%7D

This is configured automatically in the GDK in gitlab-development-kit!611 (merged).

This template URL will generate a URL which will find the relevant trace in Jaeger, given the service and the correlation id. This makes finding traces extremely simple for users, encouraging the adoption of the tool.

What are the relevant issue numbers?

Does this MR meet the acceptance criteria?

Edited by Grzegorz Bizon

Merge request reports