Administering InfluxDB

Backup and Restore

Backups InfluxDB has the ability to snapshot an instance at a point-in-time and restore it. All backups are full backups. InfluxDB does not yet support incremental backups. There are two types of data to backup, the metastore and the metrics themselves. The metastore is backed up in its entirety. The metrics are backed up per-database in a separate operation from the metastore backup. Note: Backups are not interchangeable between InfluxDB OSS and InfluxDB Enterprise.

Configuration

The InfluxDB configuration file contains configuration settings specific to a local node. Content Using configuration files Configuration options overview Environment variables Configuration options by section Global options reporting-disabled bind-address GOMAXPROCS [meta] dir retention-autocreate logging-enabled [data] dir index-version wal-dir wal-fsync-delay trace-logging-enabled query-log-enabled cache-max-memory-size cache-snapshot-memory-size cache-snapshot-write-cold-duration compact-full-write-cold-duration max-concurrent-compactions max-series-per-database max-values-per-tag [coordinator] write-timeout max-concurrent-queries query-timeout log-queries-after max-select-point max-select-series max-select-buckets [retention] enabled check-interval [shard-precreation] enabled check-interval advance-period [admin] [monitor] store-enabled store-database store-interval [subscriber] enabled http-timeout insecure-skip-verify ca-certs write-concurrency write-buffer-size [http] enabled bind-address auth-enabled realm log-enabled write-tracing pprof-enabled https-enabled https-certificate https-private-key shared-secret max-row-limit max-connection-limit unix-socket-enabled bind-socket max-body-size [[graphite]] enabled database retention-policy bind-address protocol consistency-level batch-size batch-pending batch-timeout udp-read-buffer separator [[collectd]] enabled bind-address database retention-policy typesdb security-level auth-file batch-size batch-pending batch-timeout read-buffer [[opentsdb]] enabled bind-address database retention-policy consistency-level tls-enabled certificate log-point-errors batch-size batch-pending batch-timeout [[udp]] enabled bind-address database retention-policy batch-size batch-pending batch-timeout read-buffer precision [continuous_queries] enabled log-enabled query-stats-enabled run-interval Using Configuration Files The system has internal defaults for every configuration file setting.

Differences Between InfluxDB 1.3 and 1.2

This page aims to ease the transition from InfluxDB 1.2 to InfluxDB 1.3. For a comprehensive list of the differences between the versions see InfluxDB’s Changelog. Content TSI Release Web Admin UI Removal Duration Unit Updates InfluxQL Updates Operators Functions Other TSI Release Version 1.3.0 marked the first official release of InfluxDB’s new time series index (TSI) engine. The TSI engine is a significant technical advancement in InfluxDB. It offers a solution to the time-structured merge tree engine’s high series cardinality issue.

Differences between InfluxDB 1.3 and versions prior to 1.2

If you’re using version 1.2, please see Differences Between InfluxDB 1.3 and 1.2. Users looking to upgrade to InfluxDB 1.3 from versions prior to 1.2 should view the following pages in our documentation. 1.1 users: Differences Between InfluxDB 1.2 and 1.1 1.0 users: Differences Between InfluxDB 1.1 and 1.0 0.13 users: Differences Between InfluxDB 1.0 and 0.13 0.12 users: Differences Between InfluxDB 0.13 and 0.12 0.11 users: Differences between InfluxDB 0.

HTTPS Setup

This guide describes how to enable HTTPS with InfluxDB. Setting up HTTPS secures the communication between clients and the InfluxDB server, and, in some cases, HTTPS verifies the authenticity of the InfluxDB server to clients. If you plan on sending requests to InfluxDB over a network, we strongly recommend that you set up HTTPS. Requirements To set up HTTPS with InfluxDB, you’ll need an existing or new InfluxDB instance and a Transport Layer Security (TLS) certificate (also known as a Secured Sockets Layer (SSL) certificate).

Logs

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 If you run InfluxDB directly, using influxd, all logs will be written to stderr. You may redirect this log output as you would any output to stderr like so: influxd 2>$HOME/my_log_file Launched as a service sysvinit If InfluxDB was installed using a pre-built package, and then launched as a service, stderr is redirected to /var/log/influxdb/influxd.

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 that runs the RPC service for backup and 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. Resources Graphite README 4242 The default port that runs the OpenTSDB service.

Security Best Practices

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. Enable Authentication Password protect your InfluxDB instance to keep any unauthorized individuals from accessing your data. Resources: Set up Authentication Manage Users and their Permissions Restrict access by creating individual users and assigning them relevant read and/or write permissions.

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 HTTP API changes When it comes to the HTTP API, if a command works in 1.

Upgrading from previous versions

This page outlines process for upgrading from: Version 0.12-1.2 to 1.3 Version 0.10 or 0.11 to 1.3 Upgrade from 0.12-1.2 to 1.3 Download InfluxDB version 1.3 Update the configuration file Migrate any customizations in the 1.2 configuration file to the 1.3 configuration file. Restart the process Check out the new features outlined in Differences between InfluxDB 1.3 and 1.2 Upgrade from 0.10 or 0.11 to 1.3 Note: 0.10 users will need to convert any remaining b1 and bz1 shards to TSM format before following the instructions below.