collector

module
v0.0.0-...-12ab7b0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 10, 2026 License: Apache-2.0

README

OpenMeter Collector

OpenMeter Collector is a configurable, production-ready data pipeline for usage metering. It helps you collect, transform, buffer, and reliably deliver usage events into OpenMeter, especially in distributed and network-unreliable environments.

Learn more in the docs:


Capabilities


Architecture

+-------------------+   +-------------------+   +-------------------+
|  App / SDK Events  |   |  Infra Signals     |   |  Data Stores       |
|  (HTTP, webhooks)  |   |  (K8s/Prom/OTEL)   |   |  (PG/CH/S3/...)    |
+---------+---------+   +---------+---------+   +---------+---------+
          \                   |                     /
           \                  |                    /
            \                 |                   /
             v                v                  v
        +------------------------------------------------+
        |                OpenMeter Collector              |
        |------------------------------------------------|
        |  Ingest -> Validate/Transform -> Batch/Retry    |
        |                 |                               |
        |                 v                               |
        |        Disk Buffer (durable replay)             |
        +-----------------+------------------------------+
                          |
                          v
              +------------------------------+
              |          OpenMeter           |
              |   metering • usage • billing |
              +------------------------------+

See detailed architecture and concepts: https://openmeter.io/docs/collectors/how-it-works


Getting Started

1. Choose a deployment model
2. Install the Collector

Follow the official quickstart for step-by-step installation and configuration examples: https://openmeter.io/docs/collectors/quickstart

3. Send usage events

Configure your SDKs or usage producers to send events to the Collector endpoint.

4. Run in production

Repository

Collector source code lives in the main OpenMeter repository: https://github.com/openmeterio/openmeter/tree/main/collector

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL