feat: Add dynamic tagging to gnmi plugin by bewing · Pull Request #7484 · influxdata/telegraf

bewing · 2020-05-08T21:22:30Z

Required for all PRs:

Signed CLA.
Associated README.md updated.
Has appropriate unit tests.

Add the ability to specify gNMI subscriptions to be tag-only, storing them for application to other subscriptions with the exact same tagged "name". The primary application of the author is to apply interface description tags to all other interface metrics, to ease search in Influx.

I am extremely open to suggestion on improvement for either the memory storage of the tags, or alternatives for additional aliasing of the dynamic tag naming.

bewing · 2020-05-08T21:32:59Z

If anyone wants to do integration testing against non-Arista hardware, it would be appreciated.

bewing · 2020-05-11T20:11:37Z

~~Switched from using / as the tag separator to _, as grafana was having a heck of a time when tags contained slashes per grafana/grafana#6012~~

Switched back to /, since grafana claims to have resolved the issue with slashes in tags.

bewing · 2020-08-27T14:09:39Z

Updated for new plugin name

bewing · 2020-10-14T18:25:09Z

Am I missing any data/information needed to merge this feature? What are the next steps from my side?

plugins/inputs/gnmi/README.md

plugins/inputs/gnmi/gnmi.go

bewing · 2020-11-11T03:18:05Z

Switched from using / as the tag separator to _, as grafana was having a heck of a time when tags contained slashes per grafana/grafana#6012

Given that Granfana has resolved their issue with slashes, does it make sense to switch back to using slashes as separators in this plugin?

slampt · 2021-03-02T02:15:59Z

Hola, just curious why this wasn't merged in?

cprecup · 2021-03-19T09:18:45Z

Hello @bewing,

Tested this with IOS-XR and the OpenConfig model openconfig-interfaces but I can't confirm it works on my end.

Here is the configuration:

[...]
 [[inputs.gnmi.subscription]]
   origin = "openconfig-interfaces"
   path = "/interfaces/interface/state/counters"
   subscription_mode = "sample"
   sample_interval = "60s"

 [[inputs.gnmi.subscription]]
   name = "descr"
   origin = "openconfig-interfaces"
   path = "/interfaces/interface/state/description"
   subscription_mode = "on_change"
   tag_only = true
[...]

The output is as follows:

telegraf git:(7484) ✗ ./telegraf --config telegraf-7484-gnmi-embedded-tags.conf 
2021-03-18T17:58:17Z I! Starting Telegraf 
[...]
2021-03-18T17:58:19Z E! [inputs.gnmi] Subscribe error (3), "openconfig-interfaces:interfaces/interface/state/description:ERR:No sysdb paths found for yang path openconfig-interfaces:interfaces/interface/state/description\x00"
counters,host=telegraf,name=GigabitEthernet0/0/0/0,path=openconfig-interfaces:/interfaces/interface/state/counters,source=x.f.g.h in_octets=0i,out_octets=0i,in_multicast_pkts=0i,in_broadcast_pkts=0i,out_multicast_pkts=0i,out_broadcast_pkts=0i,in_unknown_protos=0i,in_errors=0i,out_errors=0i,last_clear="2021-03-18T15:10:02Z",in_unicast_pkts=0i,in_discards=0i,out_unicast_pkts=0i,out_discards=0i 1616089682978000000
counters,host=telegraf,name=GigabitEthernet0/0/0/1,path=openconfig-interfaces:/interfaces/interface/state/counters,source=x.f.g.h in_octets=0i,out_octets=0i,in_multicast_pkts=0i,in_broadcast_pkts=0i,out_multicast_pkts=0i,out_broadcast_pkts=0i,in_unknown_protos=0i,in_errors=0i,out_errors=0i,last_clear="2021-03-18T15:10:02Z",in_unicast_pkts=0i,in_discards=0i,out_unicast_pkts=0i,out_discards=0i 1616089682978000000
[...]

telegraf-tiger · 2021-06-02T14:22:31Z

Thanks so much for the pull request!
🤝 ✒️ Just a reminder that the CLA has not yet been signed, and we'll need it before merging. Please sign the CLA when you get a chance, then post a comment here saying !signed-cla

bewing · 2021-06-02T14:33:13Z

Rebased for merge conflict

telegraf-tiger · 2021-06-02T14:37:29Z

Looks like new artifacts were built from this PR. Get them here!

Artifact URLs

srebhan

@bewing thanks for submitting this PR. I have some comments similar to the previous comments by Steven. Beside some smaller comments in the code I propose a way to save at least one level in the map. While I'm not 100% satisfied with three nested maps, it's a beginning. Maybe we can boil it further down?

plugins/inputs/gnmi/README.md

plugins/inputs/gnmi/gnmi.go

telegraf-tiger · 2022-01-13T18:28:38Z

Thanks so much for the pull request!
🤝 ✒️ Just a reminder that the CLA has not yet been signed, and we'll need it before merging. Please sign the CLA when you get a chance, then post a comment here saying !signed-cla

telegraf-tiger · 2022-01-13T19:04:38Z

Thanks so much for the pull request!
🤝 ✒️ Just a reminder that the CLA has not yet been signed, and we'll need it before merging. Please sign the CLA when you get a chance, then post a comment here saying !signed-cla

telegraf-tiger · 2022-01-13T19:05:57Z

Thanks so much for the pull request!
🤝 ✒️ Just a reminder that the CLA has not yet been signed, and we'll need it before merging. Please sign the CLA when you get a chance, then post a comment here saying !signed-cla

telegraf-tiger · 2022-01-13T19:11:29Z

Thanks so much for the pull request!
🤝 ✒️ Just a reminder that the CLA has not yet been signed, and we'll need it before merging. Please sign the CLA when you get a chance, then post a comment here saying !signed-cla

telegraf-tiger · 2022-01-13T19:43:32Z

Thanks so much for the pull request!
🤝 ✒️ Just a reminder that the CLA has not yet been signed, and we'll need it before merging. Please sign the CLA when you get a chance, then post a comment here saying !signed-cla

srebhan

@bewing that's exactly what I had in mind. :-) Thanks for taking the time to implement it!

Looks good to me.

plugins/inputs/gnmi/README.md

telegraf-tiger · 2022-02-01T22:02:33Z

Thanks so much for the pull request!
🤝 ✒️ Just a reminder that the CLA has not yet been signed, and we'll need it before merging. Please sign the CLA when you get a chance, then post a comment here saying !signed-cla

telegraf-tiger · 2022-02-01T22:03:21Z

Thanks so much for the pull request!
🤝 ✒️ Just a reminder that the CLA has not yet been signed, and we'll need it before merging. Please sign the CLA when you get a chance, then post a comment here saying !signed-cla

powersj · 2022-02-01T22:06:26Z

@bewing have you signed the CLA? @sspaink has fixed up the readme/config docs, so this is ready to merge, minus that.

telegraf-tiger · 2022-02-01T22:19:17Z

☺️ This pull request doesn't significantly change the Telegraf binary size (less than 1%)

📦 Looks like new artifacts were built from this PR.

Expand this list to get them here ! 🐯

Artifact URLs

DEB	RPM	TAR GZ	ZIP
amd64.deb	aarch64.rpm	darwin_amd64.tar.gz	windows_amd64.zip
arm64.deb	armel.rpm	darwin_arm64.tar.gz	windows_i386.zip
armel.deb	armv6hl.rpm	freebsd_amd64.tar.gz
armhf.deb	i386.rpm	freebsd_armv7.tar.gz
i386.deb	ppc64le.rpm	freebsd_i386.tar.gz
mips.deb	riscv64.rpm	linux_amd64.tar.gz
mipsel.deb	s390x.rpm	linux_arm64.tar.gz
ppc64el.deb	x86_64.rpm	linux_armel.tar.gz
riscv64.deb		linux_armhf.tar.gz
s390x.deb		linux_i386.tar.gz
		linux_mips.tar.gz
		linux_mipsel.tar.gz
		linux_ppc64le.tar.gz
		linux_riscv64.tar.gz
		linux_s390x.tar.gz
		static_linux_amd64.tar.gz

bewing · 2022-02-01T22:24:31Z

@bewing have you signed the CLA? @sspaink has fixed up the readme/config docs, so this is ready to merge, minus that.

I have not. I have an inquiry with my legal department pending regarding that. I will follow up with them this week.

bewing · 2022-02-07T15:03:32Z

Individual CLA signed. Working on corporate CLA now.

powersj · 2022-02-07T15:18:15Z

!signed-cla

powersj · 2022-02-07T15:19:02Z

Thank you @bewing!

* master: (117 commits) fix: bump github.com/nats-io/nats-server/v2 from 2.6.5 to 2.7.2 (influxdata#10638) chore: add -race flag to go tests (influxdata#10629) feat: update etc/telegraf.conf and etc/telegraf_windows.conf (influxdata#10631) fix: license doc outdated causing CI failure (influxdata#10630) fix: bump k8s.io/client-go from 0.22.2 to 0.23.3 (influxdata#10589) feat: Implemented support for reading raw values, added tests and doc (influxdata#6501) fix: Improve parser tests by using go-cmp/cmp (influxdata#10497) feat(mongodb): add FsTotalSize and FsUsedSize informations (influxdata#10625) docs: update quay docs for auth (influxdata#10612) chore: allow downgrade of go version in windows script (influxdata#10614) chore: update CI go to 1.17.6 (influxdata#10611) feat: update etc/telegraf.conf and etc/telegraf_windows.conf (influxdata#10600) fix(inputs.opcua): add more data to error log (influxdata#10465) fix: bump github.com/aws/aws-sdk-go-v2/service/kinesis from 1.6.0 to 1.13.0 (influxdata#10601) refactor: use early return pattern (influxdata#10591) fix: bump github.com/benbjohnson/clock from 1.1.0 to 1.3.0 (influxdata#10588) feat: add dynamic tagging to gnmi plugin (influxdata#7484) fix: bump github.com/Azure/azure-kusto-go from 0.5.0 to 0.5.2 (influxdata#10598) feat: update etc/telegraf.conf and etc/telegraf_windows.conf (influxdata#10584) fix(parsers.json_v2): allow optional paths and handle wrong paths correctly (influxdata#10468) ... # Conflicts: # plugins/outputs/elasticsearch/elasticsearch.go # plugins/outputs/elasticsearch/elasticsearch_test.go

bewing force-pushed the gnmi-lookup-tags branch from 50fc044 to d12336e Compare May 8, 2020 21:24

bewing force-pushed the gnmi-lookup-tags branch from d12336e to ffa3f74 Compare May 11, 2020 18:21

bewing force-pushed the gnmi-lookup-tags branch from ffa3f74 to 9b44dc9 Compare May 20, 2020 02:07

bewing force-pushed the gnmi-lookup-tags branch from 9b44dc9 to b2e43eb Compare August 27, 2020 14:09

bewing changed the title ~~Add dynamic tagging to cisco_telemetry_gnmi~~ Add dynamic tagging to gnmi plugin Aug 27, 2020

ssoroka reviewed Oct 28, 2020

View reviewed changes

plugins/inputs/gnmi/README.md Outdated Show resolved Hide resolved

plugins/inputs/gnmi/gnmi.go Outdated Show resolved Hide resolved

plugins/inputs/gnmi/gnmi.go Show resolved Hide resolved

sjwang90 added area/gnmi feat Improvement on an existing feature such as adding a new setting/mode to an existing plugin labels Nov 23, 2020

bewing mentioned this pull request Dec 1, 2020

feat: Add embedded_tags functionality to gNMI plugin #8344

Closed

bewing force-pushed the gnmi-lookup-tags branch from b2e43eb to 4c977bd Compare December 2, 2020 14:27

kb70 mentioned this pull request Dec 21, 2020

gNMI for Nokia and Huawei devices #8597

Closed

bewing force-pushed the gnmi-lookup-tags branch from 4c977bd to 0a1bbea Compare March 5, 2021 17:12

bewing force-pushed the gnmi-lookup-tags branch 5 times, most recently from 266ca12 to 54708f6 Compare March 17, 2021 13:09

bewing force-pushed the gnmi-lookup-tags branch from 54708f6 to 178515c Compare June 2, 2021 14:22

srebhan reviewed Dec 22, 2021

View reviewed changes

plugins/inputs/gnmi/README.md Outdated Show resolved Hide resolved

plugins/inputs/gnmi/gnmi.go Outdated Show resolved Hide resolved

plugins/inputs/gnmi/gnmi.go Outdated Show resolved Hide resolved

plugins/inputs/gnmi/gnmi.go Outdated Show resolved Hide resolved

srebhan self-assigned this Dec 22, 2021

bewing force-pushed the gnmi-lookup-tags branch from 7a5803b to 8671378 Compare January 13, 2022 19:04

bewing force-pushed the gnmi-lookup-tags branch from 8671378 to 951667d Compare January 13, 2022 19:05

bewing force-pushed the gnmi-lookup-tags branch from 951667d to f6b4492 Compare January 13, 2022 19:11

bewing force-pushed the gnmi-lookup-tags branch from f6b4492 to 566e7e1 Compare January 13, 2022 19:43

feat: Add dynamic tagging to gnmi plugin (influxdata#7484)

f83a10c

bewing force-pushed the gnmi-lookup-tags branch from 566e7e1 to f83a10c Compare January 13, 2022 19:57

srebhan approved these changes Jan 24, 2022

View reviewed changes

srebhan added the ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review. label Jan 24, 2022

powersj reviewed Jan 24, 2022

View reviewed changes

plugins/inputs/gnmi/README.md Outdated Show resolved Hide resolved

sspaink changed the title ~~Add dynamic tagging to gnmi plugin~~ feat: Add dynamic tagging to gnmi plugin Jan 24, 2022

Update README.md

894ac84

Update gnmi.go

f9ea69d

powersj approved these changes Feb 7, 2022

View reviewed changes

powersj merged commit 7e769d7 into influxdata:master Feb 7, 2022

sjwang90 mentioned this pull request Mar 7, 2022

Add "embedded_tags" in GNMI Plugin #8250

Closed

powersj mentioned this pull request Jan 29, 2024

Embedded tags in inputs.gnmi plugin. #14634

Closed

Conversation

bewing commented May 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Required for all PRs:

Uh oh!

bewing commented May 8, 2020

Uh oh!

bewing commented May 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bewing commented Aug 27, 2020

Uh oh!

bewing commented Oct 14, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bewing commented Nov 11, 2020

Uh oh!

slampt commented Mar 2, 2021

Uh oh!

cprecup commented Mar 19, 2021

Uh oh!

telegraf-tiger bot commented Jun 2, 2021

Uh oh!

bewing commented Jun 2, 2021

Uh oh!

telegraf-tiger bot commented Jun 2, 2021

Artifact URLs

Uh oh!

srebhan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

telegraf-tiger bot commented Jan 13, 2022

Uh oh!

telegraf-tiger bot commented Jan 13, 2022

Uh oh!

telegraf-tiger bot commented Jan 13, 2022

Uh oh!

telegraf-tiger bot commented Jan 13, 2022

Uh oh!

telegraf-tiger bot commented Jan 13, 2022

Uh oh!

srebhan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

telegraf-tiger bot commented Feb 1, 2022

Uh oh!

telegraf-tiger bot commented Feb 1, 2022

Uh oh!

powersj commented Feb 1, 2022

Uh oh!

telegraf-tiger bot commented Feb 1, 2022

Artifact URLs

Uh oh!

bewing commented Feb 1, 2022

Uh oh!

bewing commented Feb 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

powersj commented Feb 7, 2022

Uh oh!

powersj commented Feb 7, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

bewing commented May 8, 2020 •

edited

Loading

bewing commented May 11, 2020 •

edited

Loading

bewing commented Feb 7, 2022 •

edited

Loading