Consolidate status information onto /status endpoint #952
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
zalegrala
requested review from
annanay25,
dgzlopes,
joe-elliott,
yvrhdn,
mapno and
mdisibio
as code owners
zalegrala
force-pushed
the
apiConsolidate
branch
from
129b14b to
8decdae
Compare
joe-elliott
reviewed
Sep 14, 2021
There was a problem hiding this comment.
Generally heading the right way but let's make a few changes as discussed offline:
- switch to path based i.e.
/status/configinstead of/status?config /statusshould continue to list everything- at the top of each section in
/statuslist the endpoint that needs to be used to request only that section - add
/status/version - order of values in
/statusshould be version, services, endpoints, runtime_config and then config
CHANGELOG.md
Outdated
| @@ -38,6 +38,7 @@ | |||
| * [CHANGE] Renamed CLI flag from `--storage.trace.maintenance-cycle` to `--storage.trace.blocklist_poll`. This is a **breaking change** [#897](https://github.com/grafana/tempo/pull/897) (@mritunjaysharma394) | |||
| * [CHANGE] update jsonnet alerts and recording rules to use `job_selectors` and `cluster_selectors` for configurable unique identifier labels [#935](https://github.com/grafana/tempo/pull/935) (@kevinschoonover) | |||
| * [CHANGE] Modify generated tag keys in Vulture for easier filtering [#934](https://github.com/grafana/tempo/pull/934) (@zalegrala) | |||
| * [CHANGE] Consolidate status information onto /status endpoint [ #952 ](https://github.com/grafana/tempo/pull/952) @zalegrala) | |||
There was a problem hiding this comment.
This is a breaking change. We need to list that and also list all the endpoints that moved and where they moved to.
See below for examples.
|
See here: |
zalegrala
force-pushed
the
apiConsolidate
branch
from
ba2e1c9 to
d423c0c
Compare
|
I've updated the approach here, and I hope it is still pretty readable. I wasn't quite sure about the error handling on that status method, but let me know what you think. |
|
Oh that might not work due to the linter. Hmm. I'll be less clever. |
zalegrala
force-pushed
the
apiConsolidate
branch
from
d423c0c to
27d2939
Compare
joe-elliott
approved these changes
Sep 15, 2021
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 this PR does:
Here we move a few status endpoints onto the
/statusendpoint. Optionally, users can pass a few query parameters that will reduce the amount of output.Which issue(s) this PR fixes:
Fixes #949
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]