package wg.cosmo.graphqlmetrics.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc PublishGraphQLMetrics (PublishGraphQLRequestMetricsRequest, PublishOperationCoverageReportResponse)

  graphqlmetrics.proto:123

  PublishGraphQLMetrics publishes the GraphQL metrics to the metrics service

  message PublishGraphQLRequestMetricsRequest

  graphqlmetrics.proto:107

  • repeated SchemaUsageInfo SchemaUsage = 1

  message PublishOperationCoverageReportResponse

  graphqlmetrics.proto:111

  (message has no fields)

• rpc PublishAggregatedGraphQLMetrics (PublishAggregatedGraphQLRequestMetricsRequest, PublishAggregatedGraphQLRequestMetricsResponse)

  graphqlmetrics.proto:124

  message PublishAggregatedGraphQLRequestMetricsRequest

  graphqlmetrics.proto:114

  • repeated SchemaUsageInfoAggregation Aggregation = 1

  message PublishAggregatedGraphQLRequestMetricsResponse

  graphqlmetrics.proto:118

  (message has no fields)

Used in: SchemaUsageInfo

• repeated string Path = 1

  Path is the path to the field in the request document but without the root type query, mutation, or subscription

• string TypeName = 2

  TypeName is the enclosing type name of the argument

• uint64 Count = 3

  Count is the number of times the argument is used. Useful for batching at client side.

• string NamedType = 4

  NamedType is the underlying type of the argument

Used in: SchemaUsageInfo

• string Name = 1

  Name is the GraphQL client name obtained from the request header

• string Version = 2

  Version is the GraphQL client version obtained from the request header

Used in: SchemaUsageInfo

• repeated string Path = 1

  Path is the path to the field in the request document but without the root type query, mutation, or subscription

• string TypeName = 2

  TypeName is the enclosing type name of the argument

• uint64 Count = 3

  Count is the number of times the argument is used. Useful for batching at client side.

• string NamedType = 4

  NamedType is the underlying type of the input field

• repeated string EnumValues = 5

  EnumValues is an empty list if the input field is not an enum, otherwise it contains the list of used enum values

Used in: SchemaUsageInfo

• string Hash = 1

  Hash is the hash of the request document and the operation name

• string Name = 2

  Name is the operation name

• OperationType Type = 3

  Type is the operation type

Used in: OperationInfo

• QUERY = 0

• MUTATION = 1

• SUBSCRIPTION = 2

Used in: SchemaUsageInfo

• int32 StatusCode = 1

• bool error = 2

FederatedGraphID and OrganizationID are transport over JWT

Used in: SchemaUsageInfo

• string Version = 3

  Version is the schema version

Used in: PublishGraphQLRequestMetricsRequest, SchemaUsageInfoAggregation

• string RequestDocument = 1

  RequestDocument is the fully normalized GraphQL request document

• repeated TypeFieldUsageInfo TypeFieldMetrics = 2

  TypeFieldMetrics is the list of used fields in the request document

• optional OperationInfo OperationInfo = 3

  OperationInfo is the operation info

• optional SchemaInfo SchemaInfo = 4

  SchemaInfo is the schema info

• optional ClientInfo ClientInfo = 5

  ClientInfo is the client info

• optional RequestInfo RequestInfo = 6

  RequestInfo is the request info

• map<string, string> Attributes = 7

  Attributes is a map of attributes that can be used to filter the metrics

• repeated ArgumentUsageInfo ArgumentMetrics = 8

  ArgumentMetrics is the list of used arguments in the request document

• repeated InputUsageInfo InputMetrics = 9

  InputMetrics is the list of used input fields in the request document

Used in: PublishAggregatedGraphQLRequestMetricsRequest

• optional SchemaUsageInfo SchemaUsage = 1

• uint64 RequestCount = 2

Used in: SchemaUsageInfo

• repeated string Path = 1

  Path is the path to the field in the request document but without the root type query, mutation, or subscription

• repeated string TypeNames = 2

  TypeNames is the list of enclosing type names of the field

• repeated string SubgraphIDs = 3

  SubgraphIDs is the list of datasource IDs (e.g subgraph ID) that the field is used from

• uint64 Count = 4

  Count is the number of times the field is used. Useful for batching at client side.

• string NamedType = 5

  NamedType is the underlying type of the field

• bool IndirectInterfaceField = 6

  IndirectInterfaceField is true if the field is an interface field that is used through an implementing type