Add user-configurable overrides module #2543
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
electron0zero
force-pushed
the
kvrhdn/user-configurable-overrides
branch
from
427039b to
0f989dc
Compare
electron0zero
force-pushed
the
kvrhdn/user-configurable-overrides
branch
from
0f989dc to
157b596
Compare
3 tasks
electron0zero
requested review from
joe-elliott,
annanay25,
mdisibio,
mapno,
zalegrala,
ie-pham and
stoewer
as code owners
added 2 commits
July 13, 2023 14:50
# Conflicts: # CHANGELOG.md # modules/overrides/overrides.go
3 tasks
zalegrala
approved these changes
Jul 17, 2023
joe-elliott
approved these changes
Jul 17, 2023
yvrhdn
added
backport-r105
type/bug
|
Not a bug but that's what the backport job expects 🤷🏻 |
|
Hello @kvrhdn!
Please, if the current pull request addresses a bug fix, label it with the |
3 tasks
github-actions bot
pushed a commit
that referenced
this pull request
Jul 18, 2023
* Add user-configurable overrides module * Add /api/overrides and fix crash on boot * Add overridesHandler and WriteStatusRuntimeConfig * return json and only return overrides for the tenant * Implement delete * Fix test I think? * Fix tests * clean up handler and TODOs * Add tests for overridesHandler * Add e2e test * Refactor: - clean up integration tests for overrides - rename ReloadInterval -> PollInterval - linting * Linting * address more Linting * fix lint and add test for PATCH * fix lint error unparam * remove todo * use tenantLimits as return type * Add prometheus.Collector to overrides.Interface * Test tempo_overrides_user_configurable_overrides_fetch_total metric in e2e tests * Sprinkle in some tracing * Update CHANGELOG.md * Rename loop to running for consistency * Have mux handle method routing; split up GET, POST and DELETE handlers * Use built in contains * Split up user-configurable overrides manager, api and backend client * Move overrides API to httpclient * Clean up, linting, fmt * Remove version field from json * Address review comments * If overrides.json does not exist, properly delete it from cache * Add config warning for conflicting storage * Check in my tests as well * Simplify API handler, return 404 on overrides not found * Typo, linting, fix test * Use backend constants --------- Co-authored-by: Suraj Nath <[email protected]> (cherry picked from commit 3b618cc)
yvrhdn
pushed a commit
that referenced
this pull request
Jul 18, 2023
* Add user-configurable overrides module * Add /api/overrides and fix crash on boot * Add overridesHandler and WriteStatusRuntimeConfig * return json and only return overrides for the tenant * Implement delete * Fix test I think? * Fix tests * clean up handler and TODOs * Add tests for overridesHandler * Add e2e test * Refactor: - clean up integration tests for overrides - rename ReloadInterval -> PollInterval - linting * Linting * address more Linting * fix lint and add test for PATCH * fix lint error unparam * remove todo * use tenantLimits as return type * Add prometheus.Collector to overrides.Interface * Test tempo_overrides_user_configurable_overrides_fetch_total metric in e2e tests * Sprinkle in some tracing * Update CHANGELOG.md * Rename loop to running for consistency * Have mux handle method routing; split up GET, POST and DELETE handlers * Use built in contains * Split up user-configurable overrides manager, api and backend client * Move overrides API to httpclient * Clean up, linting, fmt * Remove version field from json * Address review comments * If overrides.json does not exist, properly delete it from cache * Add config warning for conflicting storage * Check in my tests as well * Simplify API handler, return 404 on overrides not found * Typo, linting, fix test * Use backend constants --------- Co-authored-by: Suraj Nath <[email protected]> (cherry picked from commit 3b618cc) Co-authored-by: Koenraad Verheyden <[email protected]>
3 tasks
This was referenced Sep 6, 2023
3 tasks
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:
Introduces a new optional feature: user-configurable overrides. Goal is to allow tenants to change a subset of overrides using an API. Changes will be limited to
forwardersand later severalmetrics_generator_...overrides.Architecture
For every tenant we will store an
overrides.jsonfile in a bucket. These files will be stored in a separate bucket from the backend.This bucket is regularly polled and a copy of the limits is kept in-memory. When requesting the overrides for a tenant, the overrides module will now:
API
Later we might consider adding a PATCH endpoint to perform partial updates/deletes.
Which issue(s) this PR fixes:
Fixes #New feature!Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]