User Guide

Catalog

Introduction

• About openGemini
• Cluster architecture
• Database Performance

Quick start

• Install & Deployment
• Deploying on Docker
• Deploying on K8s

Deployment

• Deploy manual (Not Recommented）
• One-click deployment (Recommended)

Write data

• Line Protocol Insert
• Column protocol
• Prometheus remote read/write

Query data

• Use InfluxQL
• Use PromQL

Schema

• Manage databases
• Manage meausurments
• Retention policy
• Manage schema

Develop with SDK

• Drivers
• Client Design
• client-cpp
• Client-go
• Client-java
• Client-python
• client-rust
• client-ts

Features

• Stream aggregate
• Log search
• Muti-level downsample
• Anomaly detection
• Continue query
• High-series cardinality
• Subscription
• TAG array
• Data Replication

System functions

• Aggregates
• Maths
• Selectors
• Strings
• Anomaly detection

Security & user

• Authentication
• Use HTTPS
• User management

Data migrate

• Influx2openGemini
• ES2openGemini

Maintenance

• Monitor openGemini
• Scale-out
• Back & Restore
• O&M commands

Kernel technology

• Indexes
• File layout
• Data compression

Contribute to openGemini

• Add a strings function
• Add a selector
• Add a AI algorithm

Reference

• Configuration file
• Sample data
• Internal ports
• Telemetry data
• Math expression
• Data types
• Server specification
• Key words
• Functions&Operators(PromQL)

Release notes

• Release notes(v1.3-rc.1)
• Release notes(v1.3.0)
• ROADMAP

Troubleshoot

• Frequently asked questions
• Common errors and solutions