Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openmeterio/openmeter
Cloud Metering for AI, Billing and FinOps. Collect and aggregate millions of usage events in real-time.
https://github.com/openmeterio/openmeter
billing clickhouse cost finops golang kafka metering pricing stripe usage usage-based-billing usage-based-pricing
Last synced: about 1 month ago
JSON representation
Cloud Metering for AI, Billing and FinOps. Collect and aggregate millions of usage events in real-time.
- Host: GitHub
- URL: https://github.com/openmeterio/openmeter
- Owner: openmeterio
- License: apache-2.0
- Created: 2023-06-06T21:50:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T13:23:30.000Z (about 1 month ago)
- Last Synced: 2024-10-29T13:26:45.059Z (about 1 month ago)
- Topics: billing, clickhouse, cost, finops, golang, kafka, metering, pricing, stripe, usage, usage-based-billing, usage-based-pricing
- Language: Go
- Homepage: https://openmeter.io
- Size: 16.1 MB
- Stars: 1,105
- Watchers: 10
- Forks: 68
- Open Issues: 64
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-clickhouse - openmeterio/openmeter - OpenMeter provides a cloud metering solution for AI and billing, facilitating real-time collection and aggregation of usage data. (Integrations / Data Transfer and Synchronization)
README
OpenMeter
[](https://github.com/openmeterio/openmeter/releases/latest)
[](https://github.com/openmeterio/openmeter/actions/workflows/ci.yaml)
[](https://api.securityscorecards.dev/projects/github.com/openmeterio/openmeter)
[](https://goreportcard.com/report/github.com/openmeterio/openmeter)
OpenMeter is a Real-Time and Scalable Usage Metering for AI, Usage-Based Billing, Infrastructure, and IoT use-cases.
Learn more about OpenMeter at [https://openmeter.io](https://openmeter.io).
## Try It
Get started with the latest version of OpenMeter in minutes.
### Local
```sh
git clone [email protected]:openmeterio/openmeter.git
cd openmeter/quickstart
docker compose up -d
```
Check out the [quickstart guide](/quickstart) for a 5-minute overview and demo of OpenMeter.
### Cloud
[Sign up](https://openmeter.cloud) for a free account and start metering your usage in the cloud.
> [!TIP]
> Check out how OpenMeter Cloud compares with the self-hosted version in our [comparison guide](https://openmeter.io/docs/cloud#comparison).
### Deploy
Deploy OpenMeter to your Kubernetes cluster using our [Helm chart](https://openmeter.io/docs/manage/deploy/kubernetes).
## Links
- [Examples](/examples)
- [Demo Video](https://www.loom.com/share/c965e56f1df9450492e687dfb3c18b49)
- [Stripe UBP Demo](https://www.loom.com/share/bc1cfa1b7ed94e65bd3a82f9f0334d04)
- [Decisions](/docs/decisions)
## Community
To engage with our community, you can use the following resources:
- [Discord](https://discord.gg/nYH3ZQ3Xzq) - Get support or discuss the project.
- [Contributing to OpenMeter](CONTRIBUTING.md) - Start here if you want to contribute.
- [Code of Conduct](CODE_OF_CONDUCT.md) - Our community guidelines.
- [Adopters](ADOPTERS.md) - Companies already using OpenMeter.
- [Blog](https://openmeter.io/blog/) - Stay up-to-date.
## Examples
See our examples to learn about common OpenMeter use-cases.
- [Metering Kubernetes Pod Execution Time](/examples/collectors/kubernetes-pod-exec-time)
- Usage Based Billing with Stripe ([Go](https://github.com/openmeterio/examples/tree/main/export-stripe-go), [Node](https://github.com/openmeterio/examples/tree/main/export-stripe-node))
- [Metering based on logs](/examples/ingest-logs)
## API
OpenMeter exposes a [REST API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/openmeterio/openmeter/main/api/openapi.yaml) for integrations.
## Client SDKs
Currently, we offer the following Client SDKs:
- [Node.js](/api/client/node)
- [Python](/api/client/python)
- [Go](/api/client/go)
- [Web](/api/client/web)
In cases where no specific SDK is available for your preferred programming language, you can utilize the [OpenAPI definition](https://github.com/openmeterio/openmeter/blob/main/api/openapi.yaml).
Please raise a [GitHub issue](https://github.com/openmeterio/openmeter/issues/new?assignees=&labels=area%2Fapi%2Ckind%2Ffeature&projects=&template=feature_request.yaml) to request SDK support in other languages.
## Development
**For an optimal developer experience, it is recommended to install [Nix](https://nixos.org/download.html) and [direnv](https://direnv.net/docs/installation.html).**
Installing Nix and direnv
**Note: These are instructions that _SHOULD_ work in most cases. Consult the links above for the official instructions for your OS.**
Install Nix:
```sh
sh <(curl -L https://nixos.org/nix/install) --daemon
```
Consult the [installation instructions](https://direnv.net/docs/installation.html) to install direnv using your package manager.
On MacOS:
```sh
brew install direnv
```
Install from binary builds:
```sh
curl -sfL https://direnv.net/install.sh | bash
```
The last step is to configure your shell to use direnv. For example for bash, add the following lines at the end of your `~/.bashrc`:
eval "\$(direnv hook bash)"
**Then restart the shell.**
For other shells, see [https://direnv.net/docs/hook.html](https://direnv.net/docs/hook.html).
**MacOS specific instructions**
Nix may stop working after a MacOS upgrade. If it does, follow [these instructions](https://github.com/NixOS/nix/issues/3616#issuecomment-662858874).
Run the dependencies:
```sh
make up
```
Run OpenMeter:
```sh
make run
```
Run tests:
```sh
make test
```
Run linters:
```sh
make lint
```
### Tools
Run Docker Compose with dev profile to enable UI for Kafka and ClickHouse:
```sh
docker compose --profile dev up
```
If you are seeing ghcr.io denied error, login to ghcr.io using a GitHub personal access token:
```sh
docker login ghcr.io
```
## Roadmap
Visit our website at [https://openmeter.io](https://openmeter.io#roadmap) for our public roadmap.
## License
The project is licensed under the [Apache 2.0 License](LICENSE).
[](https://app.fossa.com/projects/custom%2B38090%2Fgithub.com%2Fopenmeterio%2Fopenmeter?ref=badge_large)