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

Remote ruler reads dashboard: allow using cortex_request_duration_seconds native histogram #8801

Merged
merged 2 commits into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,11 @@
* Overview dashboard: status, read/write latency and queries/ingestion per sec panels, `cortex_request_duration_seconds` metric. #7674 #8502 #8791
* Writes dashboard: `cortex_request_duration_seconds` metric. #8757 #8791
* Reads dashboard: `cortex_request_duration_seconds` metric. #8752
* Rollout progress dashboard. #8779
* Alertmanager dashboard. #8792
* Rollout progress dashboard: `cortex_request_duration_seconds` metric. #8779
* Alertmanager dashboard: `cortex_request_duration_seconds` metric. #8792
* Ruler dashboard: `cortex_request_duration_seconds` metric. #8795
* Queries dashboard: `cortex_request_duration_seconds` metric. #8800
* Remote ruler reads dashboard: `cortex_request_duration_seconds` metric. #8801
* [ENHANCEMENT] Alerts: `MimirRunningIngesterReceiveDelayTooHigh` alert has been tuned to be more reactive to high receive delay. #8538
* [ENHANCEMENT] Dashboards: improve end-to-end latency and strong read consistency panels when experimental ingest storage is enabled. #8543
* [ENHANCEMENT] Dashboards: Add panels for monitoring ingester autoscaling when not using ingest-storage. These panels are disabled by default, but can be enabled using the `autoscaling.ingester.enabled: true` config option. #8484
Expand Down
5 changes: 3 additions & 2 deletions operations/helm/charts/mimir-distributed/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,11 @@ Entries should include a reference to the Pull Request that introduced the chang
* Overview dashboard: status, read/write latency and queries/ingestion per sec panels, `cortex_request_duration_seconds` metric. #7674
* Writes dashboard: `cortex_request_duration_seconds` metric. #8757
* Reads dashboard: `cortex_request_duration_seconds` metric. #8752
* Rollout progress dashboard. #8779
* Alertmanager dashboard. #8792
* Rollout progress dashboard: `cortex_request_duration_seconds` metric. #8779
* Alertmanager dashboard: `cortex_request_duration_seconds` metric. #8792
* Ruler dashboard: `cortex_request_duration_seconds` metric. #8795
* Queries dashboard: `cortex_request_duration_seconds` metric. #8800
* Remote ruler reads dashboard: `cortex_request_duration_seconds` metric. #8801
* [ENHANCEMENT] Memcached: Update to Memcached 1.6.28 and memcached-exporter 0.14.4. #8557
* [ENHANCEMENT] Add missing fields in multiple topology spread constraints. #8533
* [ENHANCEMENT] Add support for setting the image pull secrets, node selectors, tolerations and topology spread constraints for the Grafana Agent pods used for metamonitoring. #8670
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 18 additions & 7 deletions operations/mimir-mixin/dashboards/dashboard-queries.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
queries:: {
// Define the supported replacement variables in a single place. Most of them are frequently used.
local variables = {
requestsPerSecondMetric: $.requests_per_second_metric,
gatewayMatcher: $.jobMatcher($._config.job_names.gateway),
distributorMatcher: $.jobMatcher($._config.job_names.distributor),
ingesterMatcher: $.jobMatcher($._config.job_names.ingester),
Expand All @@ -90,18 +91,21 @@ local utils = import 'mixin-utils/utils.libsonnet';
alertmanagerMatcher: $.jobMatcher($._config.job_names.alertmanager),
namespaceMatcher: $.namespaceMatcher(),
storeGatewayMatcher: $.jobMatcher($._config.job_names.store_gateway),
rulerQueryFrontendMatcher: $.jobMatcher($._config.job_names.ruler_query_frontend),
writeHTTPRoutesRegex: $.queries.write_http_routes_regex,
writeDistributorRoutesRegex: std.join('|', [$.queries.write_grpc_distributor_routes_regex, $.queries.write_http_routes_regex]),
writeGRPCIngesterRoute: $.queries.write_grpc_ingester_route,
readHTTPRoutesRegex: $.queries.read_http_routes_regex,
readGRPCIngesterRoute: $.queries.read_grpc_ingester_route,
readGRPCStoreGatewayRoute: $.queries.read_grpc_store_gateway_route,
rulerQueryFrontendRoutesRegex: $.queries.ruler_query_frontend_routes_regex,
perClusterLabel: $._config.per_cluster_label,
recordingRulePrefix: $.recordingRulePrefix($.jobSelector('any')), // The job name does not matter here.
groupPrefixJobs: $._config.group_prefix_jobs,
instance: $._config.per_instance_label,
},

requests_per_second_metric: 'cortex_request_duration_seconds',
write_http_routes_regex: 'api_(v1|prom)_push|otlp_v1_metrics',
write_grpc_distributor_routes_regex: '/distributor.Distributor/Push|/httpgrpc.*',
write_grpc_ingester_route: '/cortex.Ingester/Push',
Expand All @@ -111,10 +115,12 @@ local utils = import 'mixin-utils/utils.libsonnet';
query_http_routes_regex: '(prometheus|api_prom)_api_v1_query(_range)?',
alertmanager_http_routes_regex: 'api_v1_alerts|alertmanager',
alertmanager_grpc_routes_regex: '/alertmanagerpb.Alertmanager/HandleRequest',
// Both support gRPC and HTTP requests. HTTP request is used when rule evaluation query requests go through the query-tee.
ruler_query_frontend_routes_regex: '/httpgrpc.HTTP/Handle|.*api_v1_query',

gateway: {
local p = self,
requestsPerSecondMetric: 'cortex_request_duration_seconds',
requestsPerSecondMetric: $.queries.requests_per_second_metric,
writeRequestsPerSecondSelector: '%(gatewayMatcher)s, route=~"%(writeHTTPRoutesRegex)s"' % variables,
readRequestsPerSecondSelector: '%(gatewayMatcher)s, route=~"%(readHTTPRoutesRegex)s"' % variables,

Expand All @@ -127,7 +133,7 @@ local utils = import 'mixin-utils/utils.libsonnet';

distributor: {
local p = self,
requestsPerSecondMetric: 'cortex_request_duration_seconds',
requestsPerSecondMetric: $.queries.requests_per_second_metric,
writeRequestsPerSecondRouteRegex: '%(writeDistributorRoutesRegex)s' % variables,
writeRequestsPerSecondSelector: '%(distributorMatcher)s, route=~"%(writeDistributorRoutesRegex)s"' % variables,
samplesPerSecond: 'sum(%(groupPrefixJobs)s:cortex_distributor_received_samples:rate5m{%(distributorMatcher)s})' % variables,
Expand All @@ -139,7 +145,7 @@ local utils = import 'mixin-utils/utils.libsonnet';

query_frontend: {
local p = self,
requestsPerSecondMetric: 'cortex_request_duration_seconds',
requestsPerSecondMetric: $.queries.requests_per_second_metric,
readRequestsPerSecondSelector: '%(queryFrontendMatcher)s, route=~"%(readHTTPRoutesRegex)s"' % variables,
// These query routes are used in the overview and other dashboard, everythign else is considered "other" queries.
// Has to be a list to keep the same colors as before, see overridesNonErrorColorsPalette.
Expand Down Expand Up @@ -198,7 +204,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
},

ruler: {
requestsPerSecondMetric: 'cortex_request_duration_seconds',
requestsPerSecondMetric: $.queries.requests_per_second_metric,
evaluations: {
successPerSecond:
|||
Expand Down Expand Up @@ -253,7 +259,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
},

alertmanager: {
requestsPerSecondMetric: 'cortex_request_duration_seconds',
requestsPerSecondMetric: $.queries.requests_per_second_metric,
notifications: {
// Notifications / sec attempted to deliver by the Alertmanager to the receivers.
totalPerSecond: |||
Expand Down Expand Up @@ -293,7 +299,7 @@ local utils = import 'mixin-utils/utils.libsonnet';
},

ingester: {
requestsPerSecondMetric: 'cortex_request_duration_seconds',
requestsPerSecondMetric: $.queries.requests_per_second_metric,
readRequestsPerSecondSelector: '%(ingesterMatcher)s,route=~"%(readGRPCIngesterRoute)s"' % variables,
writeRequestsPerSecondSelector: '%(ingesterMatcher)s, route="%(writeGRPCIngesterRoute)s"' % variables,

Expand Down Expand Up @@ -324,8 +330,13 @@ local utils = import 'mixin-utils/utils.libsonnet';
},

store_gateway: {
requestsPerSecondMetric: 'cortex_request_duration_seconds',
requestsPerSecondMetric: $.queries.requests_per_second_metric,
readRequestsPerSecondSelector: '%(storeGatewayMatcher)s,route=~"%(readGRPCStoreGatewayRoute)s"' % variables,
},

ruler_query_frontend: {
requestsPerSecondMetric: $.queries.requests_per_second_metric,
readRequestsPerSecondSelector: '%(rulerQueryFrontendMatcher)s,route=~"%(rulerQueryFrontendRoutesRegex)s"' % variables,
},
},
}
19 changes: 2 additions & 17 deletions operations/mimir-mixin/dashboards/remote-ruler-reads.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ local filename = 'mimir-remote-ruler-reads.json';

(import 'dashboard-utils.libsonnet') +
(import 'dashboard-queries.libsonnet') {
// Both support gRPC and HTTP requests. HTTP request is used when rule evaluation query requests go through the query-tee.
local rulerRoutesRegex = '/httpgrpc.HTTP/Handle|.*api_v1_query',

[filename]:
assert std.md5(filename) == 'f103238f7f5ab2f1345ce650cbfbfe2f' : 'UID of the dashboard has changed, please update references to dashboard.';
($.dashboard('Remote ruler reads') + { uid: std.md5(filename) })
Expand Down Expand Up @@ -33,19 +30,7 @@ local filename = 'mimir-remote-ruler-reads.json';
})
.addPanel(
$.panel('Evaluations / sec') +
$.statPanel(|||
sum(
rate(
cortex_request_duration_seconds_count{
%(queryFrontend)s,
route=~"%(rulerRoutesRegex)s"
}[$__rate_interval]
)
)
||| % {
queryFrontend: $.jobMatcher($._config.job_names.ruler_query_frontend),
rulerRoutesRegex: rulerRoutesRegex,
}, format='reqps') +
$.statPanel(utils.ncHistogramSumBy(utils.ncHistogramCountRate($.queries.ruler_query_frontend.requestsPerSecondMetric, $.queries.ruler_query_frontend.readRequestsPerSecondSelector)), format='reqps') +
$.panelDescription(
'Evaluations per second',
|||
Expand All @@ -58,7 +43,7 @@ local filename = 'mimir-remote-ruler-reads.json';
queryFrontendJobName=$._config.job_names.ruler_query_frontend,
querySchedulerJobName=$._config.job_names.ruler_query_scheduler,
querierJobName=$._config.job_names.ruler_querier,
queryRoutesRegex=rulerRoutesRegex,
queryRoutesRegex=$.queries.ruler_query_frontend_routes_regex,

rowTitlePrefix='Ruler-',
))
Expand Down
Loading