GitHub

API reference for schema.

The messages between an app and the Effect DevTools (Effect's devtools/DevToolsSchema).

The app sends Request\s (Ping, Span snapshots, SpanEvent\s, MetricsSnapshot\s); the DevTools answer Response\s (Pong, MetricsRequest). Both are newline-delimited JSON of REQUEST_CODEC and RESPONSE_CODEC. Optional fields (Effect's UndefinedOr) are None.

Values

AttributeTypeDescription
span_status_startedTaggedStructSchema[SpanStatusStarted, Never, Never]
span_status_endedTaggedStructSchema[SpanStatusEnded, Never, Never]
span_statusUnionSchema[SpanStatusStarted | SpanStatusEnded, Mapping[str, object], Never, Never]
external_spanTaggedStructSchema[ExternalSpan, Never, Never]
spanS.Codec[Span, Any, Any, Any]
parent_spanS.Codec[ParentSpan, Any, Any, Any]
span_eventTaggedStructSchema[SpanEvent, Never, Never]
pingTaggedStructSchema[Ping, Never, Never]
pongTaggedStructSchema[Pong, Never, Never]
metrics_requestTaggedStructSchema[MetricsRequest, Never, Never]
counterAny
frequencyAny
gaugeAny
histogramAny
summaryAny
metricS.Codec[Metric, Any, Any, Any]
metrics_snapshotTaggedStructSchema[MetricsSnapshot, Any, Any]
requestS.Codec[Request, Any, Any, Any]
responseS.Codec[Response, Any, Any, Any]
REQUEST_CODECBottom[Ping | Span | SpanEvent | MetricsSnapshot, bool | int | float | str | Sequence[JsonValue] | Mapping[str, JsonValue] | None, Never, Never]

Request as JSON values (Effect's toCodecJson(Request)).

RESPONSE_CODECBottom[Pong | MetricsRequest, bool | int | float | str | Sequence[JsonValue] | Mapping[str, JsonValue] | None, Never, Never]

Response as JSON values.

Types

TypeDefinitionDescription
SpanStatustype SpanStatus = SpanStatusStarted | SpanStatusEnded
ParentSpantype ParentSpan = Span | ExternalSpan
Metrictype Metric = Counter | Frequency | Gauge | Histogram | Summary
Requesttype Request = Ping | Span | SpanEvent | MetricsSnapshot
Responsetype Response = Pong | MetricsRequest

Classes