openGemini

README

简体中文 | English

Official Website | Docs | Contribution Guide

About openGemini

openGemini is an open-source,cloud-native time-series database(TSDB) that can be widely used in IoT, Internet of Vehicles(IoV), O&M monitoring, and industrial Internet scenarios.It developed by HUAWEI CLOUD and it has excellent read/write performance and efficient data analysis capabilities. It uses an SQL-like query language, does not rely on third-party software, and is easy to install, deploy, and maintain. We encourage contribution and collaboration to the community.

Why openGemini

• High-performance read and write
  • 10-million-scale concurrent writes of metrics per second
  • Millisecond-level response for querying tens of thousands of sensors data
• Supports time-series data analysis
  • Built-in AI data analysis algorithm
  • Supports real-time abnormality detection and prediction of time-series data
• Ecosystem compatibility
  • Compatible with InfluxDB line protocol and Influxql
  • Compatible with existing InfluxDB toolchain
  • Supports promethus remote read/write API
• Efficient management of massive time series data
  • Supports 100-million-scale time series management
  • Built-in efficient data compression algorithm, with a storage cost of only 1/20 compared to traditional databases
• Distributed
  • Provides horizontal scalability and supports hundreds of nodes in a cluster
• Flexible deployment
  • Runs the executable binary files without external dependencies
  • All the configuration is done with reasonable defaults
  • Supports single-node and cluster deployment

Third-party supports

currently openGemini only supports Linux OS, and supports InfluxDB ecosystem toolchains, such as:

Drivers: JavaScript, Java, C/C++, Ruby, Go, Python, PHP

Client: Influx

Data access tools: StatsD, EMQ, Telegraf, Icinga2, HiveMQ, Kafka, MQTT

Data insight tools: Chronograf, Grafana

Big data and data analysis systems: Zeppelin, Flink, Spark, Kapacitor, etc.

Quick Start

For a more detailed introduction, please visit our official website User Guide

This section mainly contains the following:

• How to compile openGemini source code
• How to run openGemini

Compiling environment information

GO version v1.16+

Python version v3.7+

How to set GO environment variables

Open ~/.profile configuration file and add the following configurations to the end of the file:

export GOPATH=/path/to/dir
export GOBIN=$GOPATH/bin
export GO111MODULE=on
export GONOSUMDB=*
export GOSUMDB=off

Compiling

1. Clone source codes from Github

> cd $GOPATH
> mkdir -p {pkg,bin,src}
> cd src
> git clone https://github.com/openGemini/openGemini.git

1. Enter the home directory

> cd openGemini

1. Compiling

> export CGO_LDFLAGS="-Wl,-z,now -Wl,-z,relro -Wl,-z,noexecstack -fPIE -ftrapv"
> export CGO_CFLAGS="-fstack-protector-strong -D_FORTIFY_SOURCE=2 -O2"
> python build.py

The compiled binary file is in the build directory

> ls build
ts-cli ts-meta ts-monitor ts-server  ts-sql  ts-store

Configuration

The configuration file is in the conf directory. For more information about the configuration items, please refer to User Guide --> Configuration Files

Run openGemini

Standalone operation

> cd openGemini
> mkdir -p /tmp/openGemini
> sh scripts/install.sh

Refer to cluster deployments in User Guide

Using openGemini

Use the client to connect to openGemini

> ts-cli -host 127.0.0.1 -port 8086

After successful login, the following message will be displayed

> ts-cli -host 127.0.0.1 -port 8086
openGemini CLI 0.1.0 (rev-revision)
Please use 'quit', 'exit' or 'Ctrl-D' to exit this program
> 

Create a database

> create database sensordb
> use sensordb

The openGemini supports three ways for creating a measurement.

• Implicit creation, automatic creation measurement when data is written. By default, partition is based on time.
• explicit creation, without specifying the partition key, as the same as implicit creation.

> create measurement sensor

• explicit creation, specifying partition keys during table creation, During data storage, the table will be primarily partitioned by time, and then secondarily partitioned according to the specified partition keys.

> create measurement sensor with shardkey farmID

Write data

insert sensor,farmID=f1,deviceID=d0 sensorID=s20,value=50.98

Query data

> select * from sensor
name: sensor
+---------------------+----------+--------+----------+-------+
| time                | deviceID | farmID | sensorID | value |
+---------------------+----------+--------+----------+-------+
| 1657959880895515464 | d0       | f1     | s20      | 50.98 |
+---------------------+----------+--------+----------+-------+
5 columns,1 rows in set
Elapsed: 7.723332ms  

Join & Contribute

Tips for Contribution

Contact Us

1. Slack

2. Twitter

License

openGemini is licensed under the Apache License 2.0. Refer to LICENSE for more details.