Add per-tenant request counter metric to index gateway server #9797
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit add a counter metric with labels `operation`, `tenant`, `status` for gRPC requests that are served by the index gateway. What for? The per-tenant RPS on the index gateway is used to derive the per-tenant shard factor. Why tracking on the server? Unlike tracking index gateway RPS on the client side, tracking on the server side does not yield that many series, even in multi-tenant installations with a lot of tenants, because the amout of index gateway instances is relatively small compared to the amount of queriers and frontends. Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
chaudum
force-pushed
the
chaudum/index-gw-instrumentation
branch
from
11d2b44 to
f42c249
Compare
DylanGuedes
approved these changes
Jun 26, 2023
Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
sandeepsukhani
approved these changes
Jun 27, 2023
pkg/loki/modules.go
Outdated
| @@ -1242,6 +1244,15 @@ func (t *Loki) initIndexGatewayRing() (_ services.Service, err error) { | |||
| return t.indexGatewayRingManager, nil | |||
| } | |||
|
|
|||
| func (t *Loki) initIndexGatewayInterceptors() (services.Service, error) { | |||
| // Only expose per-tenant metric if index gateway runs as standalone service | |||
| if util.StringsContain(t.Cfg.Target, IndexGateway) { | |||
There was a problem hiding this comment.
We actually use this to check if the module was set in the targets. Although it does the same thing under the hood, it would be good to keep things consistent.
Suggested change
| if util.StringsContain(t.Cfg.Target, IndexGateway) { | |
| if t.Cfg.isModuleEnabled(IndexGateway) { |
There was a problem hiding this comment.
I did not check the function implementation and thought it that it would also return true if the module is a dependency of the target. I think the function name is slightly misleading.
Of course, I will apply your suggestion.
There was a problem hiding this comment.
yeah, the naming is confusing. This one checks if the user explicitly enabled the module in the targets flag. There is also isModuleActive which checks if the module would be initialized.
Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
chaudum
added a commit
that referenced
this pull request
Jun 27, 2023
This commit add a counter metric `loki_index_gateway_requests_total` with labels `operation`, `tenant`, `status` for gRPC requests that are served by the index gateway. **What for?** The per-tenant RPS on the index gateway is used to derive the per-tenant shard factor. **Why tracking on the server?** Unlike tracking index gateway RPS on the client side, tracking on the server side does not yield that many series, even in multi-tenant installations with a lot of tenants, because the amount of index gateway instances is relatively small compared to the amount of queriers and frontends. **Special notes for your reviewer**: The previous approach of tracking requests on the client #9781 has been abandoned. Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
chaudum
added a commit
that referenced
this pull request
Jun 27, 2023
…#9804) **This is a backport of #9797 to k156** --- This commit add a counter metric `loki_index_gateway_requests_total` with labels `operation`, `tenant`, `status` for gRPC requests that are served by the index gateway. **What for?** The per-tenant RPS on the index gateway is used to derive the per-tenant shard factor. **Why tracking on the server?** Unlike tracking index gateway RPS on the client side, tracking on the server side does not yield that many series, even in multi-tenant installations with a lot of tenants, because the amount of index gateway instances is relatively small compared to the amount of queriers and frontends. **Special notes for your reviewer**: The previous approach of tracking requests on the client #9781 has been abandoned. Signed-off-by: Christian Haudum <christian.haudum@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit add a counter metric with labels
operation,tenant,statusfor gRPC requests that are served by the index gateway.What for?
The per-tenant RPS on the index gateway is used to derive the per-tenant shard factor.
Why tracking on the server?
Unlike tracking index gateway RPS on the client side, tracking on the server side does not yield that many series, even in multi-tenant installations with a lot of tenants, because the amout of index gateway instances is relatively small compared to the amount of queriers and frontends.
Special notes for your reviewer:
The previous approach of tracking requests on the client #9781 has been abandoned.
Checklist
CONTRIBUTING.mdguide (required)CHANGELOG.mdupdatedadd-to-release-noteslabeldocs/sources/upgrading/_index.mdproduction/helm/loki/Chart.yamland updateproduction/helm/loki/CHANGELOG.mdandproduction/helm/loki/README.md. Example PR