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#
| Attribute | Type | Description |
|---|---|---|
span_status_started | TaggedStructSchema[SpanStatusStarted, Never, Never] | |
span_status_ended | TaggedStructSchema[SpanStatusEnded, Never, Never] | |
span_status | UnionSchema[SpanStatusStarted | SpanStatusEnded, Mapping[str, object], Never, Never] | |
external_span | TaggedStructSchema[ExternalSpan, Never, Never] | |
span | S.Codec[Span, Any, Any, Any] | |
parent_span | S.Codec[ParentSpan, Any, Any, Any] | |
span_event | TaggedStructSchema[SpanEvent, Never, Never] | |
ping | TaggedStructSchema[Ping, Never, Never] | |
pong | TaggedStructSchema[Pong, Never, Never] | |
metrics_request | TaggedStructSchema[MetricsRequest, Never, Never] | |
counter | Any | |
frequency | Any | |
gauge | Any | |
histogram | Any | |
summary | Any | |
metric | S.Codec[Metric, Any, Any, Any] | |
metrics_snapshot | TaggedStructSchema[MetricsSnapshot, Any, Any] | |
request | S.Codec[Request, Any, Any, Any] | |
response | S.Codec[Response, Any, Any, Any] | |
REQUEST_CODEC | Bottom[Ping | Span | SpanEvent | MetricsSnapshot, bool | int | float | str | Sequence[JsonValue] | Mapping[str, JsonValue] | None, Never, Never] |
|
RESPONSE_CODEC | Bottom[Pong | MetricsRequest, bool | int | float | str | Sequence[JsonValue] | Mapping[str, JsonValue] | None, Never, Never] |
|
Types#
| Type | Definition | Description |
|---|---|---|
SpanStatus | type SpanStatus = SpanStatusStarted | SpanStatusEnded | |
ParentSpan | type ParentSpan = Span | ExternalSpan | |
Metric | type Metric = Counter | Frequency | Gauge | Histogram | Summary | |
Request | type Request = Ping | Span | SpanEvent | MetricsSnapshot | |
Response | type Response = Pong | MetricsRequest |