Administering InfluxDB
This page documents an earlier version of InfluxDB. InfluxDB v2.6 is the latest stable version.
The administration documentation contains all the information needed to administer a working InfluxDB installation.
Authentication and authorization in InfluxDB
This document covers setting up and managing authentication and authorization in InfluxDB. Authentication: Authorization: Set up Authentication User Types and Privileges Authenticate Requests User Management Commands HTTP Errors HTTP Errors Note: Authentication and authorization should not be relied upon to prevent access and protect data from malicious actors. If additional security or compliance features are desired, InfluxDB should be run behind a third-party service. If InfluxDB is being deployed on a publicly accessible endpoint, we strongly recommend authentication be enabled.
Backing up and restoring in InfluxDB OSS
Using InfluxDB OSS backup and restore utilities for online, Enterprise-compatible use and portability between InfluxDB Enterprise and InfluxDB OSS servers.
Configuring InfluxDB OSS
The InfluxDB open source (OSS) configuration file contains configuration settings specific to a local node. Content Configuration overview Environment variables InfluxDB environment variables (INFLUXDB_*) GOMAXPROCS environment variable Using the configuration file Configuration settings Global settings Metastore [meta] Data [data] Query management [coordinator] Retention policies [retention] Shard precreation [shard-precreation] Monitoring [monitor] HTTP endpoints [http] Subscriptions [subscriber] Graphite [[graphite]] CollectD [[collectd]] OpenTSB [[opentsdb]] UDP [[udp]] Continuous queries [continuous_queries] TLS [tls] Configuration overview InfluxDB is configured using the configuration file (influxdb.
Enabling HTTPS with InfluxDB
Enable HTTPS and Transport Security Layer (TLS) secure communication between clients and your InfluxDB servers.
InfluxDB ports
Enabled ports 8086 The default port that runs the InfluxDB HTTP service. Configure this port in the configuration file. Resources API Reference 8088 The default port used by the RPC service for RPC calls made by the CLI for backup and restore operations (influxdb backup and influxd restore). Configure this port in the configuration file. Resources Backup and Restore Disabled ports 2003 The default port that runs the Graphite service. Enable and configure this port in the configuration file.
InfluxDB server monitoring
On this page SHOW STATS SHOW DIAGNOSTICS Internal monitoring Useful performance metrics commands InfluxDB /metrics HTTP endpoint InfluxDB can display statistical and diagnostic information about each node. This information can be very useful for troubleshooting and performance monitoring. SHOW STATS To see node statistics, execute the command SHOW STATS. For details on this command, see SHOW STATS in the InfluxQL specification. The statistics returned by SHOW STATS are stored in memory only, and are reset to zero when the node is restarted.
Logging and tracing in InfluxDB
Content Logging locations HTTP access logging Structured logging Tracing Logging locations InfluxDB writes log output, by default, to stderr. Depending on your use case, this log information can be written to another location. Running InfluxDB directly When you run InfluxDB directly, using influxd, all logs are written to stderr. You can also redirect the log output, as you would any output to stderr, like in this example: influxd 2>$HOME/my_log_file Launched as a service systemd sysinit
Manage subscriptions in InfluxDB
InfluxDB uses subscriptions to copy all written data to a local or remote endpoint. This article walks through how InfluxDB subscriptions work, how to configure them, and how to manage them.
Managing InfluxDB security
Some customers may choose to install InfluxDB with public internet access, however doing so can inadvertently expose your data and invite unwelcome attacks on your database. Check out the sections below for how protect the data in your InfluxDB instance. Enabling authentication Password protect your InfluxDB instance to keep any unauthorized individuals from accessing your data. Resources: Set up Authentication Managing users and permissions Restrict access by creating individual users and assigning them relevant read and/or write permissions.
Rebuild the TSI index
Rebuild your InfluxDB TSI index using the influxd_inspect buildtsi
command.
Stability and compatibility
1.x API compatibility and stability One of the more important aspects of the 1.0 release is that this marks the stabilization of our API and storage format. Over the course of the last three years we’ve iterated aggressively, often breaking the API in the process. With the release of 1.0 and for the entire 1.x line of releases we’re committing to the following: No breaking InfluxDB API changes When it comes to the InfluxDB API, if a command works in 1.
Upgrading to InfluxDB 1.7.x
We recommend enabling Time Series Index (TSI) (step 3 of Upgrade to InfluxDB 1.7.x). To learn more about TSI, see: Time Series Index (TSI) overview Time Series Index (TSI) details Note: The default InfluxDB configuration continues to use in-memory indexes (inmem) (as in earlier versions). Upgrade to InfluxDB Enterprise To upgrade from InfluxDB OSS to InfluxDB Enterprise, contact InfluxData Sales and see Migrate to InfluxDB Enterprise. Upgrade to InfluxDB 1.7.x Download InfluxDB 1.
Downgrading
To revert to a prior version, complete the same steps as when Upgrading to InfluxDB 1.7.x, replacing 1.7.x with the version you want to downgrade to. After downloading the release, migrating your configuration settings, and enabling TSI or TSM, make sure to rebuild your index.
Note: Some versions of InfluxDB may have breaking changes that impact your ability to upgrade and downgrade. For example, you cannot downgrade from InfluxDB 1.3 or later to an earlier version. Please review the applicable version of release notes to check for compatibility issues between releases.
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:
InfluxDB Cloud and InfluxDB Enterprise customers can contact InfluxData Support.