linkerd / linkerd/website

Modify the Application: How?

Open
#745 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
60
Forks
221
Avg merge
4h 32m
Merged PRs (30d)
1

Description

https://linkerd.io/2/tasks/distributed-tracing/ "Modify the Application" doesn't give details about how the application should be modified and why:

* Some tracing header must be passed on to outgoing requests. Which?
* In addition, some headers might be added to see how much time is spent in the application itself.
* However, that should be optional, correct? But the code uses the collector i.e. the application does report its time spans. The documentation should state that this is optional, if it is.
* It should be explained how the time spans are reported. Which headers? Is there some standard?

Background: I am trying to do the same with a Spring Sleuth based application and find it hard to understand how this can be done.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked distributed-tracing task, focusing on the “Modify the Application” section and the Spring Sleuth context described here. Determine which tracing headers applications must forward, how application spans are reported, and whether reporting them is optional; document those details and their rationale in the task.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.