diff --git a/AUTHOR.md b/AUTHOR.md index a58bc48ad851..ff9165697b54 100644 --- a/AUTHOR.md +++ b/AUTHOR.md @@ -7,6 +7,8 @@ * [NiwakaDev](https://github.com/NiwakaDev) * [etolbakov](https://github.com/etolbakov) * [irenjj](https://github.com/irenjj) +* [tisonkun](https://github.com/tisonkun) +* [Lanqing Yang](https://github.com/lyang24) ## Team Members (in alphabetical order) @@ -30,7 +32,6 @@ * [shuiyisong](https://github.com/shuiyisong) * [sunchanglong](https://github.com/sunchanglong) * [sunng87](https://github.com/sunng87) -* [tisonkun](https://github.com/tisonkun) * [v0y4g3r](https://github.com/v0y4g3r) * [waynexia](https://github.com/waynexia) * [xtang](https://github.com/xtang) diff --git a/README.md b/README.md index 0fb008744223..c6910b21db9b 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ - [Project Status](#project-status) - [Join the community](#community) - [Contributing](#contributing) -- [Extension](#extension ) +- [Tools & Extensions](#tools--extensions) - [License](#license) - [Acknowledgement](#acknowledgement) @@ -66,31 +66,33 @@ ## Why GreptimeDB -Our core developers have been building time-series data platforms for years. Based on our best-practices, GreptimeDB is born to give you: +Our core developers have been building time-series data platforms for years. Based on our best practices, GreptimeDB was born to give you: -* **Unified all kinds of time series** +* **Unified Processing of Metrics, Logs, and Events** - GreptimeDB treats all time series as contextual events with timestamp, and thus unifies the processing of metrics, logs, and events. It supports analyzing metrics, logs, and events with SQL and PromQL, and doing streaming with continuous aggregation. +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](https://docs.greptime.com/user-guide/query-data/sql) or [PromQL](https://docs.greptime.com/user-guide/query-data/promql) and leverage stream processing ([Flow](https://docs.greptime.com/user-guide/continuous-aggregation/overview)) to enable continuous aggregation. [Read more](https://docs.greptime.com/user-guide/concepts/data-model). -* **Cloud-Edge collaboration** +* **Cloud-native Distributed Database** - GreptimeDB can be deployed on ARM architecture-compatible Android/Linux systems as well as cloud environments from various vendors. Both sides run the same software, providing identical APIs and control planes, so your application can run at the edge or on the cloud without modification, and data synchronization also becomes extremely easy and efficient. +Built for [Kubernetes](https://docs.greptime.com/user-guide/deployments/deploy-on-kubernetes/greptimedb-operator-management). GreptimeDB achieves seamless scalability with its [cloud-native architecture](https://docs.greptime.com/user-guide/concepts/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. -* **Cloud-native distributed database** +* **Performance and Cost-effective** - By leveraging object storage (S3 and others), separating compute and storage, scaling stateless compute nodes arbitrarily, GreptimeDB implements seamless scalability. It also supports cross-cloud deployment with a built-in unified data access layer over different object storages. +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](https://www.greptime.com/blogs/2024-09-09-report-summary). -* **Performance and Cost-effective** +* **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](https://docs.greptime.com/user-guide/deployments/run-on-android/). - Flexible indexing capabilities and distributed, parallel-processing query engine, tackling high cardinality issues down. Optimized columnar layout for handling time-series data; compacted, compressed, and stored on various storage backends, particularly cloud object storage with 50x cost efficiency. +* **Multi-protocol Ingestion, SQL & PromQL Ready** -* **Compatible with InfluxDB, Prometheus and more protocols** +Widely adopted database protocols and APIs, including MySQL, PostgreSQL, InfluxDB, OpenTelemetry, Loki and Prometheus, etc. Effortless Adoption & Seamless Migration. [Supported Protocols Overview](https://docs.greptime.com/user-guide/protocols/overview). - Widely adopted database protocols and APIs, including MySQL, PostgreSQL, and Prometheus Remote Storage, etc. [Read more](https://docs.greptime.com/user-guide/protocols/overview). +For more detailed info please read [Why GreptimeDB](https://docs.greptime.com/user-guide/concepts/why-greptimedb). ## Try GreptimeDB -### 1. [GreptimePlay](https://greptime.com/playground) +### 1. [Live Demo](https://greptime.com/playground) Try out the features of GreptimeDB right from your browser. @@ -109,9 +111,18 @@ docker pull greptime/greptimedb Start a GreptimeDB container with: ```shell -docker run --rm --name greptime --net=host greptime/greptimedb standalone start +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](https://docs.greptime.com/getting-started/installation/overview) on docs. ## Getting Started @@ -141,7 +152,7 @@ Run a standalone server: cargo run -- standalone start ``` -## Extension +## Tools & Extensions ### Dashboard @@ -158,14 +169,19 @@ cargo run -- standalone start ### Grafana Dashboard -Our official Grafana dashboard is available at [grafana](grafana/README.md) directory. +Our official Grafana dashboard for monitoring GreptimeDB is available at [grafana](grafana/README.md) directory. ## Project Status -The current version has not yet reached the standards for General Availability. -According to our Greptime 2024 Roadmap, we aim to achieve a production-level version with the release of v1.0 by the end of 2024. [Join Us](https://github.com/GreptimeTeam/greptimedb/issues/3412) +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](https://docs.greptime.com/nightly/reference/about-greptimedb-version) +* Suitable for testing and evaluation -We welcome you to test and use GreptimeDB. Some users have already adopted it in their production environments. If you're interested in trying it out, please use the latest stable release available. +For production use, we recommend using the latest stable release. ## Community @@ -184,12 +200,12 @@ In addition, you may: - Connect us with [Linkedin](https://www.linkedin.com/company/greptime/) - Follow us on [Twitter](https://twitter.com/greptime) -## Commerial Support +## Commercial Support If you are running GreptimeDB OSS in your organization, we offer additional -enterprise addons, installation service, training and consulting. [Contact +enterprise add-ons, installation services, training, and consulting. [Contact us](https://greptime.com/contactus) and we will reach out to you with more -detail of our commerial license. +detail of our commercial license. ## License