Add status check for Harbor's read-only status #6917
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bksteiny
commented
Jun 17, 2020
harbor/assets/service_checks.json
Outdated
Comment on lines
47
to
61
| { | ||
| "agent_version": "6.13.0", | ||
| "integration": "Harbor", | ||
| "groups": [ | ||
| "host", | ||
| "registry" | ||
| ], | ||
| "check": "harbor.read_only", | ||
| "statuses": [ | ||
| "ok", | ||
| "unknown", | ||
| "critical" | ||
| ], | ||
| "name": "Is Harbor in read_only mode", | ||
| "description": "Returns `OK` if the registry is not in `read_only` mode, otherwise returns `CRITICAL`. Monitors if the registry is in read_only mode or not." |
There was a problem hiding this comment.
I didn't know if I should modify this. I can remove it if necessary
Codecov Report
|
bksteiny
force-pushed
the
harbor-read-only-status
branch
from
4b2c67b
to
ee084b2
Compare
|
Hi @bksteiny and thanks for your PR 👍 The use case really makes sense to me but for exactly the arguments you mentioned, I think this information should really be a gauge metric instead of a service check. Can you update the PR to re-submit it as a gauge and we can then look into the details for the tests to pass? |
bksteiny
force-pushed
the
harbor-read-only-status
branch
from
ee084b2
to
d303deb
Compare
|
Hi @FlorianVeaux, I've pushed my changes that collect the read-only status as a gauge metric. Thanks for the assist |
FlorianVeaux
approved these changes
Jun 23, 2020
|
Thanks @bksteiny |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This adds a status check to monitor whether or not Harbor is in a system-wide read-only mode.
Motivation
I added this check because we've had a few occurrences where Harbor has gone into a read-only mode and we haven't been able to figure out why. This is especially a problem if you're replicating to 1 or many instances, and replication stops because a registry has gone into read-only mode.
Additional Notes
The Harbor API returns a boolean for the
read_onlystatus. I originally wanted to submit this data as a gauge (True = 1, False =0), however I wasn't able to get the tests to pass on Harbor version 1.4 (the read_only status isn't available in that version of Harbor).Here are the reasons why I wanted to collect this as a gauge:
Review checklist (to be filled by reviewers)
changelog/andintegration/labels attached