diff --git a/README.md b/README.md index 46bcefff59a..ec9964e7f5f 100644 --- a/README.md +++ b/README.md @@ -2,32 +2,52 @@

Grafana Mimir logo

-Grafana Mimir provides horizontally scalable, highly available, multi-tenant, long-term storage for [Prometheus](https://prometheus.io). +Grafana Mimir is an open source software project that provides a scalable long-term storage for [Prometheus](https://prometheus.io). Some of the core strengths of Grafana Mimir include: -- **Horizontally scalable:** Grafana Mimir can run across multiple machines in a cluster, exceeding the throughput and storage of a single machine. This enables you to send the metrics from multiple Prometheus servers to a single Mimir cluster and run "globally aggregated" queries across all data in a single place. -- **Highly available:** When run in a cluster, Grafana Mimir can replicate data between machines. This allows you to survive machine failure without gaps in your graphs. -- **Multi-tenant:** Grafana Mimir can isolate data and queries from multiple different independent - Prometheus sources in a single cluster, allowing untrusted parties to share the same cluster. -- **Long term storage:** Grafana Mimir supports S3, GCS, Swift and Microsoft Azure for long term storage of metric data. This allows you to durably store data for longer than the lifetime of any single machine, and use this data for long term capacity planning. +- **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. -## Documentation +## Migrating to Grafana Mimir + +If you're migrating to Grafana Mimir, refer to the following documents: + +- [Migrating from Thanos or Prometheus to Grafana Mimir](https://grafana.com/docs/mimir/latest/migration-guide/migrating-from-thanos-or-prometheus/). +- [Migrating from Cortex to Grafana Mimir](https://grafana.com/docs/mimir/latest/migration-guide/migrating-from-cortex/) + +## Deploying Grafana Mimir + +For information about how to deploy Grafana Mimir, refer to [Deploying Grafana Mimir](https://grafana.com/docs/mimir/latest/operators-guide/deploying-grafana-mimir/). + +## Getting started -If you’re new to Grafana Mimir, read the [Getting started guide](docs/sources/getting-started/_index.md). +If you’re new to Grafana Mimir, read the [Getting started guide](https://grafana.com/docs/mimir/latest/operators-guide/getting-started/). -Before deploying Grafana Mimir with a permanent storage backend, read: +Before deploying Grafana Mimir in a production environment, read: -1. [An overview of Grafana Mimir’s architecture](docs/sources/architecture.md) -1. [Getting started with Grafana Mimir](docs/sources/getting-started/_index.md) -1. [Configuring Grafana Mimir](docs/sources/configuration/_index.md) +1. [An overview of Grafana Mimir’s architecture](https://grafana.com/docs/mimir/latest/operators-guide/architecture/) +1. [Configuring Grafana Mimir](https://grafana.com/docs/mimir/latest/operators-guide/configuring/) +1. [Running Grafana Mimir in production](https://grafana.com/docs/mimir/latest/operators-guide/running-production-environment/) + +## Documentation + +Refer to the following links to access Grafana Mimir documentation: + +- [Latest release](https://grafana.com/docs/mimir/latest/) +- [Upcoming release](https://grafana.com/docs/mimir/next/), at the tip of the main branch ## Contributing -To contribute to Grafana Mimir, see [Contributing to Grafana Mimir](./CONTRIBUTING.md). +To contribute to Grafana Mimir, refer to [Contributing to Grafana Mimir](https://github.com/grafana/mimir/tree/main/docs/internal/contributing). + +## Join the Grafana Mimir discussion -## Hosted Grafana Mimir (Prometheus as a service) +If you have any questions or feedback regarding Grafana Mimir, join the [Grafana Mimir Discussion](https://github.com/grafana/mimir/discussions). -Grafana Mimir is used in [Grafana Cloud](https://grafana.com/cloud), and is primarily used as a [remote write](https://prometheus.io/docs/operating/configuration/#remote_write) destination for Prometheus via a Prometheus-compatible query API. +Your feedback is always welcome. -### Grafana Cloud +## License -As the creators of [Grafana](https://grafana.com/oss/grafana/), [Loki](https://grafana.com/oss/loki/), and [Tempo](https://grafana.com/oss/tempo/), Grafana Labs offers you the most comprehensive Observability-as-a-Service stack available. +Grafana Mimir is distributed under [AGPL-3.0-only](LICENSE).