Skip to content

Commit

Permalink
Merge pull request #1515 from grafana/prepare-2.0.0-rc.4
Browse files Browse the repository at this point in the history
Prepare 2.0.0-rc.4
  • Loading branch information
pracucci committed Mar 21, 2022
2 parents cc59645 + 468e681 commit bfe2a45
Show file tree
Hide file tree
Showing 229 changed files with 45,632 additions and 1,330 deletions.
2 changes: 0 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@

#### Which issue(s) this PR fixes or relates to

<!-- Please make sure you don't reference cortex issues here, as the references can be publicly seen under certain conditions -->

Fixes #<issue number>

#### Checklist
Expand Down
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

### Mimirtool

## 2.0.0-rc.3
## 2.0.0-rc.4

### Grafana Mimir

Expand Down Expand Up @@ -596,6 +596,7 @@ _Changes since Cortex 1.10.0._
* [BUGFIX] Ring: multi KV runtime config changes are now propagated to all rings, not just ingester ring. #1047
* [BUGFIX] Memberlist: fixed corrupted packets when sending compound messages with more than 255 messages or messages bigger than 64KB. #551
* [BUGFIX] Overrides exporter: successfully startup even if runtime config is not set. #1056
* [BUGFIX] Fix internal modules to wait for other modules depending on them before stopping. #1472

### Mixin

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Contributing to Grafana Mimir

See [https://github.com/grafana/mimir/tree/main/docs/sources/contributing](https://github.com/grafana/mimir/tree/main/docs/sources/contributing).
For contribution guidelines, refer to [https://github.com/grafana/mimir/tree/main/docs/internal/contributing](https://github.com/grafana/mimir/tree/main/docs/internal/contributing).
8 changes: 4 additions & 4 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,10 @@ The ex-member is

If needed, we reserve the right to publicly announce removal.

[announce]: https://groups.google.com/forum/#!forum/mimir-announce
[announce]: https://github.com/grafana/mimir/discussions/categories/announcements
[coc]: https://github.com/grafana/mimir/blob/master/CODE_OF_CONDUCT.md
[devs]: https://groups.google.com/forum/#!forum/mimir-developers
[devs]: https://github.com/grafana/mimir/discussions/categories/development
[maintainers]: https://github.com/grafana/mimir/blob/master/MAINTAINERS.md
[rough]: https://tools.ietf.org/html/rfc7282
[team]: https://groups.google.com/forum/#!forum/mimir-team
[users]: https://groups.google.com/forum/#!forum/mimir-users
[team]: https://groups.google.com/g/mimir-team
[users]: https://github.com/grafana/mimir/discussions
12 changes: 6 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ MIXIN_OUT_PATH := operations/mimir-mixin-compiled
JSONNET_MANIFESTS_PATH := operations/mimir

# Doc templates in use
DOC_TEMPLATES := docs/sources/configuring/reference-configuration-parameters.template
DOC_TEMPLATES := docs/sources/operators-guide/configuring/reference-configuration-parameters.template

# Documents to run through embedding
DOC_EMBED := docs/sources/architecture/components/query-frontend/using-the-query-frontend-with-prometheus.md \
docs/sources/operating/mirroring-requests-to-a-second-cluster.md \
docs/sources/architecture/components/overrides-exporter.md \
docs/sources/getting-started/_index.md \
DOC_EMBED := docs/sources/operators-guide/configuring/configuring-the-query-frontend-work-with-prometheus.md \
docs/sources/operators-guide/configuring/mirroring-requests-to-a-second-cluster.md \
docs/sources/operators-guide/architecture/components/overrides-exporter.md \
docs/sources/operators-guide/getting-started/_index.md \
operations/mimir/README.md

.PHONY: image-tag
Expand Down Expand Up @@ -468,7 +468,7 @@ mixin-serve: ## Runs Grafana (listening on port 3000) loading the mixin dashboar
@./operations/mimir-mixin-tools/serve/run.sh

mixin-screenshots: ## Generates mixin dashboards screenshots.
@rm -f docs/sources/images/dashboards/*.png
@find docs/sources/operators-guide/visualizing-metrics/dashboards -name '*.png' -delete
@./operations/mimir-mixin-tools/screenshots/run.sh

check-jsonnet-manifests: format-jsonnet-manifests
Expand Down
55 changes: 38 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,53 @@

<p align="center"><img src="images/logo.png" alt="Grafana Mimir logo"></p>

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.
- **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 playbooks 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.

## 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).
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.0.0-rc.3
2.0.0-rc.4
45 changes: 22 additions & 23 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,30 @@
---
title: "Grafana Mimir technical documentation"
title: "Grafana Mimir"
menuTitle: "Grafana Mimir"
weight: 1
keywords:
- Grafana Mimir
- Grafana metrics
- time series database
- TSDB
- Prometheus storage
- Prometheus remote write
- metrics storage
- metrics datastore
- observability
---

Grafana Mimir provides horizontally scalable, highly available, multi-tenant, long-term storage for [Prometheus](https://prometheus.io).
# Grafana Mimir Documentation

- **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 Grafana Mimir cluster and run globally aggregated queries across all data in a single place.
- **Highly available:** When run in a cluster, Grafana Mimir replicates data between machines.
This makes Grafana Mimir resilient to machine failure, which ensures that there is no data missing in your graphs.
- **Multi-tenant:** Grafana Mimir can isolate data and queries from multiple 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 enables you to durably store data for longer than the lifetime of a single machine, and use this data for long-term capacity planning.
![Grafana Mimir](./images/mimir-logo.png)

## Documentation
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:

If you’re new to Grafana Mimir, read [Getting started with Grafana Mimir]({{< relref "./getting-started/_index.md" >}}).
- **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 playbooks 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.

Before deploying Grafana Mimir, read:

1. [Grafana Mimir architecture]({{< relref "architecture.md" >}})
1. [Getting started with Grafana Mimir]({{< relref "getting-started/_index.md" >}})
1. [Configuring Grafana Mimir]({{< relref "configuring/_index.md" >}})

## Hosted Grafana Mimir (Prometheus as a service)

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.

### Grafana Cloud

As the creators of [Grafana](https://grafana.com/oss/grafana/), [Grafana Loki](https://grafana.com/oss/loki/), and [Grafana Tempo](https://grafana.com/oss/tempo/), Grafana Labs can offer you the most holistic Observability-as-a-Service stack out there.
> **Note:** You can use [Grafana Cloud](https://grafana.com/products/cloud/features/#cloud-metrics) to avoid installing, maintaining, and scaling your own instance of Grafana Mimir. The free forever plan includes 10,000 metrics. [Create an account to get started](https://grafana.com/auth/sign-up/create-user?pg=docs-mimir&plcmt=in-text).
14 changes: 0 additions & 14 deletions docs/sources/architecture/blocks-storage/_index.md

This file was deleted.

0 comments on commit bfe2a45

Please sign in to comment.