Skip to content

Commit 0dcdbe4

Browse files
srebhansrebhan
authored
fix(inputs.gnmi): Allow to disable using first namespace as origin (#16507)
1 parent 01c633f commit 0dcdbe4

12 files changed

+669
-96
lines changed

‎CHANGELOG.md

+12
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
<!-- markdownlint-disable MD024 -->
22
# Changelog
33

4+
## Unreleased
5+
6+
### Important Changes
7+
8+
- PR [#16507](https://github.com/influxdata/telegraf/pull/16507) adds the
9+
`enforce_first_namespace_as_origin` to the GNMI input plugin. This option
10+
allows to disable mangling of the response `path` tag by _not_ using namespaces
11+
as origin. It is highly recommended to disable the option.
12+
However, disabling the behavior might change the `path` tag and
13+
thus might break existing queries. Furthermore, the tag modification might
14+
increase cardinality in your database.
15+
416
## v1.33.2 [2025-02-10]
517

618
### Important Changes

‎plugins/inputs/gnmi/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,11 @@ details on how to use them.
8888
## Only receive updates for the state, also suppresses receiving the initial state
8989
# updates_only = false
9090

91+
## Enforces the namespace of the first element as origin for aliases and
92+
## response paths, required for backward compatibility.
93+
## NOTE: Set to 'false' if possible but be aware that this might change the path tag!
94+
# enforce_first_namespace_as_origin = true
95+
9196
## Guess the path-tag if an update does not contain a prefix-path
9297
## Supported values are
9398
## none -- do not add a 'path' tag

‎plugins/inputs/gnmi/gnmi.go

+74-53
Original file line numberDiff line numberDiff line change
@@ -41,32 +41,33 @@ including your device model and the following response data:
4141
This message is only printed once.`
4242

4343
type GNMI struct {
44-
Addresses []string `toml:"addresses"`
45-
Subscriptions []subscription `toml:"subscription"`
46-
TagSubscriptions []tagSubscription `toml:"tag_subscription"`
47-
Aliases map[string]string `toml:"aliases"`
48-
Encoding string `toml:"encoding"`
49-
Origin string `toml:"origin"`
50-
Prefix string `toml:"prefix"`
51-
Target string `toml:"target"`
52-
UpdatesOnly bool `toml:"updates_only"`
53-
VendorSpecific []string `toml:"vendor_specific"`
54-
Username config.Secret `toml:"username"`
55-
Password config.Secret `toml:"password"`
56-
Redial config.Duration `toml:"redial"`
57-
MaxMsgSize config.Size `toml:"max_msg_size"`
58-
Depth int32 `toml:"depth"`
59-
Trace bool `toml:"dump_responses"`
60-
CanonicalFieldNames bool `toml:"canonical_field_names"`
61-
TrimFieldNames bool `toml:"trim_field_names"`
62-
PrefixTagKeyWithPath bool `toml:"prefix_tag_key_with_path"`
63-
GuessPathTag bool `toml:"guess_path_tag" deprecated:"1.30.0;1.35.0;use 'path_guessing_strategy' instead"`
64-
GuessPathStrategy string `toml:"path_guessing_strategy"`
65-
EnableTLS bool `toml:"enable_tls" deprecated:"1.27.0;1.35.0;use 'tls_enable' instead"`
66-
KeepaliveTime config.Duration `toml:"keepalive_time"`
67-
KeepaliveTimeout config.Duration `toml:"keepalive_timeout"`
68-
YangModelPaths []string `toml:"yang_model_paths"`
69-
Log telegraf.Logger `toml:"-"`
44+
Addresses []string `toml:"addresses"`
45+
Subscriptions []subscription `toml:"subscription"`
46+
TagSubscriptions []tagSubscription `toml:"tag_subscription"`
47+
Aliases map[string]string `toml:"aliases"`
48+
Encoding string `toml:"encoding"`
49+
Origin string `toml:"origin"`
50+
Prefix string `toml:"prefix"`
51+
Target string `toml:"target"`
52+
UpdatesOnly bool `toml:"updates_only"`
53+
VendorSpecific []string `toml:"vendor_specific"`
54+
Username config.Secret `toml:"username"`
55+
Password config.Secret `toml:"password"`
56+
Redial config.Duration `toml:"redial"`
57+
MaxMsgSize config.Size `toml:"max_msg_size"`
58+
Depth int32 `toml:"depth"`
59+
Trace bool `toml:"dump_responses"`
60+
CanonicalFieldNames bool `toml:"canonical_field_names"`
61+
TrimFieldNames bool `toml:"trim_field_names"`
62+
PrefixTagKeyWithPath bool `toml:"prefix_tag_key_with_path"`
63+
GuessPathTag bool `toml:"guess_path_tag" deprecated:"1.30.0;1.35.0;use 'path_guessing_strategy' instead"`
64+
GuessPathStrategy string `toml:"path_guessing_strategy"`
65+
EnableTLS bool `toml:"enable_tls" deprecated:"1.27.0;1.35.0;use 'tls_enable' instead"`
66+
KeepaliveTime config.Duration `toml:"keepalive_time"`
67+
KeepaliveTimeout config.Duration `toml:"keepalive_timeout"`
68+
YangModelPaths []string `toml:"yang_model_paths"`
69+
EnforceFirstNamespaceAsOrigin bool `toml:"enforce_first_namespace_as_origin"`
70+
Log telegraf.Logger `toml:"-"`
7071
common_tls.ClientConfig
7172

7273
// Internal state
@@ -101,6 +102,15 @@ func (*GNMI) SampleConfig() string {
101102

102103
func (c *GNMI) Init() error {
103104
// Check options
105+
switch c.Encoding {
106+
case "":
107+
c.Encoding = "proto"
108+
case "proto", "json", "json_ietf", "bytes":
109+
// Do nothing, those are valid
110+
default:
111+
return fmt.Errorf("unsupported encoding %s", c.Encoding)
112+
}
113+
104114
if time.Duration(c.Redial) <= 0 {
105115
return errors.New("redial duration must be positive")
106116
}
@@ -186,17 +196,21 @@ func (c *GNMI) Init() error {
186196
// Invert explicit alias list and prefill subscription names
187197
c.internalAliases = make(map[*pathInfo]string, len(c.Subscriptions)+len(c.Aliases)+len(c.TagSubscriptions))
188198
for _, s := range c.Subscriptions {
189-
if err := s.buildAlias(c.internalAliases); err != nil {
199+
if err := s.buildAlias(c.internalAliases, c.EnforceFirstNamespaceAsOrigin); err != nil {
190200
return err
191201
}
192202
}
193203
for _, s := range c.TagSubscriptions {
194-
if err := s.buildAlias(c.internalAliases); err != nil {
204+
if err := s.buildAlias(c.internalAliases, c.EnforceFirstNamespaceAsOrigin); err != nil {
195205
return err
196206
}
197207
}
198208
for alias, encodingPath := range c.Aliases {
199-
c.internalAliases[newInfoFromString(encodingPath)] = alias
209+
path := newInfoFromString(encodingPath)
210+
if c.EnforceFirstNamespaceAsOrigin {
211+
path.enforceFirstNamespaceAsOrigin()
212+
}
213+
c.internalAliases[path] = alias
200214
}
201215
c.Log.Debugf("Internal alias mapping: %+v", c.internalAliases)
202216

@@ -281,20 +295,21 @@ func (c *GNMI) Start(acc telegraf.Accumulator) error {
281295
return
282296
}
283297
h := handler{
284-
host: host,
285-
port: port,
286-
aliases: c.internalAliases,
287-
tagsubs: c.TagSubscriptions,
288-
maxMsgSize: int(c.MaxMsgSize),
289-
vendorExt: c.VendorSpecific,
290-
tagStore: newTagStore(c.TagSubscriptions),
291-
trace: c.Trace,
292-
canonicalFieldNames: c.CanonicalFieldNames,
293-
trimSlash: c.TrimFieldNames,
294-
tagPathPrefix: c.PrefixTagKeyWithPath,
295-
guessPathStrategy: c.GuessPathStrategy,
296-
decoder: c.decoder,
297-
log: c.Log,
298+
host: host,
299+
port: port,
300+
aliases: c.internalAliases,
301+
tagsubs: c.TagSubscriptions,
302+
maxMsgSize: int(c.MaxMsgSize),
303+
vendorExt: c.VendorSpecific,
304+
tagStore: newTagStore(c.TagSubscriptions),
305+
trace: c.Trace,
306+
canonicalFieldNames: c.CanonicalFieldNames,
307+
trimSlash: c.TrimFieldNames,
308+
tagPathPrefix: c.PrefixTagKeyWithPath,
309+
guessPathStrategy: c.GuessPathStrategy,
310+
decoder: c.decoder,
311+
enforceFirstNamespaceAsOrigin: c.EnforceFirstNamespaceAsOrigin,
312+
log: c.Log,
298313
ClientParameters: keepalive.ClientParameters{
299314
Time: time.Duration(c.KeepaliveTime),
300315
Timeout: time.Duration(c.KeepaliveTimeout),
@@ -436,13 +451,16 @@ func (s *subscription) buildFullPath(c *GNMI) error {
436451
return nil
437452
}
438453

439-
func (s *subscription) buildAlias(aliases map[*pathInfo]string) error {
454+
func (s *subscription) buildAlias(aliases map[*pathInfo]string, enforceFirstNamespaceAsOrigin bool) error {
440455
// Build the subscription path without keys
441456
path, err := parsePath(s.Origin, s.Path, "")
442457
if err != nil {
443458
return err
444459
}
445460
info := newInfoFromPathWithoutKeys(path)
461+
if enforceFirstNamespaceAsOrigin {
462+
info.enforceFirstNamespaceAsOrigin()
463+
}
446464

447465
// If the user didn't provide a measurement name, use last path element
448466
name := s.Name
@@ -455,15 +473,18 @@ func (s *subscription) buildAlias(aliases map[*pathInfo]string) error {
455473
return nil
456474
}
457475

458-
func newGNMI() telegraf.Input {
459-
return &GNMI{
460-
Encoding: "proto",
461-
Redial: config.Duration(10 * time.Second),
462-
}
463-
}
464-
465476
func init() {
466-
inputs.Add("gnmi", newGNMI)
477+
inputs.Add("gnmi", func() telegraf.Input {
478+
return &GNMI{
479+
Redial: config.Duration(10 * time.Second),
480+
EnforceFirstNamespaceAsOrigin: true,
481+
}
482+
})
467483
// Backwards compatible alias:
468-
inputs.Add("cisco_telemetry_gnmi", newGNMI)
484+
inputs.Add("cisco_telemetry_gnmi", func() telegraf.Input {
485+
return &GNMI{
486+
Redial: config.Duration(10 * time.Second),
487+
EnforceFirstNamespaceAsOrigin: true,
488+
}
489+
})
469490
}

‎plugins/inputs/gnmi/gnmi_test.go

+15-14
Original file line numberDiff line numberDiff line change
@@ -779,9 +779,10 @@ func TestNotification(t *testing.T) {
779779
{
780780
name: "issue #12257 Sonic",
781781
plugin: &GNMI{
782-
Log: testutil.Logger{},
783-
Encoding: "proto",
784-
Redial: config.Duration(1 * time.Second),
782+
Log: testutil.Logger{},
783+
Encoding: "proto",
784+
Redial: config.Duration(1 * time.Second),
785+
EnforceFirstNamespaceAsOrigin: true,
785786
Subscriptions: []subscription{
786787
{
787788
Name: "temperature",
@@ -910,10 +911,11 @@ func TestNotification(t *testing.T) {
910911
{
911912
name: "Juniper Extension",
912913
plugin: &GNMI{
913-
Log: testutil.Logger{},
914-
Encoding: "proto",
915-
VendorSpecific: []string{"juniper_header"},
916-
Redial: config.Duration(1 * time.Second),
914+
Log: testutil.Logger{},
915+
Encoding: "proto",
916+
VendorSpecific: []string{"juniper_header"},
917+
Redial: config.Duration(1 * time.Second),
918+
EnforceFirstNamespaceAsOrigin: true,
917919
Subscriptions: []subscription{
918920
{
919921
Name: "type",
@@ -1105,7 +1107,12 @@ func TestCases(t *testing.T) {
11051107
require.NoError(t, err)
11061108

11071109
// Register the plugin
1108-
inputs.Add("gnmi", newGNMI)
1110+
inputs.Add("gnmi", func() telegraf.Input {
1111+
return &GNMI{
1112+
Redial: config.Duration(10 * time.Second),
1113+
EnforceFirstNamespaceAsOrigin: true,
1114+
}
1115+
})
11091116

11101117
for _, f := range folders {
11111118
// Only handle folders
@@ -1158,12 +1165,6 @@ func TestCases(t *testing.T) {
11581165

11591166
// Prepare the server response
11601167
responseFunction := func(server gnmi.GNMI_SubscribeServer) error {
1161-
sync := &gnmi.SubscribeResponse{
1162-
Response: &gnmi.SubscribeResponse_SyncResponse{
1163-
SyncResponse: true,
1164-
},
1165-
}
1166-
_ = sync
11671168
for i := range responses {
11681169
if err := server.Send(&responses[i]); err != nil {
11691170
return err

‎plugins/inputs/gnmi/handler.go

+26-15
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,22 @@ import (
3333
const eidJuniperTelemetryHeader = 1
3434

3535
type handler struct {
36-
host string
37-
port string
38-
aliases map[*pathInfo]string
39-
tagsubs []tagSubscription
40-
maxMsgSize int
41-
emptyNameWarnShown bool
42-
vendorExt []string
43-
tagStore *tagStore
44-
trace bool
45-
canonicalFieldNames bool
46-
trimSlash bool
47-
tagPathPrefix bool
48-
guessPathStrategy string
49-
decoder *yangmodel.Decoder
50-
log telegraf.Logger
36+
host string
37+
port string
38+
aliases map[*pathInfo]string
39+
tagsubs []tagSubscription
40+
maxMsgSize int
41+
emptyNameWarnShown bool
42+
vendorExt []string
43+
tagStore *tagStore
44+
trace bool
45+
canonicalFieldNames bool
46+
trimSlash bool
47+
tagPathPrefix bool
48+
guessPathStrategy string
49+
decoder *yangmodel.Decoder
50+
enforceFirstNamespaceAsOrigin bool
51+
log telegraf.Logger
5152
keepalive.ClientParameters
5253
}
5354

@@ -161,6 +162,9 @@ func (h *handler) handleSubscribeResponseUpdate(acc telegraf.Accumulator, respon
161162

162163
// Extract the path part valid for the whole set of updates if any
163164
prefix := newInfoFromPath(response.Update.Prefix)
165+
if h.enforceFirstNamespaceAsOrigin {
166+
prefix.enforceFirstNamespaceAsOrigin()
167+
}
164168

165169
// Add info to the tags
166170
headerTags["source"] = h.host
@@ -173,6 +177,9 @@ func (h *handler) handleSubscribeResponseUpdate(acc telegraf.Accumulator, respon
173177
var valueFields []updateField
174178
for _, update := range response.Update.Update {
175179
fullPath := prefix.append(update.Path)
180+
if h.enforceFirstNamespaceAsOrigin {
181+
prefix.enforceFirstNamespaceAsOrigin()
182+
}
176183
if update.Path.Origin != "" {
177184
fullPath.origin = update.Path.Origin
178185
}
@@ -251,7 +258,11 @@ func (h *handler) handleSubscribeResponseUpdate(acc telegraf.Accumulator, respon
251258
h.emptyNameWarnShown = true
252259
}
253260
}
261+
254262
aliasInfo := newInfoFromString(aliasPath)
263+
if h.enforceFirstNamespaceAsOrigin {
264+
aliasInfo.enforceFirstNamespaceAsOrigin()
265+
}
255266

256267
if tags["path"] == "" && h.guessPathStrategy == "subscription" {
257268
tags["path"] = aliasInfo.String()

0 commit comments

Comments
 (0)