layout-3 layout-6 layout-1 layout-top
NVIDIA Docs Hub   NVIDIA Networking   Networking Software   Management Software  

NVIDIA NetQ

layout-top layout-6 layout-1

Fluentd Reference

Enable Fluentd Streaming

To enable Fluentd streaming from NVlink4 switches to your Fluent collector, use the netq_telemetry_agent_handler tool to configure streaming parameters. The netq_telemetry_agent_handler application can be downloaded from NVIDIA Product Information Delivery Portal. The syntax for the command can be reviewed on the command line with the netq_telemetry_agent_handler -h command:

$ ./netq_telemetry_agent_handler -h
Usage of ./netq_telemetry_agent_handler:
  -add
        Append a new destination collector
  -address value
        List of addresses for discovery
  -delete
        Delete destination collectors
  -delete_all
        Delete all destination collectors
  -destination value
        List of fluent collectors (format <ip_addr>,<port>,<tcp/tls>)
  -domain string
        Domain name (optional)
  -domain_id string
        Domain identifier (optional)
  -password string
        NVOS http password (default "admin")
  -replace
        Replace destination collectors
  -user string
        NVOS http user (default "admin")
Examples for configuring one switch to append a fluent destination:
        ./netq_telemetry_agent_handler -add -address 192.168.0.17 -destination 10.188.44.17,30001,tcp -user admin -password admin -domain test -domain_id 1 -domain my_domain
Examples for configuring one switch to append two fluent destinations:
        ./netq_telemetry_agent_handler -add -address 192.168.0.17 -destination 10.188.44.17,30001,tcp -destination 10.188.44.43,30001,tcp -user admin -password admin -domain_id 1 -domain my_domain
Examples for configuring two switches to replace with one fluent destination:
        ./netq_telemetry_agent_handler -replace -address 192.168.0.17 -address 192.168.0.21 -destination 10.188.44.17,30001,tcp -user admin -password admin -domain_id 1 -domain my_domain
Examples for configuring one switche to delete a fluent destination:
        ./netq_telemetry_agent_handler -delete -address 192.168.0.17 -destination 10.188.44.17,30001,tcp -user admin -password admin -domain_id 1 -domain my_domain
Examples for configuring one switch to delete all fluent destinations:
        ./netq_telemetry_agent_handler -delete_all -address 192.168.0.17 -user admin -password admin -domain_id 1 -domain my_domain

NVLink4 Fluentd Message Examples

Expand the dropdown menu to view NVLink4 Fluentd message output in JSON format:

▼ JSON examples

Fluentd Message Reference

▼ Fluentd message reference

Fluentd Collection

You can use your own Fluent collector, or use Fluent Bit:

$ /opt/fluent-bit/bin/fluent-bit -i forward -p port=30001 -o stdout -p format=json_lines -m '*'
Fluent Bit v2.0.5
* Copyright (C) 2015-2022 The Fluent Bit Authors
* Fluent Bit is a CNCF sub-project under the umbrella of Fluentd
* https://fluentbit.io


[2023/01/19 03:15:40] [ info] [fluent bit] version=2.0.5, commit=, pid=2341886
[2023/01/19 03:15:40] [ info] [storage] ver=1.3.0, type=memory, sync=normal, checksum=off, max_chunks_up=128
[2023/01/19 03:15:40] [ info] [cmetrics] version=0.5.7
[2023/01/19 03:15:40] [ info] [ctraces ] version=0.2.5
[2023/01/19 03:15:40] [ info] [input:forward:forward.0] initializing
[2023/01/19 03:15:40] [ info] [input:forward:forward.0] storage_strategy='memory' (memory only)
[2023/01/19 03:15:40] [ info] [input:forward:forward.0] listening on 0.0.0.0:30001
[2023/01/19 03:15:40] [ info] [sp] stream processor started
[2023/01/19 03:15:40] [ info] [output:stdout:stdout.0] worker #0 started
{"date":1674090930.626897,"aid":"<hostname>","message_type":"Link","ts":1674090926111,"trans_mode":1,"domain":"my_domain","message":[{"active":true,"admin_state":"Enabled","deleted":false,"down_reason":"","hostname":"<hostname>","ifalias":"","ifname":"NVL1/2/1/2","kind":"nvl","managed":true,"master":"test","message_type":"Link","mtu":256,"oper_state":"active","timestamp":1674090926111,"vrf":"default"},{"active":true,"admin_state":"Enabled","deleted":false,"down_reason":"","hostname":"<hostname>","ifalias":"","ifname":"NVL1/12/2/1","kind":"nvl","managed":true,"master":"test","message_type":"Link","mtu":256,"oper_state":"init","timestamp":1674090926111,"vrf":"default"},{"active":true,"admin_state":"Enabled","deleted":false,"down_reason":"","hostname":"<hostname>","ifalias":"","ifname":"NVL1/13/2/2","kind":"nvl","managed":true,"master":"test","message_type":"Link","mtu":256,"oper_state":"init","timestamp":1674090926111,"vrf":"default"},{"active":true,"admin_state":"Enabled","deleted":false,"down_reason":"","hostname":"<hostname>","ifalias":"","ifname":"NVL2/29/2/2","kind":"nvl","managed":true,"master":"test","message_type":"Link","mtu":256,"oper_state":"init","timestamp":1674090926111,"vrf":"default"},{"active":true,"admin_state":"Enabled","deleted":false,"down_reason":"","hostname":"<hostname>","ifalias":"","ifname":"NVL2/32/1/2","kind":"nvl","managed":true,"master":"test","message_type":"Link","mtu":256,"oper_state":"init","timestamp":1674090926111,"vrf":"default"},{"active":true,"admin_state":"Enabled","deleted":false,"down_reason":"","hostname":"<hostname>","ifalias":"","ifname":"NVL1/7/1/1","kind":"nvl","managed":true,"master":"test","message_type":"Link","mtu":256,"oper_state":"init","timestamp":1674090926111,"vrf":"default"},{"active":true,"admin_state":"Enabled","deleted":false,"down_reason":"","hostname":"<hostname>","ifalias":"","ifname":"NVL1/9/1/2","kind":"nvl","managed":true,"master":"test","message_type":"Link","mtu":256,"oper_state":"init","timestamp":1674090926111,"vrf":"default"},{"active":true,"admin_state":"Enabled","deleted":false,"down_reason":"","hostname":"<hostname>","ifalias":"","ifname":"NVL2/30/1/1","kind":"nvl","managed":true,"master":"test","message_type":"Link","mtu":256,"oper_state":"init","timestamp":1674090926111,"vrf":"default"},{"active":true,"admin_state":"Enabled","deleted":false,"down_reason":"","hostname":"<hostname>","ifalias":"","ifname":"NVL1/16/2/2","kind":"nvl","managed":true,"master":"test","message_type":"Link","mtu":256,"oper_state":"init","timestamp":1674090926111,"vrf":"default"},{"active":true,"admin_state":"Enabled","deleted":false,"down_reason":"","hostname":"<hostname>","ifalias":"","ifname":"NVL2/17/2/1","kind":"nvl","managed":true,"master":"test","message_type":"Link","mtu":256,"oper_state":"init","timestamp":1674090926111,"vrf":"default"}]}