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.

Sign up for GitHub

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

Jump to bottom

[chore] Add runbooks file #3240

Closed
wants to merge 4 commits into from
Closed

[chore] Add runbooks file #3240

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bbbc1e1
[docs] Add runbooks file
bogdan-at-adobe Aug 27, 2024
e3b89e8
Trigger Tests
bogdan-at-adobe Aug 27, 2024
ff820e6
typos
bogdan-at-adobe Aug 28, 2024
7c0c8e7
remove example
bogdan-at-adobe Aug 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/runbooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenTelemetry Operator Runbooks

See [`README.md`](../README.md) for more details about the OpenTelemetry Operator.

## Manager Rules

### [ReconcileErrors](#reconcileerrors)

|||
|-:|-|
| Meaning | The OpenTelemetry Operator cannot succeed in the reconciliation step, probably because of a misconfigured OpenTelemetryCollector. |
| Impact | No impact on already running deployments or new correct ones. |
| Diagnosis | Check manager logs for reasons why this might happen. |
| Mitigation | Find out which OpenTelemetryCollector is causing the errors and fix the config. |

### [WorkqueueDepth](#workqueuedepth)

|||
|-:|-|
| Meaning | The working queue for the operator is larger than 0. |
| Impact | No impact if the queue depth reverts to 0 quickly. More investigation is needed if the problem persists. |
| Diagnosis | Check manager logs for reasons why this might happen. |
| Mitigation | This could be caused by many errors. Act based on what the logs are showing. |
Loading