Skip to main content
Version: 0.14

User Guide

Welcome to the user guide for GreptimeDB.

GreptimeDB is the unified observability database for metrics, logs, and traces, providing real-time insights from Edge to Cloud at any scale.

Understanding GreptimeDB Concepts​

Before diving into GreptimeDB, it is recommended to familiarize yourself with its data model, key concepts, and features. For a comprehensive overview, refer to the Concepts Documentation.

Ingesting Data Based on Your Use Case​

GreptimeDB supports multiple protocols and various integration tools to simplify data ingestion tailored to your requirements.

For Observability Scenarios​

If you plan to use GreptimeDB as metrics, logs and traces storage for observability purposes, see the Observability Documentation. It explains how to ingest data using tools like Otel-Collector, Vector, Kafka, Prometheus, and the InfluxDB line protocol.

For a log storage solution, refer to the Logs Documentation. It details how to ingest pattern text logs using pipelines.

For a trace storage solution, refer to the Traces Documentation. It explains how to ingest trace data using OpenTelemetry and query it with Jaeger.

For IoT and Edge Computing Scenarios​

For IoT and Edge Computing scenarios, the IoT Documentation provides comprehensive guidance on ingesting data from diverse sources.

Querying Data for Insights​

GreptimeDB offers robust interfaces for querying data.

SQL Support​

You can use SQL for range queries, aggregations, and more. For detailed instructions, see the SQL Query Documentation.

Prometheus Query Language (PromQL)​

GreptimeDB supports PromQL for querying data. Refer to the PromQL Documentation for guidance.

Flow Computation​

For real-time data processing and analysis, GreptimeDB provides Flow Computation, enabling complex computations on data streams.

Accelerating Queries with Indexes​

Indexes such as inverted indexes, skipping indexes, and full-text indexes can significantly enhance query performance. Learn more about effectively using these indexes in the Data Index Documentation.

Migrating to GreptimeDB from Other Databases​

Migrating data from other databases to GreptimeDB is straightforward. Follow the step-by-step instructions in the Migration Documentation.

Administering and Deploying GreptimeDB​

When you're ready to deploy GreptimeDB, consult the Deployment Documentation and the Administration Documentation for detailed guidance on deployment and management.