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.

Sign up for GitHub

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

server: add internal_app_name_prefix to ListSessionsResponse #76307

Merged
merged 1 commit into from
Feb 11, 2022
Merged

server: add internal_app_name_prefix to ListSessionsResponse #76307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions docs/generated/http/full.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1768,6 +1768,7 @@ Response object for ListSessions and ListLocalSessions.
| ----- | ---- | ----- | ----------- | -------------- |
| sessions | [Session](#cockroach.server.serverpb.ListSessionsResponse-cockroach.server.serverpb.Session) | repeated | A list of sessions on this node or cluster. | [reserved](#support-status) |
| errors | [ListSessionsError](#cockroach.server.serverpb.ListSessionsResponse-cockroach.server.serverpb.ListSessionsError) | repeated | Any errors that occurred during fan-out calls to other nodes. | [reserved](#support-status) |
| internal_app_name_prefix | [string](#cockroach.server.serverpb.ListSessionsResponse-string) | | If set and non-empty, indicates the prefix to application_name used for statements/queries issued internally by CockroachDB. | [reserved](#support-status) |



Expand Down Expand Up @@ -1897,6 +1898,7 @@ Response object for ListSessions and ListLocalSessions.
| ----- | ---- | ----- | ----------- | -------------- |
| sessions | [Session](#cockroach.server.serverpb.ListSessionsResponse-cockroach.server.serverpb.Session) | repeated | A list of sessions on this node or cluster. | [reserved](#support-status) |
| errors | [ListSessionsError](#cockroach.server.serverpb.ListSessionsResponse-cockroach.server.serverpb.ListSessionsError) | repeated | Any errors that occurred during fan-out calls to other nodes. | [reserved](#support-status) |
| internal_app_name_prefix | [string](#cockroach.server.serverpb.ListSessionsResponse-string) | | If set and non-empty, indicates the prefix to application_name used for statements/queries issued internally by CockroachDB. | [reserved](#support-status) |



Expand Down
10 changes: 10 additions & 0 deletions docs/generated/swagger/spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -929,6 +929,11 @@
},
"x-go-name": "Errors"
},
"internal_app_name_prefix": {
"description": "If set and non-empty, indicates the prefix to application_name\nused for statements/queries issued internally by CockroachDB.",
"type": "string",
"x-go-name": "InternalAppNamePrefix"
},
"sessions": {
"description": "A list of sessions on this node or cluster.",
"type": "array",
Expand Down Expand Up @@ -1810,6 +1815,11 @@
},
"x-go-name": "Errors"
},
"internal_app_name_prefix": {
"description": "If set and non-empty, indicates the prefix to application_name\nused for statements/queries issued internally by CockroachDB.",
"type": "string",
"x-go-name": "InternalAppNamePrefix"
},
"next": {
"description": "The continuation token, for use in the next paginated call in the `start`\nparameter.",
"type": "string",
Expand Down
3 changes: 3 additions & 0 deletions pkg/server/serverpb/status.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -818,6 +818,9 @@ message ListSessionsResponse {
repeated Session sessions = 1 [ (gogoproto.nullable) = false ];
// Any errors that occurred during fan-out calls to other nodes.
repeated ListSessionsError errors = 2 [ (gogoproto.nullable) = false ];
// If set and non-empty, indicates the prefix to application_name
// used for statements/queries issued internally by CockroachDB.
string internal_app_name_prefix = 3;
}

// Request object for issuing a query cancel request.
Expand Down
6 changes: 4 additions & 2 deletions pkg/server/status.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ import (
"github.com/cockroachdb/cockroach/pkg/server/telemetry"
"github.com/cockroachdb/cockroach/pkg/settings/cluster"
"github.com/cockroachdb/cockroach/pkg/sql"
"github.com/cockroachdb/cockroach/pkg/sql/catalog/catconstants"
"github.com/cockroachdb/cockroach/pkg/sql/contention"
"github.com/cockroachdb/cockroach/pkg/sql/flowinfra"
"github.com/cockroachdb/cockroach/pkg/sql/roleoption"
Expand Down Expand Up @@ -2292,8 +2293,9 @@ func (s *statusServer) listSessionsHelper(
ctx context.Context, req *serverpb.ListSessionsRequest, limit int, start paginationState,
) (*serverpb.ListSessionsResponse, paginationState, error) {
response := &serverpb.ListSessionsResponse{
Sessions: make([]serverpb.Session, 0),
Errors: make([]serverpb.ListSessionsError, 0),
Sessions: make([]serverpb.Session, 0),
Errors: make([]serverpb.ListSessionsError, 0),
InternalAppNamePrefix: catconstants.InternalAppNamePrefix,
}

dialFn := func(ctx context.Context, nodeID roachpb.NodeID) (interface{}, error) {
Expand Down
9 changes: 7 additions & 2 deletions pkg/server/tenant_status.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,9 @@ func (t *tenantStatusServer) ListSessions(
return nil, status.Errorf(codes.Unavailable, "instanceID not set")
}

response := &serverpb.ListSessionsResponse{}
response := &serverpb.ListSessionsResponse{
InternalAppNamePrefix: catconstants.InternalAppNamePrefix,
}
nodeStatement := func(ctx context.Context, client interface{}, instanceID base.SQLInstanceID) (interface{}, error) {
statusClient := client.(serverpb.StatusClient)
localResponse, err := statusClient.ListLocalSessions(ctx, req)
Expand Down Expand Up @@ -166,7 +168,10 @@ func (t *tenantStatusServer) ListLocalSessions(
return nil, status.Errorf(codes.Unavailable, "instanceID not set")
}

return &serverpb.ListSessionsResponse{Sessions: sessions}, nil
return &serverpb.ListSessionsResponse{
Sessions: sessions,
InternalAppNamePrefix: catconstants.InternalAppNamePrefix,
}, nil
}

func (t *tenantStatusServer) CancelQuery(
Expand Down