diff --git a/README.md b/README.md index 017ec46b6a..6c83582a24 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@

- User Guide | + User Guide | API Docs | Roadmap 2025

@@ -66,17 +66,24 @@ ## Introduction -**GreptimeDB** is an open-source, cloud-native database purpose-built for the unified collection and analysis of observability data (metrics, logs, and traces). Whether you’re operating on the edge, in the cloud, or across hybrid environments, GreptimeDB empowers real-time insights at massive scale — all in one system. +**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 | | --------- | ----------- | -| [Unified Observability Data](https://docs.greptime.com/user-guide/concepts/why-greptimedb) | Store metrics, logs, and traces as timestamped, contextual wide events. Query via [SQL](https://docs.greptime.com/user-guide/query-data/sql), [PromQL](https://docs.greptime.com/user-guide/query-data/promql), and [streaming](https://docs.greptime.com/user-guide/flow-computation/overview). | -| [High Performance & Cost Effective](https://docs.greptime.com/user-guide/manage-data/data-index) | Written in Rust, with a distributed query engine, [rich indexing](https://docs.greptime.com/user-guide/manage-data/data-index), and optimized columnar storage, delivering sub-second responses at PB scale. | -| [Cloud-Native Architecture](https://docs.greptime.com/user-guide/concepts/architecture) | Designed for [Kubernetes](https://docs.greptime.com/user-guide/deployments-administration/deploy-on-kubernetes/greptimedb-operator-management), with compute/storage separation, native object storage (AWS S3, Azure Blob, etc.) and seamless cross-cloud access. | -| [Developer-Friendly](https://docs.greptime.com/user-guide/protocols/overview) | Access via SQL/PromQL interfaces, REST API, MySQL/PostgreSQL protocols, and popular ingestion [protocols](https://docs.greptime.com/user-guide/protocols/overview). | -| [Flexible Deployment](https://docs.greptime.com/user-guide/deployments-administration/overview) | Deploy anywhere: edge (including ARM/[Android](https://docs.greptime.com/user-guide/deployments-administration/run-on-android)) or cloud, with unified APIs and efficient data sync. | +| [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). @@ -85,10 +92,10 @@ Learn more in [Why GreptimeDB](https://docs.greptime.com/user-guide/concepts/why | Feature | GreptimeDB | Traditional TSDB | Log Stores | |----------------------------------|-----------------------|--------------------|-----------------| | Data Types | Metrics, Logs, Traces | Metrics only | Logs only | -| Query Language | SQL, PromQL, Streaming| Custom/PromQL | Custom/DSL | +| 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, SQL, Common protocols | 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) @@ -98,8 +105,14 @@ Read [more benchmark reports](https://docs.greptime.com/user-guide/concepts/feat ## Architecture -* 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: +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: GreptimeDB System Overview ## Try GreptimeDB @@ -119,7 +132,8 @@ docker run -p 127.0.0.1:4000-4003:4000-4003 \ --postgres-addr 0.0.0.0:4003 ``` Dashboard: [http://localhost:4000/dashboard](http://localhost:4000/dashboard) -[Full Install Guide](https://docs.greptime.com/getting-started/installation/overview) + +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. @@ -148,21 +162,26 @@ 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) -- **SDKs/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), [JS](https://github.com/GreptimeTeam/greptimedb-ingester-js) -- **Grafana**: [Official Dashboard](https://github.com/GreptimeTeam/greptimedb/blob/main/grafana/README.md) +- **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. -> **GA (v1.0):** Targeted for mid 2025. +> **Status:** Beta — marching toward v1.0 GA! +> **GA (v1.0):** January 10, 2026 -- Being used in production by early adopters +- 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. [![Star History Chart](https://api.star-history.com/svg?repos=GreptimeTeam/GreptimeDB&type=Date)](https://www.star-history.com/#GreptimeTeam/GreptimeDB&Date) @@ -203,5 +222,5 @@ Special thanks to all contributors! See [AUTHORS.md](https://github.com/Greptime - Uses [Apache Arrow™](https://arrow.apache.org/) (memory model) - [Apache Parquet™](https://parquet.apache.org/) (file storage) -- [Apache Arrow DataFusion™](https://arrow.apache.org/datafusion/) (query engine) +- [Apache DataFusion™](https://arrow.apache.org/datafusion/) (query engine) - [Apache OpenDAL™](https://opendal.apache.org/) (data access abstraction)