-
Notifications
You must be signed in to change notification settings - Fork 510
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.
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
metrics-generator disable x-scope-orgid header append #2974
metrics-generator disable x-scope-orgid header append #2974
Conversation
Fixes #2973 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for this improvement!
A couple of small comments, but overall it's looking good.
1. Changed removeOrgIdHeader to addOrgIdHeader 2. addOrgIdHeader default value will be true
Co-authored-by: Joe Elliott <joe.elliott@grafana.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good overall, just left a comment about removing pre-existing X-Scope-OrgID headers
@@ -33,7 +33,9 @@ func generateTenantRemoteWriteConfigs(originalCfgs []prometheus_config.RemoteWri | |||
} | |||
} | |||
|
|||
cloneCfg.Headers[user.OrgIDHeaderName] = tenant | |||
if addOrgIDHeader { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if we should move this if-case higher and merge it with if tenant != util.FakeTenantID
at line 24.
Make it:
if tenant != util.FakeTenantID && addOrgIDHeader {
Reasoning: we only need to remove any pre-existing X-Scope-OrgID headers if we want to inject our own. If we are not injecting any, there won't be a conflict and we don't need to remove them either.
We have the following possible scenarios:
- single-tenant: we don't remove X-Scope-OrgID
- multi-tenant with
addOrgIDHeader = true
: we remove X-Scope-OrgID headers and inject our own - multi-tenant with
addOrgIDHeader = false
: we do not inject our own X-Scope-OrgID header so I don't think we need to remove them as well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! I'll give Joe a chance to check in again as well 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice addition. Thanks!
What this PR does:
Adds option to disable addition of X-Scope-OrgID header in metrics generator with remote writing
Which issue(s) this PR fixes:
Fixes #1554
Checklist
CHANGELOG.md
updated - the order of entries should be[CHANGE]
,[FEATURE]
,[ENHANCEMENT]
,[BUGFIX]