-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
sql,server: change indexusagestats subsystem to issue cluster RPC fanout
Previously, indexusagestats subsystem can only read node-local index usage stats. This commit introduces clusterindexusagestats package within the indexusagestats subsystem to use RPC fanout infrastructure inside statusServer to fetch cluster-wide index usage statistics. Related issue: #64740 Release note: None
- Loading branch information
Showing
19 changed files
with
1,727 additions
and
442 deletions.
There are no files selected for viewing
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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| // Copyright 2021 The Cockroach Authors. | ||
| // | ||
| // Use of this software is governed by the Business Source License | ||
| // included in the file licenses/BSL.txt. | ||
| // | ||
| // As of the Change Date specified in that file, in accordance with | ||
| // the Business Source License, use of this software will be governed | ||
| // by the Apache License, Version 2.0, included in the file | ||
| // licenses/APL.txt. | ||
|
|
||
| package server | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/cockroachdb/cockroach/pkg/roachpb" | ||
| "github.com/cockroachdb/cockroach/pkg/server/serverpb" | ||
| "github.com/cockroachdb/cockroach/pkg/sql/idxusage" | ||
| "github.com/cockroachdb/errors" | ||
| "google.golang.org/grpc/codes" | ||
| "google.golang.org/grpc/status" | ||
| ) | ||
|
|
||
| // IndexUsageStatistics is the GRPC handler for serving index usage statistics. | ||
| // If the NodeID in the request payload is left empty, the handler will issue | ||
| // a cluster-wide RPC fanout to aggregate all index usage statistics from all | ||
| // the nodes. If the NodeID is specified, then the handler will handle the | ||
| // request either locally (if the NodeID matches the current node's NodeID) or | ||
| // forward it to the correct node. | ||
| func (s *statusServer) IndexUsageStatistics( | ||
| ctx context.Context, req *serverpb.IndexUsageStatisticsRequest, | ||
| ) (*serverpb.IndexUsageStatisticsResponse, error) { | ||
| ctx = propagateGatewayMetadata(ctx) | ||
| ctx = s.AnnotateCtx(ctx) | ||
|
|
||
| if _, err := s.privilegeChecker.requireViewActivityPermission(ctx); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| localReq := &serverpb.IndexUsageStatisticsRequest{ | ||
| NodeID: "local", | ||
| OrderedTableID: req.OrderedTableID, | ||
| OrderedIndexID: req.OrderedIndexID, | ||
| } | ||
|
|
||
| if len(req.NodeID) > 0 { | ||
| requestedNodeID, local, err := s.parseNodeID(req.NodeID) | ||
| if err != nil { | ||
| return nil, status.Error(codes.InvalidArgument, err.Error()) | ||
| } | ||
| if local { | ||
| statsReader := | ||
| s.sqlServer.pgServer.SQLServer.GetLocalIndexStatisticsReader() | ||
| return serializeIndexUsageStats(req, statsReader) | ||
| } | ||
|
|
||
| statusServer, err := s.dialNode(ctx, requestedNodeID) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return statusServer.IndexUsageStatistics(ctx, localReq) | ||
| } | ||
|
|
||
| // Creating a sink to aggregate all the information. | ||
| aggStats := s.sqlServer.pgServer.SQLServer.GetClusterIndexStatisticsProvider() | ||
| aggStats.Clear() | ||
|
|
||
| dialFn := func(ctx context.Context, nodeID roachpb.NodeID) (interface{}, error) { | ||
| client, err := s.dialNode(ctx, nodeID) | ||
| return client, err | ||
| } | ||
|
|
||
| fetchIndexUsageStats := func(ctx context.Context, client interface{}, _ roachpb.NodeID) (interface{}, error) { | ||
| statusClient := client.(serverpb.StatusClient) | ||
| return statusClient.IndexUsageStatistics(ctx, localReq) | ||
| } | ||
|
|
||
| aggFn := func(_ roachpb.NodeID, resp interface{}) { | ||
| stats := resp.(*serverpb.IndexUsageStatisticsResponse) | ||
| aggStats.BatchInsert(stats.Statistics) | ||
| } | ||
|
|
||
| var combinedError error | ||
| errFn := func(_ roachpb.NodeID, nodeFnError error) { | ||
| if nodeFnError != nil { | ||
| combinedError = errors.CombineErrors(combinedError, nodeFnError) | ||
| } | ||
| } | ||
|
|
||
| // It's unfortunate that we cannot use paginatedIterateNodes here because we | ||
| // need to aggregate all stats before returning. Returning a partial result | ||
| // yields an incorrect result. | ||
| if err := s.iterateNodes(ctx, | ||
| fmt.Sprintf("requesting index usage stats for node %s", req.NodeID), | ||
| dialFn, fetchIndexUsageStats, aggFn, errFn); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return serializeIndexUsageStats(req, aggStats) | ||
| } | ||
|
|
||
| func serializeIndexUsageStats( | ||
| req *serverpb.IndexUsageStatisticsRequest, reader idxusage.Reader, | ||
| ) (*serverpb.IndexUsageStatisticsResponse, error) { | ||
| indexStats := make([]roachpb.CollectedIndexUsageStatistics, 0) | ||
|
|
||
| var max *uint64 | ||
| if req.GetMax() != nil { | ||
| maxLimit := req.GetMaxLimit() | ||
| max = &maxLimit | ||
| } | ||
|
|
||
| err := reader.ForEach(idxusage.IteratorOptions{ | ||
| SortedTableID: req.OrderedTableID, | ||
| SortedIndexID: req.OrderedIndexID, | ||
| Max: max, | ||
| }, func(key *roachpb.IndexUsageKey, value *roachpb.IndexUsageStatistics) error { | ||
| indexStats = append(indexStats, roachpb.CollectedIndexUsageStatistics{ | ||
| Key: *key, | ||
| Stats: *value, | ||
| }) | ||
| return nil | ||
| }) | ||
|
|
||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &serverpb.IndexUsageStatisticsResponse{ | ||
| Statistics: indexStats, | ||
| }, nil | ||
| } |
Oops, something went wrong.