TRACING-3258 | Document troubleshooting OTEL

[pavolloffay]

Version(s):

4.11
4.12
4.13
4.14

Issue:

https://issues.redhat.com/browse/TRACING-3258

Link to docs preview:

https://64772--docspreview.netlify.app/

QE review:

• QE has approved this change.

Additional information:

[pavolloffay]

This can be merged ASAP, it is already present in RHOSDT 2.9

[ocpdocs-previewbot]

🤖 Updated build preview is available at:
https://64772--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/25587

[IshwarKanse]

/lgtm

[openshift-ci]

New changes are detected. LGTM label has been removed.

[max-cx]

Preview of the page created in this PR: https://64772--docspreview.netlify.app/openshift-enterprise/latest/distr_tracing/distr_tracing_otel/distr-tracing-otel-troubleshooting

[max-cx]

Peer/language review is done.

[max-cx]

/label merge-review-needed

[michaelryanpeter]

/cherrypick enterprise-4.14

[michaelryanpeter]

/cherrypick enterprise-4.13

[michaelryanpeter]

/cherrypick enterprise-4.12

[michaelryanpeter]

/cherrypick enterprise-4.11

[openshift-cherrypick-robot]

@michaelryanpeter: new pull request created: #65142

In response to this:

/cherrypick enterprise-4.14

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/test-infra repository.

[openshift-cherrypick-robot]

@michaelryanpeter: new pull request created: #65143

In response to this:

/cherrypick enterprise-4.13

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/test-infra repository.

[openshift-cherrypick-robot]

@michaelryanpeter: #64772 failed to apply on top of branch "enterprise-4.12":

Applying: Document troubleshooting OTEL
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
Falling back to patching base and 3-way merge...
Auto-merging _topic_maps/_topic_map.yml
CONFLICT (content): Merge conflict in _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Document troubleshooting OTEL
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherrypick enterprise-4.12

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/test-infra repository.

[openshift-cherrypick-robot]

@michaelryanpeter: #64772 failed to apply on top of branch "enterprise-4.11":

Applying: Document troubleshooting OTEL
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
Falling back to patching base and 3-way merge...
Auto-merging _topic_maps/_topic_map.yml
CONFLICT (content): Merge conflict in _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Document troubleshooting OTEL
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherrypick enterprise-4.11

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/test-infra repository.

[michaelryanpeter]

I think this introduction could be a little more specific. Maybe something like, "You can specify your desired log level for the OpenTelemetry Collector as shown in the following example..."

[michaelryanpeter]

@max-cx It looks like 4.11 and 4.12 will need manual cherry picks. Would you be able to take care of this?

[max-cx]

@michaelryanpeter

1. Thank you so much for your review. I created a Jira and added it to my epic for the next release, so I'll make sure to update the docs with your suggestions.
2. Regarding cherry-picking to 4.11 and 4.12, I am a newbie to the OpenShift docs, so I unfortunately don't have any merge rights yet.

[michaelryanpeter]

@max-cx: NP! There are instructions for creating manual cherry picks in the OpenShift Docs manual. You have to scroll a little bit, but the instructions are very detailed and should walk you through it. If you run into issues, please reach out in the team Slack channel.

Please make sure you prepend the heading of the PR with [enterprise-4.*] and reference the commit message and original PR at the top of comment zero. These points are in the instructions but are easy to miss sometimes. They make the manual cherrypicks consistent with the cherrypick bot. They also make it easier for the merge review squad to recognize that these are manual CPs.

Once you have created the manual CPs, put the /label merge-review-needed on.

[max-cx]

@michaelryanpeter, thank you so much for the link to the docs manual.

Unfortunately, I don't have commit rights, so I can't push my cherry-picks into any branch in this repo.

Also, these cherry-picks are currently blocked by the parent PR (#62410) having not been cherry-picked yet.

[max-cx]

The parent PR (#62410) has since been cherry-picked.

This PR is ready for the cherry-picks.

[max-cx]

/cherry-pick enterprise-4.11

[max-cx]

/cherry-pick enterprise-4.12

[max-cx]

/cherry-pick enterprise-4.13

[max-cx]

/cherry-pick enterprise-4.14

[openshift-cherrypick-robot]

@max-cx: new pull request created: #65927

In response to this:

/cherry-pick enterprise-4.11

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/test-infra repository.

[openshift-cherrypick-robot]

@max-cx: new pull request created: #65928

In response to this:

/cherry-pick enterprise-4.12

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/test-infra repository.

[openshift-cherrypick-robot]

@max-cx: new pull request could not be created: failed to create pull request against openshift/openshift-docs#enterprise-4.13 from head openshift-cherrypick-robot:cherry-pick-64772-to-enterprise-4.13: status code 422 not one of [201], body: {"message":"Validation Failed","errors":[{"resource":"PullRequest","code":"custom","message":"No commits between openshift:enterprise-4.13 and openshift-cherrypick-robot:cherry-pick-64772-to-enterprise-4.13"}],"documentation_url":"https://docs.github.com/rest/pulls/pulls#create-a-pull-request"}

In response to this:

/cherry-pick enterprise-4.13

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/test-infra repository.

[openshift-cherrypick-robot]

@max-cx: new pull request could not be created: failed to create pull request against openshift/openshift-docs#enterprise-4.14 from head openshift-cherrypick-robot:cherry-pick-64772-to-enterprise-4.14: status code 422 not one of [201], body: {"message":"Validation Failed","errors":[{"resource":"PullRequest","code":"custom","message":"No commits between openshift:enterprise-4.14 and openshift-cherrypick-robot:cherry-pick-64772-to-enterprise-4.14"}],"documentation_url":"https://docs.github.com/rest/pulls/pulls#create-a-pull-request"}

In response to this:

/cherry-pick enterprise-4.14

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/test-infra repository.

[max-cx]

@michaelryanpeter, please see
#64772 (comment)
and
#64772 (comment)
above.