dennis zhuang 7677e5159e feat(promql): evaluate topk, bottomk, scalar, absent and instant sorts (#9680)
I hereby agree to the terms of the [GreptimeDB
CLA](https://github.com/GreptimeTeam/.github/blob/main/CLA.md).

## Refer to a related PR or issue link (optional)

Targets `narthex`. Stacked on #9673 for `GridSeriesBuilder` and the test
reference; review only `feat(promql): evaluate topk, bottomk, scalar,
absent and instant sorts over evaluated series`.

## What's changed and what's your intention?

### Problem

The native path has no operators that depend on the whole set of series
at each point: `topk`/`bottomk`, `scalar`, `absent` and the
instant-result sorts.

### Change

`select` module, following Prometheus (`aggregationK`, `funcScalar`,
`funcAbsent`, `createLabelsForAbsentFunction`, `funcSort*`):

- `topk(k, top, grouping, schema, series)`: at every point each
`by`/`without` group keeps the `k` largest (or smallest) values, NaN
ranking last for both. `k` is truncated and capped at the number of
input series; below 1 there is no result. Selected samples keep their
series' labels and values.
- `scalar(schema, series)`: the value of the only series present at each
point, Go's NaN otherwise; the result is a label-less series with a
value at every point. A scalar in this representation is already
`vector(scalar)`.
- `absent(schema, series, labels)`: 1 with `labels` at every point where
no series is present, in every field. `absent_over_time(m[r])` is
`absent` over the `present_over_time` kernel of #9674.
- `absent_labels(matchers)`: the result labels from the selector's
`LabelMatcher`s (`name`, `MatchOp`, `value`, `matches_empty`).
- `sort_instant(order, schema, series)`: `sort`, `sort_desc` (NaN last),
`sort_by_label` and `sort_by_label_desc` (Go `natsort` order, then the
label sets) for single-point results. Multi-point results are returned
unchanged, as Prometheus does not sort matrices.
- `go_sort::sort_by`: a port of Go's pdqsort (`sort.Sort` and
`slices.SortFunc`). The instant sorts use it with Prometheus'
comparators, so ties, ±0, several NaNs and `natsort`'s inconsistent
order come out in Go's order, and an inconsistent comparator cannot
panic.

`topk`, `scalar` and the value sorts take one field and reject others
with `NotImplemented`; histogram samples are rejected the same way.

Review focus:

- `topk`: NaN ranking and the `k` conversion.
- `absent_labels`: the matcher order (see Constraints).
- `natural_less` and `chunks` against `facette/natsort.Compare`.
- `topk`/`bottomk` return nothing for `k` below 1 and reject a NaN `k`
and one of 9223372036854774784 (Prometheus' `maxInt64`) or more with
Prometheus' errors.
- `absent` marks each field absent on its own.

### Non-goals

- Non-constant `k`, `limitk`, `count_values`, planner wiring.

### Constraints

- Ties in `topk`/`bottomk` go to the series whose label set sorts first.
Prometheus resolves them by the order its storage returns series in
(posting order), which is not a property of the series.
- `absent_labels` applies Prometheus' rule (the first equality matcher
of a name sets it, any other matcher of the name removes it) to the
matchers in the order Prometheus actually reads them: TSDB's
`PostingsForMatchers` stably moves narrowing matchers before subtracting
ones, in place, before `absent` builds its labels. Over an empty storage
Prometheus keeps the query order instead. The two orders differ only
when one name has both an equality and another matcher.

### Verification

- `cargo nextest run -p promql`: 315 passed.
- `cargo clippy -p promql --all-targets --all-features -- -D warnings`,
`cargo fmt --check`, `hawkeye check`: clean.
- `select_operators_match_prometheus`: 180 cases from the Prometheus
v3.15.0 engine built for amd64 (60 each of `topk`/`bottomk` with
`by`/`without` and several `k`, `scalar`, and `absent` with equality,
inequality and repeated matchers), over series with holes, special
values and NaN, sampled on the grid with a 1ms lookback. Result label
sets and value bits match. The fixture is `select/prometheus_cases.txt`.
- `matches_go_sort_on_comparators_that_are_not_total_orders`: 208 orders
produced by Go's `sort.Sort` and `slices.SortFunc`
(`go_sort_cases.txt`), with consistent, NaN-like, tie-heavy and
inconsistent comparators, up to 257 elements.
- `sort_instant` and `natural_less` checks for the cases the fixture
cannot carry (instant order, Go `natsort` behavior including digit runs
beyond `i64`).
- Mutation check: NaN ranked first, `topk`/`bottomk` swapped, `k`
rounded up, `__name__` kept by `without`, `scalar` with several series,
repeated matchers kept, query-order matchers, and `absent` ignoring
presence each fail a test.
- `topk_validates_k_like_prometheus` and
`absent_evaluates_fields_independently` fail without these changes.

## PR Checklist
Please convert it to a draft if some of the following conditions are not
met.

- [x] I have written the necessary rustdoc comments.
- [x] I have added the necessary unit tests and integration tests.
- [ ] This PR requires documentation updates.
- [x] API changes are backward compatible.
- [x] Schema or data changes are backward compatible.
- [ ] This PR needs to be backported to release branches, and I have
added the `backport-<target>` labels (e.g. `backport-v1.3` targets
`release/v1.3`).
2026-10-18 00:58:12 +08:00
2023-08-10 08:08:37 +00:00
2023-06-25 11:05:46 +08:00
2023-11-09 10:38:12 +00:00

GreptimeDB Logo

Metrics, logs, and traces.
One engine, on your infrastructure.

A columnar database for metrics, logs, and traces on object storage. Apache-2.0 licensed core.

User Guide  ·  API Docs  ·  Roadmap 2026  ·  Slack

Stable Canary Nightly Docker Pulls License

stable for production  ·  canary includes pre-releases  ·  nightly is a weekly snapshot of main

Introduction

GreptimeDB is an open-source observability database. Metrics, logs, and traces run on one columnar engine over object storage and share one table model: tags, timestamp, and fields. When signals carry common identifiers such as service, host, or trace ID, you can correlate them in SQL without moving data between databases.

Ingest through OpenTelemetry, Prometheus Remote Write, Loki Push, or Elasticsearch Bulk. Use SQL across observability data and PromQL for metrics. Migrate ingestion one signal at a time without rebuilding your collectors.

One Query Across Signals

OpenTelemetry ingestion writes spans to opentelemetry_traces and log records to opentelemetry_logs. Both tables carry trace_id, so correlating them is a join:

-- The slowest failed spans in the last hour,
-- with the log lines emitted inside those same traces.
SELECT
    t.service_name,
    t.span_name,
    t.duration_nano / 1000000 AS duration_ms,
    l.timestamp AS log_time,
    l.severity_text,
    l.body
FROM opentelemetry_traces t
JOIN opentelemetry_logs l ON l.trace_id = t.trace_id
WHERE t.timestamp > now() - INTERVAL '1' HOUR
  AND t.span_status_code = 'STATUS_CODE_ERROR'
ORDER BY t.duration_nano DESC
LIMIT 20;

Metrics join the same way, on any tag the tables share, such as service, host, or pod.

Why You Might Use It

  • You run Prometheus plus Loki or Elasticsearch and want one backend instead of three
  • You have outgrown Prometheus on cardinality or retention and don't want the Thanos/Mimir operational surface
  • You are hitting Loki's query performance limits as log volume grows
  • You need long retention on object storage without a separate analytics stack
  • You want to query telemetry with SQL, not only a domain query language
  • You are storing GenAI or agent telemetry (OTel GenAI conventions) alongside infrastructure signals

Learn more in Why GreptimeDB.

What's Supported

Ingest OpenTelemetry (OTLP), Prometheus Remote Write, Loki Push, Elasticsearch Bulk, InfluxDB line protocol, gRPC
Query SQL, PromQL, Jaeger-compatible trace queries, MySQL and PostgreSQL wire protocols
Storage S3, GCS, Azure Blob and S3-compatible endpoints as primary storage, with memory and local-disk caches
Built in Retention policies, downsampling, continuous aggregation, explicit table partitioning, and inverted / skipping / fulltext indexes

Compute and storage are disaggregated: object storage holds the data, while memory and local-disk caches keep recent and frequently queried data close to compute.

GreptimeDB Overview

Benchmarks

Compatibility and Migration

Compatibility is per protocol, and query-side coverage is narrower than ingestion.

Compatible Not compatible
Prometheus Remote Write ingestion; PromQL queries Gaps are listed in PromQL compatibility
Loki Push ingestion; dual-write through Grafana Alloy makes the cutover gradual LogQL and the rest of the Loki query API
Elasticsearch _bulk ingestion in the open-source core; QueryDSL partially, in Enterprise Most other Elasticsearch APIs

Limitations and Edition Boundary

Cluster deployment, object storage, the Flow engine, and every ingestion protocol listed above are in the Apache-2.0 build. Repartitioning, region migration, and index creation are manual operations there.

Read replicas, workload isolation, and automated repartitioning are GreptimeDB Enterprise features, along with enterprise security and governance. The Enterprise overview has the current list, and pricing has the edition comparison.

Architecture

GreptimeDB can run in two modes:

  • Standalone — single binary for development and small deployments.
  • Distributed — four components, each independently scalable:
    • Frontend — protocol entry (OTel, Prometheus, MySQL/PostgreSQL, gRPC, ingestion APIs for Elasticsearch/InfluxDB/Loki) and the distributed query engine. Stateless, scales horizontally.
    • Datanode — region engine with WAL, memtable, SST, cache, compaction, and indexes. Persists data to object storage. Elastic.
    • Metasrv — metadata, routing, repartitioning, and security. Backed by a pluggable KV layer (etcd or RDS).
    • Flownode (optional) — continuous flow computation (streaming and materialized views).

For deeper coverage, see the architecture doc or DeepWiki.

GreptimeDB System Overview

Try GreptimeDB

For AI agents — paste this prompt into your agent:

Read https://docs.greptime.com/SKILL.md and follow the instructions
to deploy, configure, ingest, and query GreptimeDB.
docker run -p 127.0.0.1:4000-4003:4000-4003 \
  -v "$(pwd)/greptimedb_data:/greptimedb_data" \
  --name greptime --rm \
  greptime/greptimedb:latest standalone start \
  --http-addr 0.0.0.0:4000 \
  --grpc-bind-addr 0.0.0.0:4001 \
  --mysql-addr 0.0.0.0:4002 \
  --postgres-addr 0.0.0.0:4003

Dashboard: http://localhost:4000/dashboard

Read more in the full Install Guide.

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.
  • Failed to start? Check the container logs with docker logs greptime for further details.

Getting Started

Build From Source

Prerequisites:

  • Rust toolchain — stable, pinned by rust-toolchain.toml
  • Protobuf compiler (>= 3.15)
  • C/C++ building essentials: gcc / g++ / autoconf and the glibc dev package (libc6-dev on Ubuntu, glibc-devel on Fedora)
  • Python toolchain (optional, only for some test scripts)

Build and run:

make                          # build greptime binary
cargo run -- standalone start # start in standalone mode

Common dev commands:

make fmt            # format Rust code
make clippy         # lint (fails on warnings)
make test           # unit + integration tests (uses cargo-nextest)
make sqlness-test   # SQL regression tests

See the Contribution Guidelines for the full developer workflow.

Tools & Extensions

Project Status

GreptimeDB is generally available, with stable APIs and regular releases. It runs in production at scale — OceanBase Cloud operates 80+ GreptimeDB clusters managing 300 TB of logs, cutting log storage cost by 60%+ after migrating from Grafana Loki. See more in case studies.

Release lines and support windows are in the version reference. For where the project is going, read the v1.0 highlights and the 2026 roadmap.

Community

We invite you to engage and contribute!

If GreptimeDB is useful to you, please star the repo.

Known Users

License

GreptimeDB is an open-core project. Its core is licensed under the Apache License 2.0.

A small set of peripheral, enterprise-only features are gated behind the enterprise Cargo feature (not built by default) and are governed by the separate GreptimeDB Enterprise License. Source files under that license carry an explicit Enterprise License header.

Commercial Support

Scaling observability on your infrastructure? GreptimeDB Enterprise adds the operational, security, and support layer for production deployments. Contact us for details.

Contributing

Integration CI Codecov

Acknowledgement

Special thanks to all contributors! See AUTHOR.md.


All trademarks, logos, and brand names referenced in this README and in the Overview diagram are the property of their respective owners. Their use is for identification purposes only and does not imply endorsement or affiliation.

S
Description
Open-source, cloud-native, unified observability database for metrics, logs and traces, supporting SQL/PromQL/Streaming.
Readme Apache-2.0
1.9 GiB
Languages
Rust 97.4%
Python 1.9%
Shell 0.4%
JavaScript 0.2%