caliban-federation
API
Generated with
caliban-federation/mdg.engine.proto.reports/Trace

Trace

mdg.engine.proto.reports.Trace$
See theTrace companion class
object Trace extends GeneratedMessageCompanion[Trace]

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Trace]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Trace.type

Members list

Type members

Classlikes

final case class CachePolicy(scope: Scope, maxAgeNs: Long, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CachePolicy]

Value parameters

maxAgeNs

use 0 for absent, -1 for 0

Attributes

Companion
object
Supertypes
trait Updatable[CachePolicy]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CachePolicy extends GeneratedMessageCompanion[CachePolicy]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CachePolicy]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class Details(variablesJson: Map[String, String], deprecatedVariables: Map[String, ByteString], operationName: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Details]

Value parameters

deprecatedVariables

Deprecated. Engineproxy did not encode variable values as JSON, so you couldn't tell numbers from numeric strings. Send variables_json instead.

operationName

This is deprecated and only used for legacy applications don't include this in traces inside a FullTracesReport; the operation name for these traces comes from the key of the traces_per_query map.

variablesJson

The variables associated with this query (unless the reporting agent is configured to keep them all private). Values are JSON: ie, strings are enclosed in double quotes, etc. The value of a private variable is the empty string.

Attributes

Companion
object
Supertypes
trait Updatable[Details]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Details extends GeneratedMessageCompanion[Details]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Details]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Details.type
final case class Error(message: String, location: Seq[Location], timeNs: Long, json: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Error]

Value parameters

message

required

Attributes

Companion
object
Supertypes
trait Updatable[Error]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Error extends GeneratedMessageCompanion[Error]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Error]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Error.type
final case class HTTP(method: Method, host: String, path: String, requestHeaders: Map[String, Values], responseHeaders: Map[String, Values], statusCode: Int, secure: Boolean, protocol: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[HTTP]

Value parameters

protocol

by convention "HTTP/1.0", "HTTP/1.1", "HTTP/2" or "h2"

requestHeaders

Should exclude manual blacklist ("Auth" by default)

secure

TLS was used

Attributes

Companion
object
Supertypes
trait Updatable[HTTP]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HTTP extends GeneratedMessageCompanion[HTTP]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[HTTP]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
HTTP.type
final case class Location(line: Int, column: Int, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Location]

Attributes

Companion
object
Supertypes
trait Updatable[Location]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Location extends GeneratedMessageCompanion[Location]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Location]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Location.type
final case class Node(id: Id, originalFieldName: String, `type`: String, parentType: String, cachePolicy: Option[CachePolicy], startTime: Long, endTime: Long, error: Seq[Error], child: Seq[Node], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Node]

We store information on each resolver execution as a Node on a tree. The structure of the tree corresponds to the structure of the GraphQL response; it does not indicate the order in which resolvers were invoked. Note that nodes representing indexes (and the root node) don't contain all Node fields (eg types and times).

We store information on each resolver execution as a Node on a tree. The structure of the tree corresponds to the structure of the GraphQL response; it does not indicate the order in which resolvers were invoked. Note that nodes representing indexes (and the root node) don't contain all Node fields (eg types and times).

Value parameters

endTime

relative to the trace's start_time, in ns

parentType

The field's parent type; e.g. "User" for User.email:String!

startTime

relative to the trace's start_time, in ns

type

The field's return type; e.g. "String!" for User.email:String!

Attributes

Companion
object
Supertypes
trait Updatable[Node]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Node extends GeneratedMessageCompanion[Node]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Node]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Node.type
final case class QueryPlanNode(node: Node, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[QueryPlanNode]

represents a node in the query plan, under which there is a trace tree for that service fetch. In particular, each fetch node represents a call to an implementing service, and calls to implementing services may not be unique. See https://github.com/apollographql/apollo-server/blob/main/packages/apollo-gateway/src/QueryPlan.ts for more information and details.

represents a node in the query plan, under which there is a trace tree for that service fetch. In particular, each fetch node represents a call to an implementing service, and calls to implementing services may not be unique. See https://github.com/apollographql/apollo-server/blob/main/packages/apollo-gateway/src/QueryPlan.ts for more information and details.

Attributes

Companion
object
Supertypes
trait Updatable[QueryPlanNode]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object QueryPlanNode extends GeneratedMessageCompanion[QueryPlanNode]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[QueryPlanNode]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
implicit class TraceLens[UpperPB](_l: Lens[UpperPB, Trace]) extends ObjectLens[UpperPB, Trace]

Attributes

Supertypes
class ObjectLens[UpperPB, Trace]
trait Lens[UpperPB, Trace]
trait Serializable
class Object
trait Matchable
class Any
Show all

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
type ValueType = A

Attributes

Inherited from:
GeneratedMessageCompanion

Value members

Concrete methods

def enumCompanionForFieldNumber(`__fieldNumber`: Int): GeneratedEnumCompanion[_]
def javaDescriptor: Descriptor

Returns the Java descriptors for this message. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not available in Scala.js or scala-native.

Returns the Java descriptors for this message. It is recommended to use scalaDescriptors. The Java descriptors are available even when Java conversions is disabled, however they are not available in Scala.js or scala-native.

Attributes

def messageCompanionForFieldNumber(`__number`: Int): GeneratedMessageCompanion[_]
def of(startTime: Option[Timestamp], endTime: Option[Timestamp], durationNs: Long, root: Option[Node], signature: String, unexecutedOperationBody: String, unexecutedOperationName: String, details: Option[Details], clientName: String, clientVersion: String, clientAddress: String, clientReferenceId: String, http: Option[HTTP], cachePolicy: Option[CachePolicy], queryPlan: Option[QueryPlanNode], fullQueryCacheHit: Boolean, persistedQueryHit: Boolean, persistedQueryRegister: Boolean, registeredOperation: Boolean, forbiddenOperation: Boolean, legacySignatureNeedsResigning: String): Trace
def parseFrom(`_input__`: CodedInputStream): Trace

Parses a message from a CodedInputStream.

Parses a message from a CodedInputStream.

Attributes

def scalaDescriptor: Descriptor

Inherited methods

def enumCompanionForField(field: FieldDescriptor): GeneratedEnumCompanion[_]

Attributes

Inherited from:
GeneratedMessageCompanion
def fromAscii(s: String): A

Attributes

Inherited from:
GeneratedMessageCompanion
def merge(a: Trace, input: CodedInputStream): A

Merges the given message with the additional fields in the steam.

Merges the given message with the additional fields in the steam.

Attributes

Inherited from:
GeneratedMessageCompanion
def messageCompanionForField(field: FieldDescriptor): GeneratedMessageCompanion[_]

Attributes

Inherited from:
GeneratedMessageCompanion
def parseDelimitedFrom(input: InputStream): Option[A]

Attributes

Inherited from:
GeneratedMessageCompanion
def parseDelimitedFrom(input: CodedInputStream): Option[A]

Attributes

Inherited from:
GeneratedMessageCompanion
def parseFrom(s: Array[Byte]): A

Attributes

Inherited from:
GeneratedMessageCompanion
def parseFrom(input: InputStream): A

Attributes

Inherited from:
GeneratedMessageCompanion
def streamFromDelimitedInput(input: InputStream): Stream[A]

Attributes

Inherited from:
GeneratedMessageCompanion
def toByteArray(a: Trace): Array[Byte]

Attributes

Inherited from:
GeneratedMessageCompanion
def validate(s: Array[Byte]): Try[A]

Attributes

Inherited from:
GeneratedMessageCompanion
def validateAscii(s: String): Either[TextFormatError, A]

Attributes

Inherited from:
GeneratedMessageCompanion

Concrete fields

final val DETAILS_FIELD_NUMBER: 6
final val DURATION_NS_FIELD_NUMBER: 11
final val END_TIME_FIELD_NUMBER: 3
final val HTTP_FIELD_NUMBER: 10
final val QUERY_PLAN_FIELD_NUMBER: 26
final val ROOT_FIELD_NUMBER: 14
final val SIGNATURE_FIELD_NUMBER: 19
lazy val nestedMessagesCompanions: Seq[GeneratedMessageCompanion[_ <: GeneratedMessage]]

Implicits

Implicits

final implicit def TraceLens[UpperPB](_l: Lens[UpperPB, Trace]): TraceLens[UpperPB]
implicit def messageCompanion: GeneratedMessageCompanion[Trace]
implicit def messageReads: Reads[Trace]
Generated with