-
Notifications
You must be signed in to change notification settings - Fork 2.7k
config: add reusable exporter config package #3660
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
Draft
nicolastakashi
wants to merge
2
commits into
prometheus:master
Choose a base branch
from
nicolastakashi:embeddable-config-foundation
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 hidden or 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,54 @@ | ||
| // Copyright 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. | ||
|
|
||
| package config | ||
|
|
||
| import "fmt" | ||
|
|
||
| const ( | ||
| DefaultWebTelemetryPath = "/metrics" | ||
| DefaultWebMaxRequests = 40 | ||
| DefaultRuntimeGoMaxProcs = 1 | ||
| ) | ||
|
|
||
| // Config contains the user-facing configuration currently adapted by the | ||
| // node_exporter binary into the reusable runtime and HTTP handler layers. | ||
| type Config struct { | ||
| WebTelemetryPath string | ||
| WebDisableExporterMetrics bool | ||
| WebMaxRequests int | ||
| CollectorDisableDefaults bool | ||
| RuntimeGoMaxProcs int | ||
| EnabledCollectors []string | ||
| } | ||
|
|
||
| func NewConfigWithDefaults() Config { | ||
| return Config{ | ||
| WebTelemetryPath: DefaultWebTelemetryPath, | ||
| WebMaxRequests: DefaultWebMaxRequests, | ||
| RuntimeGoMaxProcs: DefaultRuntimeGoMaxProcs, | ||
| } | ||
| } | ||
|
|
||
| func (c Config) Validate() error { | ||
| if c.WebTelemetryPath == "" { | ||
| return fmt.Errorf("web telemetry path must not be empty") | ||
| } | ||
| if c.WebMaxRequests < 0 { | ||
| return fmt.Errorf("web max requests must be greater than or equal to zero") | ||
| } | ||
| if c.RuntimeGoMaxProcs <= 0 { | ||
| return fmt.Errorf("runtime gomaxprocs must be greater than zero") | ||
| } | ||
| return nil | ||
| } | ||
This file contains hidden or 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,65 @@ | ||
| // Copyright 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. | ||
|
|
||
| package config | ||
|
|
||
| import "testing" | ||
|
|
||
| func TestNewConfigWithDefaults(t *testing.T) { | ||
| cfg := NewConfigWithDefaults() | ||
|
|
||
| if got, want := cfg.WebTelemetryPath, DefaultWebTelemetryPath; got != want { | ||
| t.Errorf("Expected: %q, Got: %q", want, got) | ||
| } | ||
| if got, want := cfg.WebMaxRequests, DefaultWebMaxRequests; got != want { | ||
| t.Errorf("Expected: %d, Got: %d", want, got) | ||
| } | ||
| if got, want := cfg.RuntimeGoMaxProcs, DefaultRuntimeGoMaxProcs; got != want { | ||
| t.Errorf("Expected: %d, Got: %d", want, got) | ||
| } | ||
| } | ||
|
|
||
| func TestConfigValidate(t *testing.T) { | ||
| cfg := NewConfigWithDefaults() | ||
|
|
||
| if err := cfg.Validate(); err != nil { | ||
| t.Fatalf("expected nil error, got %v", err) | ||
| } | ||
| } | ||
|
|
||
| func TestConfigValidateRequiresTelemetryPath(t *testing.T) { | ||
| cfg := NewConfigWithDefaults() | ||
| cfg.WebTelemetryPath = "" | ||
|
|
||
| if err := cfg.Validate(); err == nil { | ||
| t.Fatal("expected error, got nil") | ||
| } | ||
| } | ||
|
|
||
| func TestConfigValidateRejectsNegativeMaxRequests(t *testing.T) { | ||
| cfg := NewConfigWithDefaults() | ||
| cfg.WebMaxRequests = -1 | ||
|
|
||
| if err := cfg.Validate(); err == nil { | ||
| t.Fatal("expected error, got nil") | ||
| } | ||
| } | ||
|
|
||
| func TestConfigValidateRejectsNonPositiveGoMaxProcs(t *testing.T) { | ||
| cfg := NewConfigWithDefaults() | ||
| cfg.RuntimeGoMaxProcs = 0 | ||
|
|
||
| if err := cfg.Validate(); err == nil { | ||
| t.Fatal("expected error, got nil") | ||
| } | ||
| } |
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 refactor some of this into the exporter-toolkit web package?
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 think does could be good candidates to be moved into the exporter-toolkit, I can make it work.