apollo-execution-reporting/com.apollographql.execution.reporting

Package-level declarations

Types

class ApolloReportingInstrumentation(val apolloKey: String? = null) : Instrumentation

class ApolloReportingOperationContext(clientName: String? = null, clientVersion: String? = null) : ExecutionContext.Element

ContextualizedQueryLatencyStats

class ContextualizedQueryLatencyStats( val query_latency_stats: QueryLatencyStats? = null, val context: StatsContext? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<ContextualizedQueryLatencyStats, Nothing>

ContextualizedStats

class ContextualizedStats( val context: StatsContext? = null, val query_latency_stats: QueryLatencyStats? = null, per_type_stat: Map<String, TypeStat> = emptyMap(), unknownFields: ByteString = ByteString.EMPTY) : Message<ContextualizedStats, Nothing>

ContextualizedTypeStats

class ContextualizedTypeStats( val context: StatsContext? = null, per_type_stat: Map<String, TypeStat> = emptyMap(), unknownFields: ByteString = ByteString.EMPTY) : Message<ContextualizedTypeStats, Nothing>

FieldStat

class FieldStat( val return_type: String = "", val errors_count: Long = 0, val observed_execution_count: Long = 0, val estimated_execution_count: Long = 0, val requests_with_errors_count: Long = 0, latency_count: List<Long> = emptyList(), unknownFields: ByteString = ByteString.EMPTY) : Message<FieldStat, Nothing>

PathErrorStats

class PathErrorStats( children: Map<String, PathErrorStats> = emptyMap(), val errors_count: Long = 0, val requests_with_errors_count: Long = 0, unknownFields: ByteString = ByteString.EMPTY) : Message<PathErrorStats, Nothing>

QueryLatencyStats

class QueryLatencyStats( latency_count: List<Long> = emptyList(), val request_count: Long = 0, val cache_hits: Long = 0, val persisted_query_hits: Long = 0, val persisted_query_misses: Long = 0, cache_latency_count: List<Long> = emptyList(), val root_error_stats: PathErrorStats? = null, val requests_with_errors_count: Long = 0, public_cache_ttl_count: List<Long> = emptyList(), private_cache_ttl_count: List<Long> = emptyList(), val registered_operation_count: Long = 0, val forbidden_operation_count: Long = 0, val requests_without_field_instrumentation: Long = 0, unknownFields: ByteString = ByteString.EMPTY) : Message<QueryLatencyStats, Nothing>

ReferencedFieldsForType

class ReferencedFieldsForType( field_names: List<String> = emptyList(), val is_interface: Boolean = false, unknownFields: ByteString = ByteString.EMPTY) : Message<ReferencedFieldsForType, Nothing>

Report

class Report( val header_: ReportHeader? = null, traces_per_query: Map<String, TracesAndStats> = emptyMap(), val end_time: Instant? = null, val operation_count: Long = 0, val traces_pre_aggregated: Boolean = false, unknownFields: ByteString = ByteString.EMPTY) : Message<Report, Nothing>

This is the top-level message used by the new traces ingress. This is designed for the apollo-engine-reporting TypeScript agent and will eventually be documented as a public ingress API. This message consists solely of traces; the equivalent of the StatsReport is automatically generated server-side from this message. Agent should either send a trace or include it in the stats for every request in this report. Generally, buffering up until a large size has been reached (say, 4MB) or 5-10 seconds has passed is appropriate. This message used to be know as FullTracesReport, but got renamed since it isn't just for traces anymore

ReportHeader

class ReportHeader( val graph_ref: String = "", val hostname: String = "", val agent_version: String = "", val service_version: String = "", val runtime_version: String = "", val uname: String = "", val executable_schema_id: String = "", unknownFields: ByteString = ByteString.EMPTY) : Message<ReportHeader, Nothing>

The service value embedded within the header key is not guaranteed to contain an actual service, and, in most cases, the service information is trusted to come from upstream processing. If the service is specified in this header, then it is checked to match the context that is reporting it. Otherwise, the service information is deduced from the token context of the reporter and then sent along via other mechanisms (in Kafka, the `ReportKafkaKey). The other information (hostname, agent_version, etc.) is sent by the Apollo Engine Reporting agent, but we do not currently save that information to any of our persistent storage.

StatsContext

class StatsContext( val client_name: String = "", val client_version: String = "", unknownFields: ByteString = ByteString.EMPTY) : Message<StatsContext, Nothing>

Trace

class Trace( val start_time: Instant? = null, val end_time: Instant? = null, val duration_ns: Long = 0, val root: Trace.Node? = null, val is_incomplete: Boolean = false, val signature: String = "", val unexecutedOperationBody: String = "", val unexecutedOperationName: String = "", val details: Trace.Details? = null, val client_name: String = "", val client_version: String = "", val http: Trace.HTTP? = null, val cache_policy: Trace.CachePolicy? = null, val query_plan: Trace.QueryPlanNode? = null, val full_query_cache_hit: Boolean = false, val persisted_query_hit: Boolean = false, val persisted_query_register: Boolean = false, val registered_operation: Boolean = false, val forbidden_operation: Boolean = false, val field_execution_weight: Double = 0.0, unknownFields: ByteString = ByteString.EMPTY) : Message<Trace, Nothing>

TracesAndStats

class TracesAndStats( trace: List<Trace> = emptyList(), stats_with_context: List<ContextualizedStats> = emptyList(), referenced_fields_by_type: Map<String, ReferencedFieldsForType> = emptyMap(), internal_traces_contributing_to_stats: List<Trace> = emptyList(), unknownFields: ByteString = ByteString.EMPTY) : Message<TracesAndStats, Nothing>

A sequence of traces and stats. If Report.traces_pre_aggregated (at the top level of the report) is false, an individual operation should either be described as a trace or as part of stats, but not both. If that flag is true, then all operations are described as stats and some are also described as traces.

TypeStat

class TypeStat(per_field_stat: Map<String, FieldStat> = emptyMap(), unknownFields: ByteString = ByteString.EMPTY) : Message<TypeStat, Nothing>