Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preparing release notes for 2.12 #7572

Merged
merged 12 commits into from
Mar 12, 2024
Merged

Preparing release notes for 2.12 #7572

merged 12 commits into from
Mar 12, 2024

Conversation

duricanikolic
Copy link
Contributor

What this PR does

This PR prepares release notes for Mimir 2.12.

Which issue(s) this PR fixes or relates to

Part of #7542

Checklist

  • Tests updated.
  • Documentation added.
  • CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX].
  • about-versioning.md updated with experimental features.

@duricanikolic duricanikolic self-assigned this Mar 10, 2024
@duricanikolic duricanikolic requested review from jdbaldry and a team as code owners March 10, 2024 14:51
@pstibrany
Copy link
Member

pstibrany commented Mar 11, 2024

Let's also include a section about releasing new distroless image, and how it will become the default image soon. Please coordinate with @ying-jeanne and @jhesketh on details.

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
Co-authored-by: Ying WANG <74549700+ying-jeanne@users.noreply.github.com>
Comment on lines 21 to 23
- **The total number of OTLP requests** is tracked by the new `cortex_distributor_otlp_requests_total` metric.
- **The total number of queries executed for a particular source (ingester vs. store-gateway)** is tracked by the new `cortex_querier_queries_storage_type_total` metric.
- **The total number of chunks fetched from a store gateway** is tracked by the new `cortex_querier_query_storegateway_chunks_total` metric.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interested readers can read all about these metrics in the changelog. Are these note-worthy in the release notes?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pstibrany do you think we should just mention which metrics have been added without describing them, or do you think we should completely remove these entries?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems to me that new metrics like this are too small and not noteworthy-enough to be in the release notes. But ultimately, it's our PM's decision what to include in the release notes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zhehao-grafana WDYT about this? Should we mention all these metrics, or should we just leave them in CHANGELOG.md?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will vote to keep them in the changlog

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have removed these 2 entries from the release notes. Thank you.


- **The maximum number of tenant IDs that may be for a federated query** can be configured via the `-tenant-federation.max-tenants` CLI flag on query-frontends. By default, it is 0, meaning that the limit is disabled.
- **Sharding of active series queries can be enabled** via the `-query-frontend.shard-active-series-queries` CLI flag on query-frontends.
- **Timely head compaction** can be enabled via the `-blocks-storage.tsdb.timely-head-compaction-enabled` on ingesters. If enabled, the head compaction happens when the min block range can no longer be appended, without requiring 1.5x the chunk range worth of data in the head.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jhalterman is it safe to mention this in release notes?

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
docs/sources/mimir/release-notes/v2.12.md Outdated Show resolved Hide resolved
docs/sources/mimir/release-notes/v2.12.md Outdated Show resolved Hide resolved
docs/sources/mimir/release-notes/v2.12.md Outdated Show resolved Hide resolved
docs/sources/mimir/release-notes/v2.12.md Show resolved Hide resolved
docs/sources/mimir/release-notes/v2.12.md Outdated Show resolved Hide resolved
docs/sources/mimir/release-notes/v2.12.md Outdated Show resolved Hide resolved
docs/sources/mimir/release-notes/v2.12.md Outdated Show resolved Hide resolved
Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've submitted a review in the form of a PR: #7590

duricanikolic and others added 2 commits March 11, 2024 18:59
Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
* Lint for style guidance

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fixing lint errors

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
Co-authored-by: Đurica Yuri Nikolić <durica.nikolic@grafana.com>
@duricanikolic
Copy link
Contributor Author

I've submitted a review in the form of a PR: #7590

I have merged @jdbaldry's recommendations.

- `-query-frontend.additional-query-queue-dimensions-enabled` on the query-frontend.
- `-query-scheduler.additional-query-queue-dimensions-enabled` on the query-scheduler.

- **Owned series tracking in ingesters** can be enabled via the `-ingester.track-ingester-owned-series` CLI flag.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@duricanikolic added owned series tracking experimental feature here

cc @pstibrany @jdbaldry


## Features and enhancements

- **Added `mimir-distroless` container image, built upon the `distroless` image**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"the distroless image" isn't quite right as there are a number.

Built upon "a" distroless image perhaps. The specific one at the moment is gcr.io/distroless/static-debian12

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @jhesketh.
I have updated the PR. Does this look better?

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, new changes look good to me, thanks for incorporating my suggestions :)

Copy link
Contributor

@colega colega left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for incorporating my suggestions.

@duricanikolic duricanikolic merged commit 6794cb4 into main Mar 12, 2024
29 checks passed
@duricanikolic duricanikolic deleted the yuri/release-notes-2.12 branch March 12, 2024 11:40
grafanabot pushed a commit that referenced this pull request Mar 12, 2024
* Preparing release notes for 2.12

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Adding mimir-distroless docker image entry

Co-authored-by: Ying WANG <74549700+ying-jeanne@users.noreply.github.com>

* Fixing review findings

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Improve 2.11- to 2.12+ migration description

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Fixing review findings

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Adding missing entries

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Lint release notes to better match the Grafana Labs style guides (#7590)

* Lint for style guidance

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fixing lint errors

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
Co-authored-by: Đurica Yuri Nikolić <durica.nikolic@grafana.com>

* Add owned series tracking to experimental features

* Fix relref link

* Add distroless image name

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Remove unnecessary entries

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Fixing review findings

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

---------

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Ying WANG <74549700+ying-jeanne@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Patryk Prus <patryk.prus@grafana.com>
(cherry picked from commit 6794cb4)
duricanikolic added a commit that referenced this pull request Mar 12, 2024
* Preparing release notes for 2.12

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Adding mimir-distroless docker image entry

Co-authored-by: Ying WANG <74549700+ying-jeanne@users.noreply.github.com>

* Fixing review findings

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Improve 2.11- to 2.12+ migration description

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Fixing review findings

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Adding missing entries

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Lint release notes to better match the Grafana Labs style guides (#7590)

* Lint for style guidance

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fixing lint errors

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
Co-authored-by: Đurica Yuri Nikolić <durica.nikolic@grafana.com>

* Add owned series tracking to experimental features

* Fix relref link

* Add distroless image name

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Remove unnecessary entries

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

* Fixing review findings

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>

---------

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Ying WANG <74549700+ying-jeanne@users.noreply.github.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Patryk Prus <patryk.prus@grafana.com>
(cherry picked from commit 6794cb4)

Co-authored-by: Đurica Yuri Nikolić <durica.nikolic@grafana.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants