Provide a performance bar link to the Jaeger UI

What does this MR do?

Provide a performance bar link to the Jaeger UI

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?

• gitlab-development-kit!611 (merged)

Does this MR meet the acceptance criteria?

• Changelog entry added, if necessary
• Documentation created/updated via this MR
• Documentation reviewed by technical writer or follow-up review issue created
• Tests added for this feature/bug
• Tested in all supported browsers
• Conforms to the code review guidelines
• Conforms to the merge request performance guidelines
• Conforms to the style guides
• Conforms to the database guides
• Link to e2e tests MR added if this MR has Requires e2e tests label. See the Test Planning Process.
• Security reports checked/validated by reviewer

changed milestone to %11.7

added Distributed Tracing Observability labels

changed the description

mentioned in merge request gitlab-development-kit!611 (merged)

added 1 commit

• c6634bbd - Provide a performance bar link to the Jaeger UI

Compare with previous version

marked the checklist item Changelog entry added, if necessary as completed

changed the description

assigned to @reprazent

@reprazent would love to get your review!

changed milestone to %11.8

added 1 commit

• ce81014d - Provide a performance bar link to the Jaeger UI

Compare with previous version

@andrewn 2 nits . Other than that, LGTM!

assigned to @andrewn

added 1 commit

• 1ccec166 - Apply suggestion to lib/gitlab/tracing.rb

Compare with previous version

added 1 commit

• abe15bbf - Provide a performance bar link to the Jaeger UI

Compare with previous version

changed milestone to %11.9

Thanks @reprazent

@smcgivern I think you're pretty familiar with the performance bar, would you mind reviewing?

changed the description

assigned to @smcgivern

@smcgivern apologies for not spotting that you're out.

@grzesiek Would you be able to review?

assigned to @grzesiek

@andrewn I left just two minor comments. Awesome work!

assigned to @andrewn

added 1 commit

• 48bcd524 - Provide a performance bar link to the Jaeger UI

Compare with previous version

Thanks @grzesiek. Fixed and one style change proposal.

assigned to @grzesiek

mentioned in issue #57454 (closed)

approved this merge request

marked the checklist item Conforms to the code review guidelines as completed

marked the checklist item Security reports checked/validated by reviewer as completed

resolved all discussions

merged

mentioned in commit 25af9032

Thanks @andrewn!

That's great, thanks @andrewn!

mentioned in merge request gitlab-development-kit!633 (closed)

mentioned in issue gitlab-org/release/tasks#695 (closed)