Skip to content

Commit b74b041

Browse files
atoulmegithub-actions[bot]crobert-1
authored
[exporter/signalfx] root_path validation (#42696)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Do not validate the root_path of the collector if `sync_host_metadata` is not set <!-- Issue number (e.g. #1234) or full URL to issue, if applicable. --> #### Link to tracking issue Fixes #42688 --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Curtis Robert <[email protected]>
1 parent 5594001 commit b74b041

File tree

3 files changed

+40
-3
lines changed

3 files changed

+40
-3
lines changed

.chloggen/validate_root_path.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: bug_fix
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: signalfxexporter
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Only validate the root_path of the collector if `sync_host_metadata` is enabled.
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [42688]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: []

exporter/signalfxexporter/config.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -228,10 +228,11 @@ func (cfg *Config) Validate() error {
228228
return errors.New(`cannot have a negative "timeout"`)
229229
}
230230

231-
if err := gopsutilenv.ValidateRootPath(cfg.RootPath); err != nil {
232-
return fmt.Errorf("invalid root_path: %w", err)
231+
if cfg.SyncHostMetadata {
232+
if err := gopsutilenv.ValidateRootPath(cfg.RootPath); err != nil {
233+
return fmt.Errorf("invalid root_path: %w", err)
234+
}
233235
}
234-
235236
return nil
236237
}
237238

exporter/signalfxexporter/config_test.go

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -461,6 +461,15 @@ func TestConfigValidateErrors(t *testing.T) {
461461
},
462462
},
463463
},
464+
{
465+
name: "Invalid root_path",
466+
cfg: &Config{
467+
Realm: "us0",
468+
AccessToken: "access_token",
469+
RootPath: "/foobar",
470+
SyncHostMetadata: true,
471+
},
472+
},
464473
}
465474
for _, tt := range tests {
466475
t.Run(tt.name, func(t *testing.T) {

0 commit comments

Comments
 (0)