Skip to content
This repository has been archived by the owner on Mar 13, 2024. It is now read-only.

openmeterio/benthos-openmeter

Repository files navigation

Benthos plugins for OpenMeter

GitHub Workflow Status go.dev reference Go Version OpenSSF Scorecard built with nix

A set of plugins and a custom distribution for Benthos to ingest events into OpenMeter.

Introduction

Benthos is a stream processor that allows you to consume, buffer, transform, combine, and produce streams of data. As such, it is a perfect fit for ingesting events into OpenMeter.

This project serves several purposes:

  • It provides a set of plugins for Benthos that allow you to ingest events into OpenMeter.
  • It is also a custom Benthos distribution with the OpenMeter plugins pre-installed.

You can use the plugins in your own Benthos distribution or use the custom distribution as a drop-in replacement for Benthos provided by this project.

Examples

See the examples directory for examples of how to use the plugins.

Development

For an optimal developer experience, it is recommended to install Nix and direnv.

Optional: Create a .env.local file with the following contents:

OPENMETER_URL=https://your.openmeter.cloud
OPENMETER_TOKEN=YOUR_TOKEN

Run Benthos:

go run .

License

The project is licensed under the Apache 2.0 License.