README
¶
Grafana Mimir
Grafana Mimir is an open source software project that provides a scalable long-term storage for Prometheus. Some of the core strengths of Grafana Mimir include:
- Easy to install and maintain: Grafana Mimir’s extensive documentation, tutorials, and deployment tooling make it quick to get started. Using its monolithic mode, you can get Grafana Mimir up and running with just one binary and no additional dependencies. Once deployed, the best-practice dashboards, alerts, and runbooks packaged with Grafana Mimir make it easy to monitor the health of the system.
- Massive scalability: You can run Grafana Mimir's horizontally-scalable architecture across multiple machines, resulting in the ability to process orders of magnitude more time series than a single Prometheus instance. Internal testing shows that Grafana Mimir handles up to 1 billion active time series.
- Global view of metrics: Grafana Mimir enables you to run queries that aggregate series from multiple Prometheus instances, giving you a global view of your systems. Its query engine extensively parallelizes query execution, so that even the highest-cardinality queries complete with blazing speed.
- Cheap, durable metric storage: Grafana Mimir uses object storage for long-term data storage, allowing it to take advantage of this ubiquitous, cost-effective, high-durability technology. It is compatible with multiple object store implementations, including AWS S3, Google Cloud Storage, Azure Blob Storage, OpenStack Swift, as well as any S3-compatible object storage.
- High availability: Grafana Mimir replicates incoming metrics, ensuring that no data is lost in the event of machine failure. Its horizontally scalable architecture also means that it can be restarted, upgraded, or downgraded with zero downtime, which means no interruptions to metrics ingestion or querying.
- Natively multi-tenant: Grafana Mimir’s multi-tenant architecture enables you to isolate data and queries from independent teams or business units, making it possible for these groups to share the same cluster. Advanced limits and quality-of-service controls ensure that capacity is shared fairly among tenants.
Migrating to Grafana Mimir
If you're migrating to Grafana Mimir, refer to the following documents:
Deploying Grafana Mimir
For information about how to deploy Grafana Mimir, refer to Deploy Grafana Mimir.
Getting started
If you’re new to Grafana Mimir, read the Get started guide.
Before deploying Grafana Mimir in a production environment, read:
Documentation
Refer to the following links to access Grafana Mimir documentation:
- Latest release
- Upcoming release, at the tip of the
mainbranch
Contributing
To contribute to Grafana Mimir, refer to Contributing to Grafana Mimir.
Join the Grafana Mimir discussion
If you have any questions or feedback regarding Grafana Mimir, join the Grafana Mimir Discussion. Alternatively, consider joining the monthly Grafana Mimir Community Call.
Your feedback is always welcome, and you can also share it via the #mimir Slack channel.
License
Grafana Mimir is distributed under AGPL-3.0-only.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
operations
|
|
|
pkg
|
|
|
alertmanager
Mostly taken from http://github.com/grafana/grafana/main/pkg/services/notifications/webhook.go
|
Mostly taken from http://github.com/grafana/grafana/main/pkg/services/notifications/webhook.go |
|
mimirtool/commands
SPDX-License-Identifier: AGPL-3.0-only Provenance-includes-location: https://github.com/prometheus/alertmanager/blob/main/cli/template_render.go Provenance-includes-license: Apache-2.0 Provenance-includes-copyright: The Prometheus Authors.
|
SPDX-License-Identifier: AGPL-3.0-only Provenance-includes-location: https://github.com/prometheus/alertmanager/blob/main/cli/template_render.go Provenance-includes-license: Apache-2.0 Provenance-includes-copyright: The Prometheus Authors. |
|
mimirtool/minisdk
Package minisdk contains a minified version of the model found in github.com/grafana-tools/sdk.
|
Package minisdk contains a minified version of the model found in github.com/grafana-tools/sdk. |
|
storegateway/indexcache
SPDX-License-Identifier: AGPL-3.0-only Provenance-includes-location: https://github.com/thanos-io/thanos/blob/main/pkg/store/cache/inmemory.go Provenance-includes-license: Apache-2.0 Provenance-includes-copyright: The Thanos Authors.
|
SPDX-License-Identifier: AGPL-3.0-only Provenance-includes-location: https://github.com/thanos-io/thanos/blob/main/pkg/store/cache/inmemory.go Provenance-includes-license: Apache-2.0 Provenance-includes-copyright: The Thanos Authors. |
|
util/grpcencoding/s2
Package s2 is an experimental wrapper for using github.com/klauspost/compress/s2 stream compression with gRPC.
|
Package s2 is an experimental wrapper for using github.com/klauspost/compress/s2 stream compression with gRPC. |
|
util/gziphandler
Package gziphandler mirrors the package github.com/nytimes/gziphandler until https://github.com/nytimes/gziphandler/pull/112 is merged.
|
Package gziphandler mirrors the package github.com/nytimes/gziphandler until https://github.com/nytimes/gziphandler/pull/112 is merged. |
|
util/noauth
Package noauth provides middlewares that injects a tenant ID so the rest of the code can continue to be multitenant.
|
Package noauth provides middlewares that injects a tenant ID so the rest of the code can continue to be multitenant. |
|
tools
|
|
|
doc-validator
Module
|
Click to show internal directories.
Click to hide internal directories.