OBSDOCS-1142: Add Tempo troubleshooting page #81524
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@max-cx: This pull request references OBSDOCS-1142 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.18.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
@max-cx: This pull request references OBSDOCS-1142 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.18.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
bot
added
the
size/L
|
🤖 Fri Nov 15 16:44:16 - Prow CI generated the docs preview: |
max-cx
force-pushed
the
OBSDOCS-1142
branch
from
c49b9df to
ef127de
Compare
modules/distr-tracing-tempo-troubleshooting-issues-with-quering-traces.adoc
Outdated
Show resolved
Hide resolved
|
@max-cx: This pull request references OBSDOCS-1142 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.18.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
max-cx
force-pushed
the
OBSDOCS-1142
branch
4 times, most recently
from
c6a29e3 to
44bd082
Compare
|
/test deploy-preview |
|
@max-cx: The specified target(s) for
Use In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
/test all |
max-cx
force-pushed
the
OBSDOCS-1142
branch
4 times, most recently
from
6bbd736 to
22f2d44
Compare
|
/label peer-review-needed |
openshift-ci
bot
added
the
peer-review-needed
|
@max-cx: This pull request references OBSDOCS-1142 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.18.0" version, but no target version was set. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
abrennan89
added
the
peer-review-in-progress
modules/distr-tracing-tempo-getting-the-tempostack-instance-logs.adoc
Outdated
Show resolved
Hide resolved
modules/distr-tracing-tempo-troubleshooting-issues-with-ingesting-traces.adoc
Outdated
Show resolved
Hide resolved
modules/distr-tracing-tempo-troubleshooting-issues-with-quering-traces.adoc
Outdated
Show resolved
Hide resolved
observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-troubleshooting.adoc
Outdated
Show resolved
Hide resolved
|
|
||
| .Procedure | ||
|
|
||
| . Locate the component you want to get the logs for. You can do this by listing all the deployments on an specific namespace. |
There was a problem hiding this comment.
It's not clear if a user would know how to do this - maybe if there is an oc CLI command they can use to do this we should include it here, and an example output?
There was a problem hiding this comment.
@rubenvp8510, WDYT?
-
Any CLI command?
-
What's the navigation path in the web console?
There was a problem hiding this comment.
Yes,
I think the standard way of doing this is using:
oc get pods
to list all pods
Then select the ones that belongs to the component you want to inspects logs for
oc logs <pod name> , usually the pod name follows this pattern : tempo-<tempo-stack-name>-<component>
|
|
||
| . Locate the component you want to get the logs for. You can do this by listing all the deployments on an specific namespace. | ||
|
|
||
| . Identify the pods that belong to this component. |
There was a problem hiding this comment.
Again, how would a user do this? Are there specific commands involved or something specific they're looking for to identify it?
There was a problem hiding this comment.
Yes,
I think the standard way of doing this is using:
oc get pods
to list all pods, the ones that belongs to the tempostack will be in the format
tempo-<tempo-stack-name>-<component>
|
|
||
| . Identify the pods that belong to this component. | ||
|
|
||
| . Watch the logs by using `oc logs` command or retrieve the logs by using the web console. |
There was a problem hiding this comment.
Should include an example command here instead I think, something like:
. Watch the logs for the component by running the following command:
+
[source,terminal]
----
$ oc logs <component>
----
+
You can also view logs by navigating to X in the {product-title} web console.
(I'm not 100% what the command would be, this is just an example)
I think maybe there should be separate procedures also for using the oc CLI versus using the web console - neither one is listed here as .Prerequisites even though a user would need either access to the web console or to have the oc CLI installed here to follow this procedure.
There was a problem hiding this comment.
@rubenvp8510, two requests to you here:
-
Could you recommend a specific
oc logs <options>command? -
What's the navigation path in the web console?
| [id="problems-ingesting-traces_{context}"] | ||
| = Troubleshooting issues with ingesting traces | ||
|
|
||
| When the TempoStack instance is failing to ingest traces, you can troubleshoot it as follows. |
There was a problem hiding this comment.
Q: how would a user know if traces aren't being ingested? Would they see a particular error or run into particular issues that signal this is the case?
There was a problem hiding this comment.
There are different indicators, but the most important one is that the customer won't be able to see traces on the UI.
When that happens, is when should need to investigate if the traces are being droped, using the metrics mentioned in this doc.
modules/distr-tracing-tempo-troubleshooting-issues-with-ingesting-traces.adoc
Show resolved
Hide resolved
|
It seems like the procedures that are included don't really include information about how a user would do certain tasks, for example #81524 (comment) Is there a reason why these modules couldn't be refactored maybe to instead provide step by step guidance that has specific |
max-cx
force-pushed
the
OBSDOCS-1142
branch
from
22f2d44 to
fc1fae2
Compare
|
@abrennan89, thank you for your insightful review. Looks like this PR needs a bit of further development. The hardest part of it is about making the procedure module work for the purpose of troubleshooting, which really should be a different module type like https://www.oxygenxml.com/dita/1.3/specs/archSpec/technicalContent/dita-troubleshooting-topic.html. |
|
The This is because your PR targets the If the update in your PR does NOT apply to version 4.18 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main. |
Signed-off-by: Ruben Vargas <[email protected]>
|
@max-cx: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
|
Issues go stale after 90d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle stale |
openshift-ci
bot
added
the
lifecycle/stale
openshift-merge-robot
added
the
needs-rebase
|
PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
The This is because your PR targets the If the update in your PR does NOT apply to version 4.19 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main. |
|
Stale issues rot after 30d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle rotten |
openshift-ci
bot
added
lifecycle/rotten
Version(s):
4.12, 4.13, 4.14, 4.15, 4.16, 4.17
Issue:
https://issues.redhat.com/browse/OBSDOCS-1142
Link to docs preview:
https://81524--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-troubleshooting.html
QE review:
Additional information: