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

Make ingesters return gRPC errors only #7151

Merged
merged 3 commits into from
Jan 18, 2024
Merged

Make ingesters return gRPC errors only #7151

merged 3 commits into from
Jan 18, 2024

Conversation

duricanikolic
Copy link
Contributor

@duricanikolic duricanikolic commented Jan 17, 2024

What this PR does

This PR deprecates the -ingester.ingester.return-only-grpc-errors CLI flag, and sets its default value to true. This CLI flag will be removed in Mimir 2.14.0, but the default behaviour of Mimir will be as the CLI flag were set to true.

As a direct consequence of this PR, ingesters will always return only gRPC errors. The support for HTTP status codes is still there for backwards compatibility, but will be removed in Mimir 2.14.0, when the -ingester.ingester.return-only-grpc-errors CLI flag is removed.

Remark about backwards compatibility: if migrating from a version prior to 2.11.0 to a version 2.12.0 or later, -ingester.ingester.return-only-grpc-errors should be set to false. Once both distributor and ingester are running on a version 2.12.0 or later, the flag can be removed, so that the Mimir's default behaviour will be used.

Which issue(s) this PR fixes or relates to

Part of #6008

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 Jan 17, 2024
@duricanikolic duricanikolic requested review from a team as code owners January 17, 2024 14:28
Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
Copy link
Contributor

@dimitarvdimitrov dimitarvdimitrov left a comment

Choose a reason for hiding this comment

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

Thanks for your work on this @duricanikolic :)

Should we also move this flag in about-versioning.md from experimental to deprecated?

@duricanikolic
Copy link
Contributor Author

Thanks for your work on this @duricanikolic :)

Should we also move this flag in about-versioning.md from experimental to deprecated?

Good point. Thank you

Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
CHANGELOG.md Outdated Show resolved Hide resolved
Signed-off-by: Yuri Nikolic <durica.nikolic@grafana.com>
@duricanikolic duricanikolic merged commit 3fb6280 into main Jan 18, 2024
28 checks passed
@duricanikolic duricanikolic deleted the yuri/grpc-errors branch January 18, 2024 10:35
@@ -23,7 +23,7 @@
* [CHANGE] All: set `-server.report-grpc-codes-in-instrumentation-label-enabled` to `true` by default, which enables reporting gRPC status codes as `status_code` labels in the `cortex_request_duration_seconds` metric. #7144
* [CHANGE] Distributor: report gRPC status codes as `status_code` labels in the `cortex_ingester_client_request_duration_seconds` metric by default. #7144
* [CHANGE] Distributor: CLI flag `-ingester.client.report-grpc-codes-in-instrumentation-label-enabled` has been deprecated, and its default value is set to `true`. #7144
* [CHANGE] Ingester: CLI flag `-ingester.return-only-grpc-errors` has been deprecated, and its default value is set to `true`. #7151
* [CHANGE] Ingester: CLI flag `-ingester.return-only-grpc-errors` has been deprecated, and its default value is set to `true`. To ensure backwards compatibility, during a migration from a version prior to 2.11.0 to 2.12 or later, `-ingester.return-only-grpc-errors` should be set to `false`. Once all the components are migrated, the flag can be removed. #7151
Copy link
Contributor

Choose a reason for hiding this comment

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

Since the side effects aren't that bad (misinterpreted error codes only, right?), should we mention the tradeoff of not doing a proper migration too? I think this might help some users just decide to not do a migration.

This may be on the longer side for a changelog entry, but i think that it will be useful information in the release notes and we have the context now, so might as well do it now.

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.

None yet

3 participants