-
Notifications
You must be signed in to change notification settings - Fork 316
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
Add HTTP headers support to common HTTP client. #416
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| // Copyright 2024 The Prometheus Authors | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // This package no longer handles safe yaml parsing. In order to | ||
| // ensure correct yaml unmarshalling, use "yaml.UnmarshalStrict()". | ||
|
|
||
| package config | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "os" | ||
| "strings" | ||
| ) | ||
|
|
||
| // reservedHeaders that change the connection, are set by Prometheus, or can | ||
| // be changed otherwise. | ||
| var reservedHeaders = map[string]struct{}{ | ||
| "Authorization": {}, | ||
| "Host": {}, | ||
| "Content-Encoding": {}, | ||
| "Content-Length": {}, | ||
| "Content-Type": {}, | ||
| "User-Agent": {}, | ||
| "Connection": {}, | ||
| "Keep-Alive": {}, | ||
| "Proxy-Authenticate": {}, | ||
| "Proxy-Authorization": {}, | ||
| "Www-Authenticate": {}, | ||
| "Accept-Encoding": {}, | ||
| "X-Prometheus-Remote-Write-Version": {}, | ||
| "X-Prometheus-Remote-Read-Version": {}, | ||
| "X-Prometheus-Scrape-Timeout-Seconds": {}, | ||
|
|
||
| // Added by SigV4. | ||
| "X-Amz-Date": {}, | ||
| "X-Amz-Security-Token": {}, | ||
| "X-Amz-Content-Sha256": {}, | ||
| } | ||
|
|
||
| // Headers represents the configuration for HTTP headers. | ||
| type Headers struct { | ||
| Headers map[string]Header `yaml:",inline" json:",inline"` | ||
| dir string | ||
| } | ||
|
|
||
| // Headers represents the configuration for HTTP headers. | ||
| type Header struct { | ||
| Values []string `yaml:"values,omitempty" json:"values,omitempty"` | ||
| Secrets []Secret `yaml:"secrets,omitempty" json:"secrets,omitempty"` | ||
| Files []string `yaml:"files,omitempty" json:"files,omitempty"` | ||
| } | ||
|
|
||
| // SetDirectory records the directory to make headers file relative to the | ||
| // configuration file. | ||
| func (h *Headers) SetDirectory(dir string) { | ||
| if h == nil { | ||
| return | ||
| } | ||
| h.dir = dir | ||
| } | ||
|
|
||
| // Validate validates the Headers config. | ||
| func (h *Headers) Validate() error { | ||
| for n, header := range h.Headers { | ||
| if _, ok := reservedHeaders[http.CanonicalHeaderKey(n)]; ok { | ||
| return fmt.Errorf("setting header %q is not allowed", http.CanonicalHeaderKey(n)) | ||
| } | ||
| for _, v := range header.Files { | ||
| f := JoinDir(h.dir, v) | ||
| _, err := os.ReadFile(f) | ||
| if err != nil { | ||
| return fmt.Errorf("unable to read header %q from file %s: %w", http.CanonicalHeaderKey(n), f, err) | ||
| } | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // NewHeadersRoundTripper returns a RoundTripper that sets HTTP headers on | ||
| // requests as configured. | ||
| func NewHeadersRoundTripper(config *Headers, next http.RoundTripper) http.RoundTripper { | ||
| if len(config.Headers) == 0 { | ||
| return next | ||
| } | ||
| return &headersRoundTripper{ | ||
| config: config, | ||
| next: next, | ||
| } | ||
| } | ||
|
|
||
| type headersRoundTripper struct { | ||
| next http.RoundTripper | ||
| config *Headers | ||
| } | ||
|
|
||
| // RoundTrip implements http.RoundTripper. | ||
| func (rt *headersRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) { | ||
| req = cloneRequest(req) | ||
| for n, h := range rt.config.Headers { | ||
| for _, v := range h.Values { | ||
| req.Header.Add(n, v) | ||
| } | ||
| for _, v := range h.Secrets { | ||
| req.Header.Add(n, string(v)) | ||
| } | ||
| for _, v := range h.Files { | ||
| f := JoinDir(rt.config.dir, v) | ||
| b, err := os.ReadFile(f) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("unable to read headers file %s: %w", f, err) | ||
| } | ||
| req.Header.Add(n, strings.TrimSpace(string(b))) | ||
| } | ||
| } | ||
| return rt.next.RoundTrip(req) | ||
| } | ||
|
|
||
| // CloseIdleConnections implements closeIdler. | ||
| func (rt *headersRoundTripper) CloseIdleConnections() { | ||
| if ci, ok := rt.next.(closeIdler); ok { | ||
| ci.CloseIdleConnections() | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| // Copyright 2024 The Prometheus Authors | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // This package no longer handles safe yaml parsing. In order to | ||
| // ensure correct yaml unmarshalling, use "yaml.UnmarshalStrict()". | ||
|
|
||
| package config | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestReservedHeaders(t *testing.T) { | ||
| for k := range reservedHeaders { | ||
| l := http.CanonicalHeaderKey(k) | ||
| if k != l { | ||
| t.Errorf("reservedHeaders keys should be lowercase: got %q, expected %q", k, http.CanonicalHeaderKey(k)) | ||
| } | ||
| } | ||
| } |
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
Oops, something went wrong.
Oops, something went wrong.
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.
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.
Should we at least make it omit empty?