Documentation

Test your InfluxDB Cluster

With your InfluxDB cluster deployed and running, test to ensure you can successfully write and query data from InfluxDB.

  1. Download and install influxctl
  2. Retrieve your cluster’s admin token
  3. Configure influxctl to connect to your cluster
  4. Create a new database
  5. Write test data to the new database
  6. Query the test data from your database

Download and install influxctl

influxctl is a command line tool that lets you manage, write data to, and query data from your InfluxDB cluster from your local machine.

Download and install influxctl

Retrieve your cluster’s admin token

InfluxDB Clustered generates a valid access token (known as the admin token) and stores it as a secret in your cluster’s influxdb namespace. During this phase of the installation process, use the admin token with influxctl in lieu of configuring and using an identity provider.

Use kubectl to retrieve the admin token from your influxdb namespace secret store and copy it to a file:

kubectl get secrets/admin-token \
  --template={{.data.token}} \
  --namespace influxdb | base64 -d > token.json

Configure influxctl to connect to your cluster

Create an influxctl connection profile for your InfluxDB cluster. Connection profiles are stored in a config.toml file on your local machine and contain the credentials necessary to connect to and authorize with your InfluxDB cluster.

  1. Create a file named config.toml with the following contents:

    [[profile]]
      name = "default"
      product = "clustered"
      host = "cluster-host.com"
      port = "
    INFLUXDB_PORT
    "
    [profile.auth.token] token_file = "/
    DIRECTORY_PATH
    /token.json"

    In the example above, replace the following:

    • INFLUXDB_PORT: The port to use to connect to your InfluxDB cluster.
    • DIRECTORY_PATH: The directory path to your admin token file, token.json.

    To set your InfluxDB cluster host, click Set InfluxDB cluster URL below the codeblock above and provide your cluster’s host. This will update your cluster’s host in all code examples.

  2. Make this configuration file available to influxctl in one of the following ways:

    • Include the --config flag with all influxctl commands to specify the filepath of your config.toml.
    • Store the config.toml file at the default location that influxctl expects to find connection profiles based on your operating system. If your connection profile is in the default location, you do not need to include the --config flag with your influxctl commands.

Connection configuration examples

In the examples below, replace CONFIG_PATH with the directory path to your connection configuration file. If you placed your configuration file in the default location for your operating system, remove --config /CONFIG_PATH/config.toml from the example commands before running them.

Create a new database

Use influxctl database create to create a new database named testdb. Include the following:

  • (Optional) The path to your connection profile configuration file.
  • The database name–testdb.
influxctl --config /
CONFIG_PATH
/config.toml database create testdb

Write test data to the new database

Use influxctl write to write the following test data to your testdb database. Provide the following:

  • (Optional) The path to your connection profile configuration file.
  • The database name–testdb.
  • Line protocol to write to InfluxDB.
influxctl --config /
CONFIG_PATH
/config.toml write \
--database testdb \ "home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000000000000 home,room=Kitchen temp=21.0,hum=35.9,co=0i 1641024000000000000 home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1641027600000000000 home,room=Kitchen temp=23.0,hum=36.2,co=0i 1641027600000000000 "

Query the test data from your database

Use influxctl query to query the test data from your testdb database. Provide the following:

  • (Optional) The path to your connection profile configuration file.
  • The database name–testdb.
  • The SQL query to execute.
influxctl --config /
CONFIG_PATH
/config.toml query \
--database testdb \ "SELECT * FROM home"

This should return results similar to:

cohumroomtemptime
035.9Living Room21.12022-01-01T08:00:00Z
035.9Kitchen212022-01-01T08:00:00Z
021.4Living Room21.42022-01-01T09:00:00Z
036.2Kitchen232022-01-01T09:00:00Z

If the query successfully returns data, your InfluxDB cluster is set up and functional.


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 v3 enhancements and InfluxDB Clustered is now generally available

New capabilities, including faster query performance and management tooling advance the InfluxDB v3 product line. InfluxDB Clustered is now generally available.

InfluxDB v3 performance and features

The InfluxDB v3 product line has seen significant enhancements in query performance and has made new management tooling available. These enhancements include an operational dashboard to monitor the health of your InfluxDB cluster, single sign-on (SSO) support in InfluxDB Cloud Dedicated, and new management APIs for tokens and databases.

Learn about the new v3 enhancements


InfluxDB Clustered general availability

InfluxDB Clustered is now generally available and gives you the power of InfluxDB v3 in your self-managed stack.

Talk to us about InfluxDB Clustered