Home

Awesome

<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">Unified Time Series Database for Metrics, Logs, and Events</h2> <div align="center"> <h3 align="center"> <a href="https://greptime.com/product/cloud">GreptimeCloud</a> | <a href="https://docs.greptime.com/">User Guide</a> | <a href="https://greptimedb.rs/">API Docs</a> | <a href="https://github.com/GreptimeTeam/greptimedb/issues/3412">Roadmap 2024</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

GreptimeDB is an open-source unified 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 is born to give you:

Try GreptimeDB

1. GreptimePlay

Try out the features of GreptimeDB right from your browser.

2. GreptimeCloud

Start instantly with a free cluster.

3. Docker Image

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

docker pull greptime/greptimedb

Start a GreptimeDB container with:

docker run --rm --name greptime --net=host greptime/greptimedb standalone start

Read more about Installation on docs.

Getting Started

Build

Check the prerequisite:

Build GreptimeDB binary:

make

Run a standalone server:

cargo run -- standalone start

Extension

Dashboard

SDK

Grafana Dashboard

Our official Grafana dashboard is available at grafana 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

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.

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:

In addition, you may:

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.

Contributing

Please refer to contribution guidelines and internal concepts docs 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.