Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/greptimeteam/greptimedb

An open-source, cloud-native, unified time series database for metrics, logs and events with SQL/PromQL supported. Available on GreptimeCloud.
https://github.com/greptimeteam/greptimedb

analytics cloud-native database distributed event events eventstore iot logging logs logstore metrics monitoring rust sql time-series timeseries tsdb

Last synced: 7 days ago
JSON representation

An open-source, cloud-native, unified time series database for metrics, logs and events with SQL/PromQL supported. Available on GreptimeCloud.

Awesome Lists containing this project

README 

        


  

    

    

    GreptimeDB Logo

  




Unified & Cost-Effective Time Series Database for Metrics, Logs, and Events







  GreptimeCloud |

  User Guide |

  API Docs |

  Roadmap 2024





Version





Releases





Docker Pulls





GitHub Actions





Codecov





License










Slack





Twitter





LinkedIn








- [Introduction](#introduction)

- [**Features: Why GreptimeDB**](#why-greptimedb)

- [Architecture](https://docs.greptime.com/contributor-guide/overview/#architecture)

- [Try it for free](#try-greptimedb)

- [Getting Started](#getting-started)

- [Project Status](#project-status)

- [Join the community](#community)

  - [Contributing](#contributing)

- [Tools & Extensions](#tools--extensions)

- [License](#license)

- [Acknowledgement](#acknowledgement)



## Introduction



**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.



## Why GreptimeDB



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](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/flow-computation/overview)) to enable continuous aggregation. [Read more](https://docs.greptime.com/user-guide/concepts/data-model).



* **Cloud-native Distributed Database**



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.



* **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](https://www.greptime.com/blogs/2024-09-09-report-summary).



* **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/).



* **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](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. [Live Demo](https://greptime.com/playground)



Try out the features of GreptimeDB right from your browser.



### 2. [GreptimeCloud](https://console.greptime.cloud/)



Start instantly with a free cluster.



### 3. Docker Image



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



```shell

docker pull greptime/greptimedb

```



Start a GreptimeDB container with:



```shell

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



* [Quickstart](https://docs.greptime.com/getting-started/quick-start)

* [User Guide](https://docs.greptime.com/user-guide/overview)

* [Demos](https://github.com/GreptimeTeam/demo-scene)

* [FAQ](https://docs.greptime.com/faq-and-others/faq)



## Build



Check the prerequisite:



* [Rust toolchain](https://www.rust-lang.org/tools/install) (nightly)

* [Protobuf compiler](https://grpc.io/docs/protoc-installation/) (>= 3.15)

* Python toolchain (optional): Required only if built with PyO3 backend. More detail for compiling with PyO3 can be found in its [documentation](https://pyo3.rs/v0.18.1/building_and_distribution#configuring-the-python-version).



Build GreptimeDB binary:



```shell

make

```



Run a standalone server:



```shell

cargo run -- standalone start

```



## Tools & Extensions



### Dashboard



- [The dashboard UI for GreptimeDB](https://github.com/GreptimeTeam/dashboard)



### SDK



- [GreptimeDB Go Ingester](https://github.com/GreptimeTeam/greptimedb-ingester-go)

- [GreptimeDB Java Ingester](https://github.com/GreptimeTeam/greptimedb-ingester-java)

- [GreptimeDB C++ Ingester](https://github.com/GreptimeTeam/greptimedb-ingester-cpp)

- [GreptimeDB Erlang Ingester](https://github.com/GreptimeTeam/greptimedb-ingester-erl)

- [GreptimeDB Rust Ingester](https://github.com/GreptimeTeam/greptimedb-ingester-rust)

- [GreptimeDB JavaScript Ingester](https://github.com/GreptimeTeam/greptimedb-ingester-js)



### Grafana Dashboard



Our official Grafana dashboard for monitoring GreptimeDB is available at [grafana](grafana/README.md) directory.



## Project Status



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



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



## Community



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](https://greptime.com/slack)

- GreptimeDB [GitHub Discussions forum](https://github.com/GreptimeTeam/greptimedb/discussions)

- Greptime official [website](https://greptime.com)



In addition, you may:



- View our official [Blog](https://greptime.com/blogs/)

- Connect us with [Linkedin](https://www.linkedin.com/company/greptime/)

- Follow us on [Twitter](https://twitter.com/greptime)



## Commercial Support



If you are running GreptimeDB OSS in your organization, we offer additional

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 commercial license.



## License



GreptimeDB uses the [Apache License 2.0](https://apache.org/licenses/LICENSE-2.0.txt) to strike a balance between

open contributions and allowing you to use the software however you want.



## Contributing



Please refer to [contribution guidelines](CONTRIBUTING.md) and [internal concepts docs](https://docs.greptime.com/contributor-guide/overview.html) for more information.



## Acknowledgement



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



- GreptimeDB uses [Apache Arrow™](https://arrow.apache.org/) as the memory model and [Apache Parquet™](https://parquet.apache.org/) as the persistent file format.

- GreptimeDB's query engine is powered by [Apache Arrow DataFusion™](https://arrow.apache.org/datafusion/).

- [Apache OpenDAL™](https://opendal.apache.org) gives GreptimeDB a very general and elegant data access abstraction layer.

- GreptimeDB's meta service is based on [etcd](https://etcd.io/).

- GreptimeDB uses [RustPython](https://github.com/RustPython/RustPython) for experimental embedded python scripting.