SNMP exporter: Use a "name" argument for "target" and "walk_param" blocks #1790
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 |
|---|---|---|
|
|
@@ -279,7 +279,7 @@ func lintSyntaxTag(ty *types.Var, tag string) (diagnostics []string) { | |
| } | ||
| } | ||
|
|
||
| case "label", "label,optional": | ||
| if name != "" { | ||
| diagnostics = append(diagnostics, "label field must have an empty value for name") | ||
| } | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -48,7 +48,7 @@ func buildSNMPTargets(baseTarget discovery.Target, args component.Arguments) []d | |
| target[k] = v | ||
| } | ||
|
|
||
| target["job"] = target["job"] + "/" + tgt.Name() | ||
| target["__param_target"] = tgt.Target | ||
| if tgt.Module != "" { | ||
| target["__param_module"] = tgt.Module | ||
|
|
@@ -71,7 +71,9 @@ func buildSNMPTargets(baseTarget discovery.Target, args component.Arguments) []d | |
|
|
||
| // SNMPTarget defines a target to be used by the exporter. | ||
| type SNMPTarget struct { | ||
| //TODO: For Alloy 2.0: Remove NameLbl and make NameArg mandatory. | ||
| NameLbl string `alloy:",label,optional"` | ||
| NameArg string `alloy:"name,attr,optional"` | ||
| Target string `alloy:"address,attr"` | ||
| Module string `alloy:"module,attr,optional"` | ||
| Auth string `alloy:"auth,attr,optional"` | ||
|
|
@@ -86,7 +88,7 @@ func (t TargetBlock) Convert() []snmp_exporter.SNMPTarget { | |
| targets := make([]snmp_exporter.SNMPTarget, 0, len(t)) | ||
| for _, target := range t { | ||
| targets = append(targets, snmp_exporter.SNMPTarget{ | ||
| Name: target.Name(), | ||
| Target: target.Target, | ||
| Module: target.Module, | ||
| Auth: target.Auth, | ||
|
|
@@ -97,8 +99,25 @@ func (t TargetBlock) Convert() []snmp_exporter.SNMPTarget { | |
| return targets | ||
| } | ||
|
|
||
| // Name() assumes that either NameLbl or NameArg is set. | ||
| // It also that both NameLbl and NameArg are not set at the same time, | ||
| // as this is checked during unmarshalling. | ||
| func (t *SNMPTarget) Name() string { | ||
| if t == nil { | ||
| return "" | ||
| } | ||
|
|
||
| if len(t.NameArg) > 0 { | ||
| return t.NameArg | ||
| } | ||
|
|
||
| return t.NameLbl | ||
| } | ||
|
|
||
| type WalkParam struct { | ||
| //TODO: For Alloy 2.0: Remove NameLbl and make NameArg mandatory. | ||
| NameLbl string `alloy:",label,optional"` | ||
| NameArg string `alloy:"name,attr,optional"` | ||
| MaxRepetitions uint32 `alloy:"max_repetitions,attr,optional"` | ||
| Retries int `alloy:"retries,attr,optional"` | ||
| Timeout time.Duration `alloy:"timeout,attr,optional"` | ||
|
|
@@ -111,7 +130,7 @@ type WalkParams []WalkParam | |
| func (w WalkParams) Convert() map[string]snmp_config.WalkParams { | ||
| walkParams := make(map[string]snmp_config.WalkParams) | ||
| for _, walkParam := range w { | ||
| walkParams[walkParam.Name()] = snmp_config.WalkParams{ | ||
| MaxRepetitions: walkParam.MaxRepetitions, | ||
| Retries: &walkParam.Retries, | ||
| Timeout: walkParam.Timeout, | ||
|
|
@@ -121,6 +140,21 @@ func (w WalkParams) Convert() map[string]snmp_config.WalkParams { | |
| return walkParams | ||
| } | ||
|
|
||
| // Name() assumes that either NameLbl or NameArg is set. | ||
| // It also that both NameLbl and NameArg are not set at the same time, | ||
| // as this is checked during unmarshalling. | ||
| func (p *WalkParam) Name() string { | ||
| if p == nil { | ||
| return "" | ||
| } | ||
|
|
||
| if len(p.NameArg) > 0 { | ||
| return p.NameArg | ||
| } | ||
|
|
||
| return p.NameLbl | ||
| } | ||
|
|
||
| type Arguments struct { | ||
| ConfigFile string `alloy:"config_file,attr,optional"` | ||
| Config alloytypes.OptionalSecret `alloy:"config,attr,optional"` | ||
|
|
@@ -155,7 +189,7 @@ func (t TargetsList) convert() []SNMPTarget { | |
| for _, target := range t { | ||
| address, _ := getAddress(target) | ||
| targets = append(targets, SNMPTarget{ | ||
| NameArg: target["name"], | ||
| Target: address, | ||
| Module: target["module"], | ||
| Auth: target["auth"], | ||
|
|
@@ -181,6 +215,26 @@ func (a *Arguments) UnmarshalAlloy(f func(interface{}) error) error { | |
| return fmt.Errorf("the block `target` and the attribute `targets` are mutually exclusive") | ||
| } | ||
|
|
||
| for _, walkParam := range a.WalkParams { | ||
| if walkParam.NameArg != "" && walkParam.NameLbl != "" { | ||
| return errors.New("the label of a `walk_param` block and the `name` argument are mutually exclusive") | ||
| } | ||
|
|
||
| if walkParam.NameArg == "" && walkParam.NameLbl == "" { | ||
| return errors.New("either the label of a `walk_param` block or the `name` argument must be set") | ||
| } | ||
| } | ||
|
|
||
| for _, target := range a.Targets { | ||
| if target.NameArg != "" && target.NameLbl != "" { | ||
| return errors.New("the label of a `target` block and the `name` argument are mutually exclusive") | ||
| } | ||
|
|
||
| if target.NameArg == "" && target.NameLbl == "" { | ||
| return errors.New("either the label of a `target` block or the `name` argument must be set") | ||
| } | ||
| } | ||
|
|
||
| for _, target := range a.TargetsList { | ||
| if _, hasName := target["name"]; !hasName { | ||
| return fmt.Errorf("all targets must have a `name`") | ||
|
|
||
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.