Documentation

Manage node labels

Assign user-defined labels to nodes in your InfluxDB Enterprise cluster. Node labels are user-defined key-value pairs assigned to nodes in your cluster that act as metadata for each node.

The tools used for viewing and managing node labels in your InfluxDB Enterprise cluster are the influxd-ctl show command and the influxd-ctl node-label command and subcommands.

View node labels

Use the influxd-ctl show command to view information about nodes in your InfluxDB Enterprise cluster, including node labels.

influxd-ctl show
  • Copy
  • Fill window

View example influxd-ctl show output

Add labels to a node

To add a label to a node in your InfluxDB Enterprise cluster, use the influxd-ctl node-labels set command and include the following flags:

  • -nodeid: Node ID to add the labels to
  • -labels: JSON object of label key-value pairs
influxd-ctl node-labels set -nodeid 4 -labels '{"az":"us-east","team":"amer"}'
  • Copy
  • Fill window

View influxd-ctl show output with added labels

Update node labels

To update node labels, use the influxd-ctl node-labels set command and include the following flags:

  • -nodeid: Node ID to update the labels on
  • -labels: JSON object of label key-value pairs to update
influxd-ctl node-labels set -nodeid 4 -labels '{"team":"emea"}'
  • Copy
  • Fill window

Only label keys included in the -labels JSON object are updated. All other node labels are not modified.

View influxd-ctl show output with updated labels

Delete node labels

To update node labels, use the influxd-ctl node-labels set command and include the following flags:

  • -nodeid: Node ID to update the labels on
  • -labels: JSON object of label key-value pairs to update
influxd-ctl node-labels delete -nodeid 4 -labels '["team"]'
  • Copy
  • Fill window

View influxd-ctl show output with deleted label

Programmatically access node labels

Use the /show-cluster endpoint of meta node API to return a JSON object containing information about your InfluxDB Enterprise cluster, including node labels.

GET meta-node-host:8191/show-cluster
  • Copy
  • Fill window

View example JSON output


Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

InfluxDB 3 Core and Enterprise are now in Beta

InfluxDB 3 Core and Enterprise are now available for beta testing, available under MIT or Apache 2 license.

InfluxDB 3 Core is a high-speed, recent-data engine that collects and processes data in real-time, while persisting it to local disk or object storage. InfluxDB 3 Enterprise is a commercial product that builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries. A free tier of InfluxDB 3 Enterprise will also be available for at-home, non-commercial use for hobbyists to get the full historical time series database set of capabilities.

For more information, check out: