rancher / rancher/stackstate-product-docs

[STAC-25250] Documentation and Demo on how to get the exception of a trace on SUSE Observability

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

Nobody has claimed this yet.

area/documentation JIRA kind/enhancement squad/marvin
Dominant language
Shell
Stars
2
Forks
24
Avg merge
4d 3h
Merged PRs (30d)
16

Description

STAC-25250

Original filed on jira.suse.com

Documentation on how to see the exception raisen from trace is missing on the documentation.

Also we would like to be able to reproduce this on http://observability.suse.com to demo the customer.

We would implement this right after https://stackstate.atlassian.net/browse/STAC-22398

Talk to @rb3ckers on where to find an exception in the OTEL demo

Extend https://documentation.suse.com/cloudnative/suse-observability/latest/en/use/views/k8s-traces-perspective.html with how to get to exception information and showcase it.

This is both about informing the end user, aswell as showcasing/selling this feature of the product.

Contributor guide

No contributing guide indexed for this repository

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 k8s-traces-perspective.html page and identify the existing trace-navigation guidance. Talk to @rb3ckers to locate an exception in the OTEL demo, and check STAC-22398 before starting. Done means the documentation explains how to reach exception information and the same behavior can be reproduced on observability.suse.com for a demo.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation, observability-sre
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.