InfluxDB IOx (short for Iron Oxide, pronounced InfluxDB "eye-ox") is the future core of InfluxDB, an open source time series database. The name is in homage to Rust, the language this project is written in. It is built using Apache Arrow and DataFusion among other things. InfluxDB IOx aims to be:
Persistence is through Parquet files in object storage. It is a design goal to support integration with other big data systems through object storage and Parquet specifically.
For more details on the motivation behind the project and some of our goals, read through the InfluxDB IOx announcement blog post. If you prefer a video that covers a little bit of InfluxDB history and high level goals for InfluxDB IOx you can watch Paul Dix's announcement talk from InfluxDays NA 2020. For more details on the motivation behind the selection of Apache Arrow, Flight and Parquet, read this.
This project is very early and in active development. It isn't yet ready for testing, which is why we're not producing builds or documentation yet. If you're interested in following along with the project, drop into our community Slack channel #influxdb_iox. You can find links to join here.
We're also hosting monthly tech talks and community office hours on the project on the 2nd Wednesday of the month at 8:30 AM Pacific Time.
To compile and run InfluxDB IOx from source, you'll need the following:
The easiest way to install Rust is to use rustup
, a Rust version manager.
Follow the instructions for your operating system on the rustup
site.
rustup
will check the rust-toolchain
file and automatically install and use the correct Rust version for you.
Building InfluxDB IOx requires clang
(for the croaring
dependency).
Check for clang
by running clang --version
.
clang --version
Apple clang version 12.0.0 (clang-1200.0.32.27)
Target: x86_64-apple-darwin20.1.0
Thread model: posix
InstalledDir: /Library/Developer/CommandLineTools/usr/bin
If clang
is not already present, it can typically be installed with the system package manager.
Clone this repository using git
.
If you use the git
command line, this looks like:
git clone git@github.com:influxdata/influxdb_iox.git
Then change into the directory containing the code:
cd influxdb_iox
The rest of these instructions assume you are in this directory.
InfluxDB IOx can be configured using either environment variables or a configutation file, making it suitable for deployment in containerized environments.
For a list configuration options, run influxdb_iox --help
.
For configuration options for specific subcommands, run influxdb_iox <subcommand> --help
.
To use a configuration file, use a .env
file in the working directory.
See the provided example configuration file.
To use the example configuration file, run:
cp docs/env.example .env
InfluxDB IOx is built using Cargo, Rust's package manager and build tool.
To compile for development, run:
cargo build
This which will create a binary at target/debug/influxdb_iox
.
To start the InfluxDB IOx server, run:
./target/debug/influxdb_iox run
By default the server will start an HTTP server on port 8080
and a gRPC server on port 8082
.
You can also compile and run with one command:
cargo run -- run
To compile for performance testing, build in release mode:
cargo build --release
./target/release/influxdb_iox run
You can also run in release mode with one step:
cargo run --release -- run
Building the Docker image requires:
To enable BuildKit by default, set { "features": { "buildkit": true } }
in the Docker engine configuration,
or run docker build
withDOCKER_BUILDKIT=1
To build the Docker image:
DOCKER_BUILDKIT=1 docker build .
Each IOx instance requires a writer ID. This can be set one of 4 ways:
INFLUXDB_IOX_ID=42
--writer-id 42
influxdb_iox writer set 42
To write data, you need to create a database.
You can do so via the API or using the CLI.
For example, to create a database called company_sensors
, use this command:
influxdb_iox database create company_sensors
Data can be stored in InfluxDB IOx by sending it in line protocol format to the /api/v2/write
endpoint or using the CLI.
For example, here is a command that will send the data in the tests/fixtures/lineproto/metrics.lp
file in this repository, assuming that you're running the server on the default port into the company_sensors
database, you can use:
influxdb_iox database write company_sensors tests/fixtures/lineproto/metrics.lp
To query data stored in the company_sensors
database:
influxdb_iox database query company_sensors "SELECT * FROM cpu LIMIT 10"
InfluxDB IOx is packaged as a binary with commands to start the IOx server, as well as a CLI interface for interacting with and configuring such servers.
The CLI itself is documented via built-in help which you can access by running influxdb_iox --help
InfluxDB IOx allows seamless interoperability with InfluxDB 2.0.
Where InfluxDB 2.0 stores data in organizations and buckets,
InfluxDB IOx stores data in named databases.
IOx maps organization
and bucket
pairs to databases named with the two parts separated by an underscore (_
):
organization_bucket
.
Here's an example using curl
to send data into the company_sensors
database using the InfluxDB 2.0 /api/v2/write
API:
curl -v "http://127.0.0.1:8080/api/v2/write?org=company&bucket=sensors" --data-binary @tests/fixtures/lineproto/metrics.lp
The HTTP API exposes a healthcheck endpoint at /health
$ curl http://127.0.0.1:8080/health
OK
The gRPC API implements the gRPC Health Checking Protocol.
This can be tested with grpc-health-probe
:
$ grpc_health_probe -addr 127.0.0.1:8082 -service influxdata.platform.storage.Storage
status: SERVING
To manually invoke one of the gRPC APIs, use a gRPC CLI client such as grpcurl.
Tonic (the gRPC server library we're using) currently doesn't have support for gRPC reflection, hence you must pass all .proto
files to your client.
You can find a conventient grpcurl
wrapper that does that in the scripts
directory:
$ ./scripts/grpcurl -plaintext 127.0.0.1:8082 list
grpc.health.v1.Health
influxdata.iox.management.v1.ManagementService
influxdata.platform.storage.IOxTesting
influxdata.platform.storage.Storage
$ ./scripts/grpcurl -plaintext 127.0.0.1:8082 influxdata.iox.management.v1.ManagementService.ListDatabases
{
"names": [
"foobar_weather"
]
}
We welcome community contributions from anyone!
Read our Contributing Guide for instructions on how to run tests and how to make your first contribution.
There are a variety of technical documents describing various parts of IOx in the docs directory.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。