mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2025-12-22 22:20:02 +00:00
5d0e94bfa8
* docs: update project status and tweak readme Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * fix: style Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * chore: minor change Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * feat: add grafana datasource plugin project link Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * feat: adds senarior Signed-off-by: Dennis Zhuang <killme2008@gmail.com> * chore: apply suggestions Signed-off-by: Dennis Zhuang <killme2008@gmail.com> --------- Signed-off-by: Dennis Zhuang <killme2008@gmail.com>
227 lines
12 KiB
Markdown
227 lines
12 KiB
Markdown
<p align="center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: light)" srcset="https://cdn.jsdelivr.net/gh/GreptimeTeam/greptimedb@main/docs/logo-text-padding.png">
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://cdn.jsdelivr.net/gh/GreptimeTeam/greptimedb@main/docs/logo-text-padding-dark.png">
|
|
<img alt="GreptimeDB Logo" src="https://cdn.jsdelivr.net/gh/GreptimeTeam/greptimedb@main/docs/logo-text-padding.png" width="400px">
|
|
</picture>
|
|
</p>
|
|
|
|
<h2 align="center">Real-Time & Cloud-Native Observability Database<br/>for metrics, logs, and traces</h2>
|
|
|
|
> Delivers sub-second querying at PB scale and exceptional cost efficiency from edge to cloud.
|
|
|
|
<div align="center">
|
|
<h3 align="center">
|
|
<a href="https://docs.greptime.com/user-guide/overview/">User Guide</a> |
|
|
<a href="https://greptimedb.rs/">API Docs</a> |
|
|
<a href="https://github.com/GreptimeTeam/greptimedb/issues/5446">Roadmap 2025</a>
|
|
</h4>
|
|
|
|
<a href="https://github.com/GreptimeTeam/greptimedb/releases/latest">
|
|
<img src="https://img.shields.io/github/v/release/GreptimeTeam/greptimedb.svg" alt="Version"/>
|
|
</a>
|
|
<a href="https://github.com/GreptimeTeam/greptimedb/releases/latest">
|
|
<img src="https://img.shields.io/github/release-date/GreptimeTeam/greptimedb.svg" alt="Releases"/>
|
|
</a>
|
|
<a href="https://hub.docker.com/r/greptime/greptimedb/">
|
|
<img src="https://img.shields.io/docker/pulls/greptime/greptimedb.svg" alt="Docker Pulls"/>
|
|
</a>
|
|
<a href="https://github.com/GreptimeTeam/greptimedb/actions/workflows/develop.yml">
|
|
<img src="https://github.com/GreptimeTeam/greptimedb/actions/workflows/develop.yml/badge.svg" alt="GitHub Actions"/>
|
|
</a>
|
|
<a href="https://codecov.io/gh/GrepTimeTeam/greptimedb">
|
|
<img src="https://codecov.io/gh/GrepTimeTeam/greptimedb/branch/main/graph/badge.svg?token=FITFDI3J3C" alt="Codecov"/>
|
|
</a>
|
|
<a href="https://github.com/greptimeTeam/greptimedb/blob/main/LICENSE">
|
|
<img src="https://img.shields.io/github/license/greptimeTeam/greptimedb" alt="License"/>
|
|
</a>
|
|
|
|
<br/>
|
|
|
|
<a href="https://greptime.com/slack">
|
|
<img src="https://img.shields.io/badge/slack-GreptimeDB-0abd59?logo=slack&style=for-the-badge" alt="Slack"/>
|
|
</a>
|
|
<a href="https://twitter.com/greptime">
|
|
<img src="https://img.shields.io/badge/twitter-follow_us-1d9bf0.svg?style=for-the-badge" alt="Twitter"/>
|
|
</a>
|
|
<a href="https://www.linkedin.com/company/greptime/">
|
|
<img src="https://img.shields.io/badge/linkedin-connect_with_us-0a66c2.svg?style=for-the-badge" alt="LinkedIn"/>
|
|
</a>
|
|
</div>
|
|
|
|
- [Introduction](#introduction)
|
|
- [⭐ Key Features](#features)
|
|
- [Quick Comparison](#quick-comparison)
|
|
- [Architecture](#architecture)
|
|
- [Try GreptimeDB](#try-greptimedb)
|
|
- [Getting Started](#getting-started)
|
|
- [Build From Source](#build-from-source)
|
|
- [Tools & Extensions](#tools--extensions)
|
|
- [Project Status](#project-status)
|
|
- [Community](#community)
|
|
- [License](#license)
|
|
- [Commercial Support](#commercial-support)
|
|
- [Contributing](#contributing)
|
|
- [Acknowledgement](#acknowledgement)
|
|
|
|
## Introduction
|
|
|
|
**GreptimeDB** is an open-source, cloud-native database that unifies metrics, logs, and traces, enabling real-time observability at any scale — across edge, cloud, and hybrid environments.
|
|
|
|
## Features
|
|
|
|
| Feature | Description |
|
|
| --------- | ----------- |
|
|
| [All-in-One Observability](https://docs.greptime.com/user-guide/concepts/why-greptimedb) | OpenTelemetry-native platform unifying metrics, logs, and traces. Query via [SQL](https://docs.greptime.com/user-guide/query-data/sql), [PromQL](https://docs.greptime.com/user-guide/query-data/promql), and [Flow](https://docs.greptime.com/user-guide/flow-computation/overview). |
|
|
| [High Performance](https://docs.greptime.com/user-guide/manage-data/data-index) | Written in Rust with [rich indexing](https://docs.greptime.com/user-guide/manage-data/data-index) (inverted, fulltext, skipping, vector), delivering sub-second responses at PB scale. |
|
|
| [Cost Efficiency](https://docs.greptime.com/user-guide/concepts/architecture) | 50x lower operational and storage costs with compute-storage separation and native object storage (S3, Azure Blob, etc.). |
|
|
| [Cloud-Native & Scalable](https://docs.greptime.com/user-guide/deployments-administration/deploy-on-kubernetes/greptimedb-operator-management) | Purpose-built for [Kubernetes](https://docs.greptime.com/user-guide/deployments-administration/deploy-on-kubernetes/greptimedb-operator-management) with unlimited cross-cloud scaling, handling hundreds of thousands of concurrent requests. |
|
|
| [Developer-Friendly](https://docs.greptime.com/user-guide/protocols/overview) | SQL/PromQL interfaces, built-in web dashboard, REST API, MySQL/PostgreSQL protocol compatibility, and native [OpenTelemetry](https://docs.greptime.com/user-guide/ingest-data/for-observability/opentelemetry/) support. |
|
|
| [Flexible Deployment](https://docs.greptime.com/user-guide/deployments-administration/overview) | Deploy anywhere from ARM-based edge devices (including [Android](https://docs.greptime.com/user-guide/deployments-administration/run-on-android)) to cloud, with unified APIs and efficient data sync. |
|
|
|
|
✅ **Perfect for:**
|
|
- Unified observability stack replacing Prometheus + Loki + Tempo
|
|
- Large-scale metrics with high cardinality (millions to billions of time series)
|
|
- Large-scale observability platform requiring cost efficiency and scalability
|
|
- IoT and edge computing with resource and bandwidth constraints
|
|
|
|
Learn more in [Why GreptimeDB](https://docs.greptime.com/user-guide/concepts/why-greptimedb) and [Observability 2.0 and the Database for It](https://greptime.com/blogs/2025-04-25-greptimedb-observability2-new-database).
|
|
|
|
## Quick Comparison
|
|
|
|
| Feature | GreptimeDB | Traditional TSDB | Log Stores |
|
|
|----------------------------------|-----------------------|--------------------|-----------------|
|
|
| Data Types | Metrics, Logs, Traces | Metrics only | Logs only |
|
|
| Query Language | SQL, PromQL | Custom/PromQL | Custom/DSL |
|
|
| Deployment | Edge + Cloud | Cloud/On-prem | Mostly central |
|
|
| Indexing & Performance | PB-Scale, Sub-second | Varies | Varies |
|
|
| Integration | REST API, SQL, Common protocols | Varies | Varies |
|
|
|
|
**Performance:**
|
|
* [GreptimeDB tops JSONBench's billion-record cold run test!](https://greptime.com/blogs/2025-03-18-jsonbench-greptimedb-performance)
|
|
* [TSBS Benchmark](https://github.com/GreptimeTeam/greptimedb/tree/main/docs/benchmarks/tsbs)
|
|
|
|
Read [more benchmark reports](https://docs.greptime.com/user-guide/concepts/features-that-you-concern#how-is-greptimedbs-performance-compared-to-other-solutions).
|
|
|
|
## Architecture
|
|
|
|
GreptimeDB can run in two modes:
|
|
* **Standalone Mode** - Single binary for development and small deployments
|
|
* **Distributed Mode** - Separate components for production scale:
|
|
- Frontend: Query processing and protocol handling
|
|
- Datanode: Data storage and retrieval
|
|
- Metasrv: Metadata management and coordination
|
|
|
|
Read the [architecture](https://docs.greptime.com/contributor-guide/overview/#architecture) document. [DeepWiki](https://deepwiki.com/GreptimeTeam/greptimedb/1-overview) provides an in-depth look at GreptimeDB:
|
|
<img alt="GreptimeDB System Overview" src="docs/architecture.png">
|
|
|
|
## Try GreptimeDB
|
|
|
|
```shell
|
|
docker pull greptime/greptimedb
|
|
```
|
|
|
|
```shell
|
|
docker run -p 127.0.0.1:4000-4003:4000-4003 \
|
|
-v "$(pwd)/greptimedb_data:/greptimedb_data" \
|
|
--name greptime --rm \
|
|
greptime/greptimedb:latest standalone start \
|
|
--http-addr 0.0.0.0:4000 \
|
|
--rpc-bind-addr 0.0.0.0:4001 \
|
|
--mysql-addr 0.0.0.0:4002 \
|
|
--postgres-addr 0.0.0.0:4003
|
|
```
|
|
Dashboard: [http://localhost:4000/dashboard](http://localhost:4000/dashboard)
|
|
|
|
Read more in the [full Install Guide](https://docs.greptime.com/getting-started/installation/overview).
|
|
|
|
**Troubleshooting:**
|
|
* Cannot connect to the database? Ensure that ports `4000`, `4001`, `4002`, and `4003` are not blocked by a firewall or used by other services.
|
|
* Failed to start? Check the container logs with `docker logs greptime` for further details.
|
|
|
|
## Getting Started
|
|
|
|
- [Quickstart](https://docs.greptime.com/getting-started/quick-start)
|
|
- [User Guide](https://docs.greptime.com/user-guide/overview)
|
|
- [Demo Scenes](https://github.com/GreptimeTeam/demo-scene)
|
|
- [FAQ](https://docs.greptime.com/faq-and-others/faq)
|
|
|
|
## Build From Source
|
|
|
|
**Prerequisites:**
|
|
* [Rust toolchain](https://www.rust-lang.org/tools/install) (nightly)
|
|
* [Protobuf compiler](https://grpc.io/docs/protoc-installation/) (>= 3.15)
|
|
* C/C++ building essentials, including `gcc`/`g++`/`autoconf` and glibc library (eg. `libc6-dev` on Ubuntu and `glibc-devel` on Fedora)
|
|
* Python toolchain (optional): Required only if using some test scripts.
|
|
|
|
**Build and Run:**
|
|
```bash
|
|
make
|
|
cargo run -- standalone start
|
|
```
|
|
|
|
## Tools & Extensions
|
|
|
|
- **Kubernetes**: [GreptimeDB Operator](https://github.com/GrepTimeTeam/greptimedb-operator)
|
|
- **Helm Charts**: [Greptime Helm Charts](https://github.com/GreptimeTeam/helm-charts)
|
|
- **Dashboard**: [Web UI](https://github.com/GreptimeTeam/dashboard)
|
|
- **gRPC Ingester**: [Go](https://github.com/GreptimeTeam/greptimedb-ingester-go), [Java](https://github.com/GreptimeTeam/greptimedb-ingester-java), [C++](https://github.com/GreptimeTeam/greptimedb-ingester-cpp), [Erlang](https://github.com/GreptimeTeam/greptimedb-ingester-erl), [Rust](https://github.com/GreptimeTeam/greptimedb-ingester-rust)
|
|
- **Grafana Data Source**: [GreptimeDB Grafana data source plugin](https://github.com/GreptimeTeam/greptimedb-grafana-datasource)
|
|
- **Grafana Dashboard**: [Official Dashboard for monitoring](https://github.com/GreptimeTeam/greptimedb/blob/main/grafana/README.md)
|
|
|
|
## Project Status
|
|
|
|
> **Status:** Beta — marching toward v1.0 GA!
|
|
> **GA (v1.0):** January 10, 2026
|
|
|
|
- Deployed in production by open-source projects and commercial users
|
|
- Stable, actively maintained, with regular releases ([version info](https://docs.greptime.com/nightly/reference/about-greptimedb-version))
|
|
- Suitable for evaluation and pilot deployments
|
|
|
|
GreptimeDB v1.0 represents a major milestone toward maturity — marking stable APIs, production readiness, and proven performance.
|
|
|
|
**Roadmap:** Beta1 (Nov 10) → Beta2 (Nov 24) → RC1 (Dec 8) → GA (Jan 10, 2026), please read [v1.0 highlights and release plan](https://greptime.com/blogs/2025-11-05-greptimedb-v1-highlights) for details.
|
|
|
|
For production use, we recommend using the latest stable release.
|
|
[](https://www.star-history.com/#GreptimeTeam/GreptimeDB&Date)
|
|
|
|
If you find this project useful, a ⭐ would mean a lot to us!
|
|
<img alt="Known Users" src="https://greptime.com/logo/img/users.png"/>
|
|
|
|
## Community
|
|
|
|
We invite you to engage and contribute!
|
|
|
|
- [Slack](https://greptime.com/slack)
|
|
- [Discussions](https://github.com/GreptimeTeam/greptimedb/discussions)
|
|
- [Official Website](https://greptime.com/)
|
|
- [Blog](https://greptime.com/blogs/)
|
|
- [LinkedIn](https://www.linkedin.com/company/greptime/)
|
|
- [X (Twitter)](https://X.com/greptime)
|
|
- [YouTube](https://www.youtube.com/@greptime)
|
|
|
|
## License
|
|
|
|
GreptimeDB is licensed under the [Apache License 2.0](https://apache.org/licenses/LICENSE-2.0.txt).
|
|
|
|
## Commercial Support
|
|
|
|
Running GreptimeDB in your organization?
|
|
We offer enterprise add-ons, services, training, and consulting.
|
|
[Contact us](https://greptime.com/contactus) for details.
|
|
|
|
## Contributing
|
|
|
|
- Read our [Contribution Guidelines](https://github.com/GreptimeTeam/greptimedb/blob/main/CONTRIBUTING.md).
|
|
- Explore [Internal Concepts](https://docs.greptime.com/contributor-guide/overview.html) and [DeepWiki](https://deepwiki.com/GreptimeTeam/greptimedb).
|
|
- Pick up a [good first issue](https://github.com/GreptimeTeam/greptimedb/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and join the #contributors [Slack](https://greptime.com/slack) channel.
|
|
|
|
## Acknowledgement
|
|
|
|
Special thanks to all contributors! See [AUTHORS.md](https://github.com/GreptimeTeam/greptimedb/blob/main/AUTHOR.md).
|
|
|
|
- Uses [Apache Arrow™](https://arrow.apache.org/) (memory model)
|
|
- [Apache Parquet™](https://parquet.apache.org/) (file storage)
|
|
- [Apache DataFusion™](https://arrow.apache.org/datafusion/) (query engine)
|
|
- [Apache OpenDAL™](https://opendal.apache.org/) (data access abstraction)
|