Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create guide that shows how to link traces between different KeptnApp deployments #2814

Closed
Tracked by #1394
mowies opened this issue Jan 16, 2024 · 2 comments · Fixed by #2902
Closed
Tracked by #1394

Create guide that shows how to link traces between different KeptnApp deployments #2814

mowies opened this issue Jan 16, 2024 · 2 comments · Fixed by #2902
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@mowies
Copy link
Member

mowies commented Jan 16, 2024

Goal

As a user, I want to easily understand the concept of passing trace context down to several deployments that happen at different points in time. This will enable me to nicely visualize staged deployments and have their traces be linked together.

Details

  • create a new guide under the Guides sections in the docs (docs-new/docs/guides)
  • the guide should explain how to use the new spec.traceLinks field to the user's advantage with usage examples
  • add images where possible (especially grafana dashboards)
  • The following steps should be explained in the guide:
  1. Deploy an application (e.g. podtato head) in a namespace (e.g. dev)
  2. Explain how to inspect the trace of the related KeptnApp, using the traces in the Grafana dashboard
  3. Retrieve a traceParent from the trace to add it as a link to another deployment of the sample application in a different namespace (e.g. production) by adding the traceParent to the spec.traceLinks in the other application.
  4. Showcase how extra metadata can be attached to the trace to pass along
  5. Let the other application deploy and show how the traces of the new application are linked together, to see that the deployment of the application in the dev namespace caused the deployment in production at a later point in time
@mowies mowies added documentation Improvements or additions to documentation status: ready-for-refinement Issue is relevant for the next backlog refinment labels Jan 16, 2024
@mowies mowies added this to the 0.11 milestone Jan 16, 2024
@mowies mowies moved this to 🏗 Shaping in Keptn Lifecycle Toolkit Jan 16, 2024
@mowies mowies self-assigned this Jan 16, 2024
@mowies mowies removed the status: ready-for-refinement Issue is relevant for the next backlog refinment label Jan 17, 2024
@mowies mowies moved this from 🏗 Shaping to 🎟️ Refined in Keptn Lifecycle Toolkit Jan 17, 2024
@odubajDT
Copy link
Contributor

A lot of information is already present in this PR #2880

Maybe it would be enough to have a short introduction about the feature and then link the guide

@mowies
Copy link
Member Author

mowies commented Jan 29, 2024

The team agreed to move the content in the observability getting started guide from #2880 to a new guide page that is done in this ticket. We decided to do that, because the context feature not immediately important to new users so the reason for it to exist in the getting started guide is not really warranted. But of course we still need a comprehensive guide that explains and presents the new context feature.

@mowies mowies assigned RealAnna and unassigned mowies Jan 31, 2024
@github-project-automation github-project-automation bot moved this from 🎟️ Refined to ✅ Done in Keptn Lifecycle Toolkit Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants