pkg/

directory
v0.6.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 20, 2026 License: MIT

Directories

Path Synopsis
Package backplane is the Go SDK.
Package backplane is the Go SDK.
activity
Package activity declares operations a service implements ("умею"): the targets of bindings and rules.
Package activity declares operations a service implements ("умею"): the targets of bindings and rules.
api
Package api describes the APIs a service serves, independently of deployment.
Package api describes the APIs a service serves, independently of deployment.
backplanetest
Package backplanetest runs components without Open, Run, ports or Consul: build them under Root, Start, and inspect what they published, answer their hooks, invoke their activities and reactors, and check their readiness.
Package backplanetest runs components without Open, Run, ports or Consul: build them under Root, Start, and inspect what they published, answer their hooks, invoke their activities and reactors, and check their readiness.
build
Package build carries what the deployment stamps into the binary at link time.
Package build carries what the deployment stamps into the binary at link time.
config
Package config loads a service's configuration: one struct, schema from the Go type (schemapb), layers merged by xconf:
Package config loads a service's configuration: one struct, schema from the Go type (schemapb), layers merged by xconf:
deps
Package deps is how a service is composed: a tree of components, dependencies and singletons built explicitly by the author's constructor.
Package deps is how a service is composed: a tree of components, dependencies and singletons built explicitly by the author's constructor.
drivers/consul
Package consul installs optional discovery and live configuration.
Package consul installs optional discovery and live configuration.
drivers/nats
Package nats installs the optional nats transport.
Package nats installs the optional nats transport.
drivers/standard
Package standard composes the standard platform drivers.
Package standard composes the standard platform drivers.
drivers/temporal
Package temporal installs the optional temporal transport.
Package temporal installs the optional temporal transport.
event
Package event declares the events a service publishes and the reactors it runs.
Package event declares the events a service publishes and the reactors it runs.
hook
Package hook declares operations a service calls without implementing them ("нужно").
Package hook declares operations a service calls without implementing them ("нужно").
infra/nats
Package nats is a NATS connection as a dependency: a configuration section, a connection that never gives up (reconnecting with jitter, no buffering while disconnected, transitions logged), a status probe.
Package nats is a NATS connection as a dependency: a configuration section, a connection that never gives up (reconnecting with jitter, no buffering while disconnected, transitions logged), a status probe.
infra/postgres
Package postgres is a PostgreSQL connection as a dependency: a configuration section, a pgx pool traced and measured through the service's OpenTelemetry providers, a query log, pgtx transactions, an optional schema and sqld migrations applied at start, a ping probe.
Package postgres is a PostgreSQL connection as a dependency: a configuration section, a pgx pool traced and measured through the service's OpenTelemetry providers, a query log, pgtx transactions, an optional schema and sqld migrations applied at start, a ping probe.
infra/temporal
Package temporal is a Temporal client as a dependency: a configuration section, a client traced and measured through the service's OpenTelemetry providers and logging through its logger, a health probe.
Package temporal is a Temporal client as a dependency: a configuration section, a client traced and measured through the service's OpenTelemetry providers and logging through its logger, a health probe.
infra/valkey
Package valkey is a Valkey (Redis protocol) connection as a dependency: a configuration section, a client instrumented with the service's OpenTelemetry providers, a PING probe and a close.
Package valkey is a Valkey (Redis protocol) connection as a dependency: a configuration section, a client instrumented with the service's OpenTelemetry providers, a PING probe and a close.
internal/apifiles
Package apifiles snapshots API files for content-addressed delivery.
Package apifiles snapshots API files for content-addressed delivery.
internal/backoff
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).
internal/broker
Package broker carries events over NATS JetStream (design §8).
Package broker carries events over NATS JetStream (design §8).
internal/configrt
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.
internal/consul
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.
internal/decl
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.
internal/direct
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.
internal/env
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.
internal/exception
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.
internal/gate
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.
internal/guard
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.
internal/health
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.
internal/link
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.
internal/listener
Package listener serves gRPC and HTTP on one address through cmux.
Package listener serves gRPC and HTTP on one address through cmux.
internal/manifest
Package manifest collects a service's declarations into a backplanev1.Manifest.
Package manifest collects a service's declarations into a backplanev1.Manifest.
internal/metrics
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.
internal/node
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.
internal/recovery
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.
internal/routes
Package routes holds what route options configure, for the SDK core.
Package routes holds what route options configure, for the SDK core.
internal/telemetry
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.
internal/temporal
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).
internal/temporal/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.
internal/testlog
Package testlog provides loggers for tests.
Package testlog provides loggers for tests.
workflows
Package workflows gives a service its own Temporal workflows (design §9): the SDK owns the connection and the worker on the service's task queue (= its name); the author registers on it and uses the client.
Package workflows gives a service its own Temporal workflows (design §9): the SDK owns the connection and the worker on the service's task queue (= its name); the author registers on it and uses the client.
wsproto
Package wsproto serves gRPC services over ws-proto (protobuf RPC over WebSocket) as a managed public api.
Package wsproto serves gRPC services over ws-proto (protobuf RPC over WebSocket) as a managed public api.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL