GreptimeCloud | User Guide | API Docs | Roadmap 2024

• Introduction
• Features: Why GreptimeDB
• Architecture
• Try it for free
• Getting Started
• Project Status
• Join the community
  • Contributing
• Tools & Extensions
• License
• Acknowledgement

GreptimeDB is an open-source unified & cost-effective time-series database for Metrics, Logs, and Events (also Traces in plan). You can gain real-time insights from Edge to Cloud at Any Scale.

Our core developers have been building time-series data platforms for years. Based on our best practices, GreptimeDB was born to give you:

• Unified Processing of Metrics, Logs, and Events

GreptimeDB unifies time series data processing by treating all data - whether metrics, logs, or events - as timestamped events with context. Users can analyze this data using either SQL or PromQL and leverage stream processing (Flow) to enable continuous aggregation. Read more.

• Cloud-native Distributed Database

Built for Kubernetes. GreptimeDB achieves seamless scalability with its cloud-native architecture of separated compute and storage, built on object storage (AWS S3, Azure Blob Storage, etc.) while enabling cross-cloud deployment through a unified data access layer.

• Performance and Cost-effective

Written in pure Rust for superior performance and reliability. GreptimeDB features a distributed query engine with intelligent indexing to handle high cardinality data efficiently. Its optimized columnar storage achieves 50x cost efficiency on cloud object storage through advanced compression. Benchmark reports.

• Cloud-Edge Collaboration

GreptimeDB seamlessly operates across cloud and edge (ARM/Android/Linux), providing consistent APIs and control plane for unified data management and efficient synchronization. Learn how to run on Android.

• Multi-protocol Ingestion, SQL & PromQL Ready

Widely adopted database protocols and APIs, including MySQL, PostgreSQL, InfluxDB, OpenTelemetry, Loki and Prometheus, etc. Effortless Adoption & Seamless Migration. Supported Protocols Overview.

For more detailed info please read Why GreptimeDB.

Try out the features of GreptimeDB right from your browser.

Start instantly with a free cluster.

To install GreptimeDB locally, the recommended way is via Docker:

docker pull greptime/greptimedb

Start a GreptimeDB container with:

docker run -p 127.0.0.1:4000-4003:4000-4003 \
  -v "$(pwd)/greptimedb:/tmp/greptimedb" \
  --name greptime --rm \
  greptime/greptimedb:latest standalone start \
  --http-addr 0.0.0.0:4000 \
  --rpc-addr 0.0.0.0:4001 \
  --mysql-addr 0.0.0.0:4002 \
  --postgres-addr 0.0.0.0:4003

Access the dashboard via http://localhost:4000/dashboard.

Read more about Installation on docs.

• Quickstart
• User Guide
• Demos
• FAQ

Check the prerequisite:

• Rust toolchain (nightly)
• Protobuf compiler (>= 3.15)
• Python toolchain (optional): Required only if built with PyO3 backend. More detail for compiling with PyO3 can be found in its documentation.

Build GreptimeDB binary:

make

Run a standalone server:

cargo run -- standalone start

• The dashboard UI for GreptimeDB

• GreptimeDB Go Ingester
• GreptimeDB Java Ingester
• GreptimeDB C++ Ingester
• GreptimeDB Erlang Ingester
• GreptimeDB Rust Ingester
• GreptimeDB JavaScript Ingester

Our official Grafana dashboard for monitoring GreptimeDB is available at grafana directory.

GreptimeDB is currently in Beta. We are targeting GA (General Availability) with v1.0 release by Early 2025.

While in Beta, GreptimeDB is already:

• Being used in production by early adopters
• Actively maintained with regular releases, about version number
• Suitable for testing and evaluation

For production use, we recommend using the latest stable release.

Our core team is thrilled to see you participate in any ways you like. When you are stuck, try to ask for help by filling an issue with a detailed description of what you were trying to do and what went wrong. If you have any questions or if you would like to get involved in our community, please check out:

• GreptimeDB Community on Slack
• GreptimeDB GitHub Discussions forum
• Greptime official website

In addition, you may:

• View our official Blog
• Connect us with Linkedin
• Follow us on Twitter

If you are running GreptimeDB OSS in your organization, we offer additional enterprise add-ons, installation services, training, and consulting. Contact us and we will reach out to you with more detail of our commercial license.

GreptimeDB uses the Apache License 2.0 to strike a balance between open contributions and allowing you to use the software however you want.

Please refer to contribution guidelines and internal concepts docs for more information.

Special thanks to all the contributors who have propelled GreptimeDB forward. For a complete list of contributors, please refer to AUTHOR.md.

• GreptimeDB uses Apache Arrow™ as the memory model and Apache Parquet™ as the persistent file format.
• GreptimeDB's query engine is powered by Apache Arrow DataFusion™.
• Apache OpenDAL™ gives GreptimeDB a very general and elegant data access abstraction layer.
• GreptimeDB's meta service is based on etcd.
• GreptimeDB uses RustPython for experimental embedded python scripting.