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

Expose ingest storage config doc and changelog #8503

Merged
merged 6 commits into from
Jun 25, 2024

Conversation

pracucci
Copy link
Collaborator

What this PR does

The Kafka-based ingest storage is still experimental, but we're moving closer to start running it in few production clusters at Grafana Labs. I think it's the right time to include it in the auto-generated config and, from now on, to mention changes to the CHANGELOG.

I've added the CHANGELOG entry under main / unreleased branch, even if it's not technically correct, because all changes are included in v2.13.0-rc.0. I'm open to feedback on how to handle it. The reason why I've written it under main / unreleased is because we haven't publicly mentioned it yet, but will be mentioned as experimental feature in the next release (so 2.14).

Which issue(s) this PR fixes or relates to

N/A

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.

@pracucci pracucci requested review from tacole02 and a team as code owners June 24, 2024 17:06
@pracucci pracucci force-pushed the expose-ingest-storage-config-doc-and-changelog branch from d7fd803 to 1efcf6f Compare June 25, 2024 06:59
Copy link
Member

@pstibrany pstibrany left a comment

Choose a reason for hiding this comment

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

I'm fine adding it to unreleased section, since all the options are still hidden in 2.13.

I'd suggest documenting the following mixin config options:

  • ingest_storage_enabled -- enables alerts for ingest-storage
  • show_ingest_storage_panels -- shows ingest-storage panels

@pracucci
Copy link
Collaborator Author

Thanks @tacole02. I should have addressed all your comments.

@pracucci pracucci force-pushed the expose-ingest-storage-config-doc-and-changelog branch from 5b64e4a to 0e06226 Compare June 25, 2024 07:09
@pstibrany
Copy link
Member

I'm fine adding it to unreleased section, since all the options are still hidden in 2.13.

I'd suggest documenting the following mixin config options:

  • ingest_storage_enabled -- enables alerts for ingest-storage
  • show_ingest_storage_panels -- shows ingest-storage panels

I meant documenting them in the changelog. However show_ingest_storage_panels is already mentioned in the changelog. ingest_storage_enabled comes from #7867, which is missing changelog entry, but alerts that it enables are already documented in

* [ENHANCEMENT] Alerts: add the following alerts when using ingest-storage: #7699 #7702
  * `MimirIngesterLastConsumedOffsetCommitFailed`
  * `MimirIngesterFailedToReadRecordsFromKafka`
  * `MimirIngesterKafkaFetchErrorsRateTooHigh`
  * `MimirStartingIngesterKafkaReceiveDelayIncreasing`
  * `MimirRunningIngesterReceiveDelayTooHigh`
  * `MimirIngesterFailsToProcessRecordsFromKafka`
  * `MimirIngesterFailsEnforceStrongConsistencyOnReadPath`

entry.

@pracucci
Copy link
Collaborator Author

ingest_storage_enabled comes from #7867, which is missing changelog entry, but alerts that it enables are already documented in entry.

I retro-actively added the PR number to that entry.

…ANGELOG

Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com>
@pracucci pracucci force-pushed the expose-ingest-storage-config-doc-and-changelog branch from 536a145 to 4b38352 Compare June 25, 2024 08:56
@pracucci pracucci enabled auto-merge (squash) June 25, 2024 08:59
@pracucci pracucci merged commit 0eca044 into main Jun 25, 2024
29 checks passed
@pracucci pracucci deleted the expose-ingest-storage-config-doc-and-changelog branch June 25, 2024 10:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants