Test your InfluxDB Cluster
With your InfluxDB cluster deployed and running, test to ensure you can successfully write and query data from InfluxDB.
- Download and install influxctl
- Retrieve your cluster’s admin token
- Configure influxctl to connect to your cluster
- Create a new database
- Write test data to the new database
- 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.
-
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.
-
Make this configuration file available to
influxctl
in one of the following ways:- Include the
--config
flag with allinfluxctl
commands to specify the filepath of yourconfig.toml
. - Store the
config.toml
file at the default location thatinfluxctl
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 yourinfluxctl
commands.
- Include the
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.
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:
If the query successfully returns data, your InfluxDB cluster is set up and functional.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.