Directories
¶
| Path | Synopsis |
|---|---|
|
Package apifiles snapshots API files for content-addressed delivery.
|
Package apifiles snapshots API files for content-addressed delivery. |
|
Package backoff is the SDK's retry policy as a value: bounds the author can set, run by github.com/cenkalti/backoff (exponential, jittered, so instances recovering from one outage do not retry in lockstep).
|
Package backoff is the SDK's retry policy as a value: bounds the author can set, run by github.com/cenkalti/backoff (exponential, jittered, so instances recovering from one outage do not retry in lockstep). |
|
Package broker carries events over NATS JetStream (design §8).
|
Package broker carries events over NATS JetStream (design §8). |
|
Package configrt is what the SDK core needs from a live configuration and authors do not: the effective values for instance state, schema walks for the manifest and provenance.
|
Package configrt is what the SDK core needs from a live configuration and authors do not: the effective values for instance state, schema walks for the manifest and provenance. |
|
Package consul keeps a service present in Consul: manifest per version, instance state under a TTL session (it disappears with the instance) and the catalog registration.
|
Package consul keeps a service present in Consul: manifest per version, instance state under a TTL session (it disappears with the instance) and the catalog registration. |
|
Package decl is shared by the hook, activity and event packages: it resolves the service a Scope belongs to, derives payload schemas and encodes payloads.
|
Package decl is shared by the hook, activity and event packages: it resolves the service a Scope belongs to, derives payload schemas and encodes payloads. |
|
Package direct is the SDK's side of backplane's direct runtime: the ActivityService that lets backplane run the service's activities over gRPC on the platform port, and the hook Caller that reaches backplane's HookService the same way.
|
Package direct is the SDK's side of backplane's direct runtime: the ActivityService that lets backplane run the service's activities over gRPC on the platform port, and the hook Caller that reaches backplane's HookService the same way. |
|
Package env is what every node of one service shares: the manifest being declared into and the wiring of events, hooks and activities to a transport.
|
Package env is what every node of one service shares: the manifest being declared into and the wiring of events, hooks and activities to a transport. |
|
Package errtext renders errors for telemetry: what an error's text may carry that must not leave the service is cut, the error itself is left as it is (errors.Is/As keep working).
|
Package errtext renders errors for telemetry: what an error's text may carry that must not leave the service is cut, the error itself is left as it is (errors.Is/As keep working). |
|
Package exception writes errors and panics as OpenTelemetry exception log records: exception.type, exception.message, exception.stacktrace and event.name=exception.
|
Package exception writes errors and panics as OpenTelemetry exception log records: exception.type, exception.message, exception.stacktrace and event.name=exception. |
|
Package gate admits internal API calls only while the author's tree is up: before it started they get Unavailable, and stopping waits for the calls in flight before the tree (and its dependencies) stops.
|
Package gate admits internal API calls only while the author's tree is up: before it started they get Unavailable, and stopping waits for the calls in flight before the tree (and its dependencies) stops. |
|
Package guard protects the platform port with the installation's internal secret: the console relay presents it, the SDK checks it.
|
Package guard protects the platform port with the installation's internal secret: the console relay presents it, the SDK checks it. |
|
Package health is the single source of a service's health: probes are registered by kind, their composite status is cached in xprobe states, and grpc.health.v1, the HTTP probe endpoints and the Consul check all read the same states.
|
Package health is the single source of a service's health: probes are registered by kind, their composite status is cached in xprobe states, and grpc.health.v1, the HTTP probe endpoints and the Consul check all read the same states. |
|
Package link lets SDK packages reach what public types keep private: the node behind a deps.Scope.
|
Package link lets SDK packages reach what public types keep private: the node behind a deps.Scope. |
|
Package listener serves gRPC and HTTP on one address through cmux.
|
Package listener serves gRPC and HTTP on one address through cmux. |
|
Package manifest collects a service's declarations into a backplanev1.Manifest.
|
Package manifest collects a service's declarations into a backplanev1.Manifest. |
|
Package metrics is the SDK's own instrumentation, on meter github.com/backplane-labs/backplane.
|
Package metrics is the SDK's own instrumentation, on meter github.com/backplane-labs/backplane. |
|
Package mtls is mutual TLS between services: a Source (the service's live certificate, the trusted roots and who may call it — the Consul driver's follows Consul's CA and intentions) turned into the TLS of a public port and of clients, and the caller of a request: its service, taken from the SPIFFE URI of the certificate it presented.
|
Package mtls is mutual TLS between services: a Source (the service's live certificate, the trusted roots and who may call it — the Consul driver's follows Consul's CA and intentions) turned into the TLS of a public port and of clients, and the caller of a request: its service, taken from the SPIFFE URI of the certificate it presented. |
|
Package node is the service's one lifecycle model: a tree of nodes, each with a name, a logger, an instrumentation scope, start and stop hooks, its own goroutines and an optional readiness probe.
|
Package node is the service's one lifecycle model: a tree of nodes, each with a name, a logger, an instrumentation scope, start and stop hooks, its own goroutines and an optional readiness probe. |
|
Package recovery turns a panic in a request handler into an error for that request instead of a crashed process: gRPC and ws-proto calls get codes.Internal, HTTP requests 500.
|
Package recovery turns a panic in a request handler into an error for that request instead of a crashed process: gRPC and ws-proto calls get codes.Internal, HTTP requests 500. |
|
Package routes holds what route options configure, for the SDK core.
|
Package routes holds what route options configure, for the SDK core. |
|
Package telemetry installs OpenTelemetry through xtrace's SDK bootstrap: resource from the build identity, exporters from the standard OTEL_* environment.
|
Package telemetry installs OpenTelemetry through xtrace's SDK bootstrap: resource from the build identity, exporters from the standard OTEL_* environment. |
|
Package temporal runs the service's activities and hook calls on Temporal (design §7.2, §9).
|
Package temporal runs the service's activities and hook calls on Temporal (design §7.2, §9). |
|
temporaltest
Package temporaltest runs the SDK's Temporal tests against a dev server (BACKPLANE_TEST_TEMPORAL, e.g.
|
Package temporaltest runs the SDK's Temporal tests against a dev server (BACKPLANE_TEST_TEMPORAL, e.g. |
|
Package testlog provides loggers for tests.
|
Package testlog provides loggers for tests. |
Click to show internal directories.
Click to hide internal directories.