Skip to content

Repository files navigation

endpoint-libs

Crates.io Docs.rs CI License: MIT Security audit

endpoint-libs exists to make it fast and easy to launch MCP services — killing boilerplate, tightening security, and raising the quality of both hand-written and AI-generated code.

You describe your endpoints once in RON. endpoint-gen generates the Rust models, the docs, the MCP tool schemas, and the machine-readable description that endpoint-validator drives end-to-end tests from. This crate is the runtime that serves them.

Together they are a schema-first RPC pipeline: endpoint-gen generates, endpoint-libs serves, endpoint-validator verifies — one declarative source of truth behind all three.

  • WebSocket RPC server{method, seq, params} frames over a persistent socket, with connection/session management, push and subscription infrastructure, and typed handlers.
  • Roles and typed public errors — endpoints declare which roles may call them; handlers return a typed error enum that becomes a stable public error contract.
  • Every endpoint is an MCP tool, for free — one enable_mcp() call exposes your whole RPC surface as Model Context Protocol tools over JSON-RPC 2.0, on the same socket, with inputSchema/outputSchema generated from the endpoint definitions and tools/list filtered by the caller's roles. You write no tool definitions, no JSON Schema, and no second server. Off by default and fully additive — see MCP support.
  • Schema modelType/Field/EndpointSchema plus to_json_schema, emitting JSON Schema 2020-12; the basis for MCP tool schemas and the OpenAPI/AsyncAPI documents.
  • Transport-agnostic core (2.0) — the WebSocket backend is one implementation of a transport seam. Length-delimited framing over Unix sockets, named pipes or inherited socketpairs is a feature flag away, with no TLS or HTTP compiled in.

How it compares

What the pipeline does that the alternatives do not. "Codegen direction" is the row that matters most: everything in the OpenAPI column derives a spec from handwritten handlers, so it deletes no boilerplate.

endpoint-libs + endpoint-gen tonic tarpc jsonrpsee utoipa / aide / dropshot
Codegen direction spec → code spec → code none none code → spec
One external file drives everything yes (RON) proto no no no
Generated typed handlers yes yes via macro via macro no
Generated docs yes no no no yes
MCP tools generated yes, built in no no no via rmcp-openapi
Roles / RBAC in the schema yes no no no no
Typed public error contract yes partial no no no
Describes a WS message protocol yes (AsyncAPI) n/a n/a partial no
Emits OpenAPI / AsyncAPI yes (opt-in) no no no OpenAPI only
Transport-agnostic core yes (2.0) no (h2) yes yes no
Ecosystem maturity small (8.6k dl) 338M 8.9M 22.8M 37M (utoipa)

The last row is not a typo, and it is the honest counterweight to the rest of the table: this is a small crate. Every alternative has more users, more integrations and more answers written about it. Pick the rows that matter to you, not the count of bold cells.

Full reasoning, sources and download figures: docs/comparison.md.

When this is not the right crate

Be honest about the fit — it is a narrow one:

  • You want a REST/HTTP API. Use axum with utoipa or aide, or dropshot if you want the spec to be the contract. They are far more mature at that job.
  • You want gRPC. tonic is the answer and it is not close.
  • You want general-purpose Rust-to-Rust RPC with no config file and no browser client. tarpc is cleaner, and its Transport design is what the 2.0 seam here was modelled on.
  • You want standards-first JSON-RPC. jsonrpsee is the mature choice.

This crate earns its place only when you want one declarative source of truth driving generated types, generated docs, generated MCP tools, role gating and typed errors together — and when a WebSocket message protocol, not HTTP, is what you are actually serving. See docs/comparison.md for the full survey.

Version compatibility

Minor versions do not need to match across endpoint-libs, endpoint-gen and honey_id-types. They are separate crates on separate cadences — as of this writing endpoint-libs 2.1, endpoint-gen 1.13 and honey_id-types 2.0 interoperate in production.

What is actually enforced:

  • endpoint-gen records the endpoint-libs version it was built against and checks it at generation time against [libs] version in your config/version.toml. A mismatch fails generation with an explicit message rather than emitting subtly wrong code.

  • honey_id-types re-exports this crate's WsRequest/WsResponse traits. Bumping one without the other can put two incompatible copies of endpoint-libs in a single dependency graph; the resulting error names two different endpoint-libs paths and is otherwise baffling. The check that catches it is one line:

    grep -c 'name = "endpoint-libs"' Cargo.lock   # must be exactly 1

The release order for the whole chain is in docs/release-order.md.

Version 3 makes WireMessage payloads immutable and byte-backed so local framed transports and the WebSocket path can hand buffers to the application without cloning them. The wire format is unchanged. See docs/3.0-migration.md for the source migration.

Features

The crate is feature-gated. The default feature set is types only.

There is no tokio, on any feature

No feature of this crate pulls tokio in, and there is no interop flavour held back for a consumer that still runs one. cargo tree -e normal -i tokio prints nothing for every feature set this crate offers, including full — that is the claim worth checking, because a feature flag on its own is not one.

The history explains why this took a release rather than a feature edit. Up to and including 3.1.1 tokio was a non-optional dependency, declared as version = "1.39", features = ["full"]. No consumer could reach a clean graph whatever it selected, and no feature work on the consumer side could fix it: it was one manifest line here. 3.2.0 removes the line rather than making it optional, because every use it covered has a replacement.

What replaced what:

was tokio is now
tokio::net listener, per-shard tokio::runtime nagoya::reactor::TcpListener, one Reactor::local under block_on_with
tokio::signal::unix nagoya::signal::Signal, registered on a reactor Handle
tokio::spawn / tokio::time::sleep nagoya::runtime::background().spawn and nagoya::sleep
tokio::task::spawn_blocking a std::thread answering over a futures oneshot
tokio::sync::{RwLock, mpsc} nagoya::sync::RwLock, this crate's own ws::outbound, futures channels
tokio::select! futures::future::select plus Either, with a deliberate priority order
tokio::task_local! TOOLBOX, a thread_local restored on drop and on panic

Two dependencies went with it rather than being ported. framed-transport-tokio is deleted — see framed-transport — and so is otel, whose edge was genuinely upstream's: opentelemetry-otlp reaches tonic for the OTLP protobuf message types and tonic reaches tokio through tokio-stream. See otel is gone.

This is a breaking change to the feature surface. A consumer that relied on this crate to supply tokio's fs, process, io-std or rt-multi-thread through feature unification has to name them on its own tokio dependency. That is the point of the change, but it surfaces as a build error in someone else's crate rather than here.

types (default)

Endpoint schema types shared between services and endpoint-gen:

  • Type, Field, EnumVariant — the type system used to describe endpoint request/response schemas
  • TypeRegistry and Type::to_json_schema — conversion of endpoint schemas to JSON Schema (used for MCP tool definitions, see below)
  • Blockchain primitive types: BlockchainAddress, BlockchainTransactionHash, U256, H256

ws-core

Shared WebSocket infrastructure — WireMessage, server, session, traits, toolbox — with no backend, no TLS and no HTTP. Everything the other ws-* features build on. WsClient and WsClient::from_stream are available here too, so a sidecar speaking only a local transport does not compile a TLS/WebSocket stack it never uses. Text payloads use Utf8Bytes; binary and control payloads use bytes::Bytes. Both clone cheaply and expose borrowed string or byte slices without allocating.

agent-control

The minimal built-in local wire surface for always-on application control. It enables WireMessage, TransportStream, and length-delimited framed_json_neutral without the endpoint server, WebSocket, HTTP, TLS, scheduler, or diagnostics layers. It implies framed-transport, which is the only framing path there is. Agent-control messages use the built-in mcp_wire JSON-RPC envelopes; application-specific generated endpoints define the semantic inspect/action/lifecycle tools.

ws-client

The connecting half: WsClient::new, WsClientBuilder and the connect helpers. The handshake and the framing are nago-wss over a nagoya socket. Standalone — you can build a client without the server.

Breaking change: the constructors take a &nagoya::reactor::Handle. tokio supplied an ambient runtime, so a client built anywhere inside #[tokio::main] found a driver by itself. nagoya has no ambient anything: a descriptor is registered with one reactor when it is created, and only that reactor ever reports its readiness. A connection opened against a reactor nobody polls does not connect slowly, it never completes. Making the handle an argument is the only way that constraint is visible at the call site, and it matches what listen() does on the other side of the wire.

This feature speaks plain ws:// only. A wss:// URL is refused with a message naming ws-client-tls.

ws-client-tls

Client-side TLS for dialling an external wss://, off by default and deliberately not implied by ws-client. TLS is what drags std-bound crypto in, and the fleet's internal services are moving to plain ws:// behind a proxy that terminates it, so the common build should not compile rustls at all.

framed-transport

Length-delimited WireMessage framing over any byte stream: Unix sockets, named pipes, inherited socketpairs. No WebSocket, no TLS, no HTTP. Wire format under Transports (2.0) below, and machine-readable in the generated AsyncAPI document.

It is runtime-neutral: framed_json_neutral() over futures_io::AsyncRead/AsyncWrite. It names no runtime, and since 3.2.0 it is the only framing path.

Breaking change: framed-transport-tokio and framed_json() are deleted. The tokio flavour shared encode/decode with the neutral one, so it always put identical bytes on the wire; what it offered over framed_json_neutral was an adapter type and a dependency. A consumer holding a tokio AsyncRead + AsyncWrite bridges it on their own side and nothing on the wire changes:

use tokio_util::compat::TokioAsyncReadCompatExt;

let transport = framed_json_neutral(tokio_stream.compat());

tokio-util is that consumer's dependency now, not this crate's. agent-control implies plain framed-transport.

ws

WebSocket server. nago-wss performs the RFC 6455 upgrade over a nagoya socket; hyper, tokio-tungstenite and tokio-rustls are gone with the HTTP/2 path and the TLS listener. Includes:

  • Connection management and session tracking
  • Push/subscription infrastructure
  • Request handler and auth subcontroller traits with typed public errors
  • HTTP header parsing helpers

There is no server-side TLS. TlsListener, listen_tls and the config.insecure branch that chose between them are deleted; this server serves plain ws:// and termination belongs to the edge proxy (fly.io's [http_service] with force_https = true, forwarding plain to the app's internal port). pub_certs / priv_key left in a config are a startup error rather than a warning, because ignoring them puts plaintext on a wire an operator believes is encrypted. Dropping TLS also removes ALPN, which was the only way h2 was ever negotiated, so RFC 8441 extended CONNECT is gone rather than merely unused.

Auth endpoints registered through EndpointAuthController::add_auth_endpoint use the same typed error model as regular RequestHandler implementations. A SubAuthController declares its generated request type and endpoint-local public error type, then returns AuthResponse.

use std::sync::Arc;

use endpoint_libs::libs::error_code::ErrorCode;
use endpoint_libs::libs::handler::HandlerError;
use endpoint_libs::libs::toolbox::{ArcToolbox, CustomError, RequestContext};
use endpoint_libs::libs::ws::{AuthResponse, SubAuthController, WsConnection};
use futures::future::LocalBoxFuture;
use futures::FutureExt;

pub struct MethodSignup;

pub enum SignupError {
    UsernameTaken,
}

impl From<SignupError> for CustomError {
    fn from(err: SignupError) -> Self {
        match err {
            SignupError::UsernameTaken => {
                CustomError::new(ErrorCode::CONFLICT)
                    .with_message("username taken")
                    .with_kind("UsernameTaken")
            }
        }
    }
}

impl SubAuthController for MethodSignup {
    type Request = SignupRequest;
    type Error = SignupError;

    fn auth(
        self: Arc<Self>,
        _toolbox: &ArcToolbox,
        req: SignupRequest,
        _ctx: RequestContext,
        conn: Arc<WsConnection>,
    ) -> LocalBoxFuture<'static, AuthResponse<SignupRequest, SignupError>> {
        async move {
            let user = create_user(req).await.map_err(HandlerError::internal)?;
            conn.set_user_id(user.id);
            conn.set_roles(Arc::new(vec![user.role as u32]));
            Ok(SignupResponse { user_id: user.id })
        }
        .boxed_local()
    }
}

MCP (Model Context Protocol) support

The WebSocket server can optionally expose every registered endpoint as an MCP tool over JSON-RPC 2.0, alongside the legacy {method, seq, params} protocol. MCP is off by default and fully additive: with it disabled the server behaves exactly as before, and even with it enabled, legacy frames are routed unchanged, so both protocols work on the same connection. Set WsServerConfig::mcp_only to true to reject non-MCP frames. MCP-only mode requires enable_mcp and fails validation at startup without it.

Supported MCP methods: initialize, ping, tools/list (filtered by the connection's roles), tools/call, and notifications/*. Tool metadata (inputSchema / outputSchema) is generated from the endpoint schemas via Type::to_json_schema (model::json_schema, available under the default types feature).

use endpoint_libs::libs::ws::mcp::McpServerInfo;
use endpoint_libs::model::TypeRegistry;

let mut server = WebsocketServer::new(config);
server.set_auth_controller(MyAuthController);
server.add_handler(MethodEcho);
// ... all other add_handler() calls ...

// With endpoint-gen generated code, use the generated `type_registry()`.
// Endpoints that only use primitive types can pass an empty registry.
let registry: TypeRegistry = type_registry();
server.enable_mcp(
    &registry,
    McpServerInfo { name: "my-service".into(), version: env!("CARGO_PKG_VERSION").into() },
)?;

server.listen()

listen() blocks the calling thread and stops on SIGTERM or SIGINT, claiming both for the process while it runs, so a second server in the same process fails with EBUSY. A process that owns its own signals, or runs more than one server (a test per server, say), stops it with a future instead:

let (stop, stopped) = futures::channel::oneshot::channel::<()>();
std::thread::spawn(move || server.listen_until(async move { let _ = stopped.await; }));
// ... later
let _ = stop.send(());

Behavior notes:

  • Frame detection — a frame is treated as JSON-RPC iff it carries a top-level "jsonrpc": "2.0" member, which legacy frames can never contain.
  • Tool names — endpoint names in snake_case (UserListSymbolsuser_list_symbols).
  • Rolestools/list only shows tools the connection's roles allow; calling a forbidden tool answers identically to an unknown tool.
  • Errors — public handler errors (CustomError) become MCP tool results with isError: true; invalid params map to -32602, unknown methods to -32601, internal errors to -32603 (with logId in error.data).
  • Streaming — endpoints with a stream_response deliver only their immediate response over MCP; stream frames are not forwarded (tools are annotated accordingly in their description).
  • enable_mcp fails at startup on unresolved StructRef/EnumRef names or duplicate tool names, rather than serving broken schemas.

The runnable mcp_echo example that showed an MCP handshake and a legacy frame on one connection was deleted in 3.2.0 along with the rest of the tokio-bound examples, and nothing replaces it yet. The remaining example, ws-echo, does not call enable_mcp. tests/transport_seam.rs is the executable reference in the meantime: it drives an MCP initialize, a tools/call and a legacy frame over one connection.

Migrating an existing backend from 1.7.x? See the step-by-step guide in docs/mcp-migration.md (covers the typed-error migration, RON descriptions, codegen, activation, and verification), and pathscale/api.support.cafe#3 for a complete worked example.

Machine-readable descriptions of your API

Three of these, serving different audiences. They are parallel outputs, not a progression — nothing here deprecates anything else:

Artifact Always emitted? Audience
docs/services.json yes Internal tooling. Our own format, our own rules.
docs/<service>_mcp_tools.json yes Review — what a server reports via tools/list.
docs/asyncapi.json opt-in (--asyncapi) External consumers who want a standard.
docs/openapi.json opt-in (--openapi) OpenAPI tooling — clients, doc renderers, bridges.

services.json is the one to build internal tooling against. It is always written, it is a format we define and control, and it changes when we decide it changes — no specification committee, no version negotiation, no vocabulary that almost fits. Shape:

{ "services": [ { "name": "userApi", "id": 1,
                  "endpoints": [ { "name": "...", "code": 10000, "description": "...",
                                   "parameters": [...], "returns": [...], "errors": [...],
                                   "roles": [...], "stream_response": null } ] } ],
  "enums": [...], "structs": [...] }

Note it contains only frontend_facing endpoints, by design — it is the public-surface view. The AsyncAPI document defaults to every endpoint unless you pass --public-only.

Reach for AsyncAPI when something outside your control needs to read the protocol and a bespoke format would be friction — a third-party integrator, a code generator, a standards-shaped toolchain. Inside our own stack, services.json is less friction, and that is the right trade.

API specification documents (2.1)

model::api_document turns the endpoint model into document-scope JSON Schema, shared by every emitter so there is one implementation rather than three drifting copies:

  • SchemaComponents::collect walks a set of endpoints with one shared defs map, so every referenced struct and enum is emitted exactly once and operations share $refs.
  • relocate_refs moves #/$defs/X to wherever a given format keeps its definitions (#/components/schemas/X for both OpenAPI and AsyncAPI). Idempotent, and it only touches strings under a $ref key.
  • apply_meta carries Field.meta / EndpointSchema.meta annotations through: x- keys verbatim as specification extensions, a fixed list of JSON Schema keywords verbatim, and anything else a hard error naming the endpoint and field. A typo'd exmaple that silently vanished would be invisible until someone read the spec and believed it.

endpoint-gen uses this to emit OpenAPI 3.1 and AsyncAPI 3.0 documents, both opt-in (--openapi, --asyncapi).

The OpenAPI document is a projection for tooling, not a servable API. This transport has no URLs, so paths are synthesized as /{serviceName}/{endpoint_snake_name}. Point an HTTP client at them and nothing will answer. The AsyncAPI document is the authoritative one of the two specification documents — including the framed_json_neutral byte layout under x-framing, which is the only machine-readable copy of that format.

MCP tool schemas deliberately do not go through this path: to_mcp_input_schema and to_mcp_output_schema keep their own self-contained $defs so each tool schema stands alone, which consumers depend on. A test asserts that stays true.

ws-http1 / ws-tls12

Both are now no-op aliases for ws. HTTP/1.1 is the only thing served, so ws-http1 is what ws already is; it named hyper/http1 back when there was an HTTP/2 arm to choose against. ws-tls12 selected a rustls protocol version back when this crate terminated TLS itself, and there is no rustls in this graph to select it on. They are kept rather than removed because every backend in the fleet names one or both, and a feature that vanishes is a build error in eight repositories for no gain.

full

types + ws + signal + scheduler + log_reader + error_aggregation + log_throttling + ws-http1 + ws-tls12. otel is gone from this set because the feature is gone. Convenience only, and it does not include ws-client or the framed-transport features — prefer naming what you use.

signal

Unix signal handling (SIGTERM/SIGINT). Delivery is nagoya::signal::Signal. The process-wide flag is Shutdown: nagoya::sync::Notify plus an AtomicBool, held in CANCELLATION_TOKEN.

Breaking change: init_signals takes a &nagoya::reactor::Handle. tokio's signal() reached a process-wide driver the runtime was already turning, so the caller had nothing to say. A nagoya Signal is registered on one reactor and completes only while that reactor is being polled, so the reactor is a parameter rather than an assumption. A signal delivered while nobody polls that reactor is not lost — it stays readable on the descriptor — but nothing observes it until polling resumes.

scheduler

Task scheduling utilities:

  • Fixed-interval repeated jobs
  • AdaptiveJob — jobs whose interval can be changed at runtime via a JobTrigger handle

Ticks are nagoya::sleep plus nagoya::runtime::background().spawn. tokio-cron-scheduler is deleted: it was an entire tokio-native crate, and a 500ms tick wheel, sitting behind an interface this crate drives itself.

log_reader

Utilities for reading and parsing structured log files, including reverse-line iteration for reading recent entries efficiently.

error_aggregation

A tracing layer that captures recent error-level log events into an in-memory container, allowing them to be queried programmatically (e.g. to expose recent errors via an API endpoint).

log_throttling

Do not use. This feature is currently non-functional and is excluded from CI. It is present for future development only.

Rate-limiting layer for tracing events to suppress repeated log spam.

otel is gone

There is no OTLP export in this crate any more, and no feature that brings it back. The otel feature, the exporter in setup_logging, the OtelGuards type and the LogSetupReturn::otel_guards field are all deleted, along with all six opentelemetry crates: opentelemetry, opentelemetry_sdk, opentelemetry-otlp, opentelemetry-semantic-conventions, tracing-opentelemetry and opentelemetry-appender-tracing.

The reason is that the edge was upstream's and not removable from here. The exporter stack pulled tokio in for the protobuf message types rather than for a runtime: http-proto requires opentelemetry-proto/gen-tonic-messages, that feature is ["tonic", "tonic-prost", "prost"], and tonic 0.14 lists tokio-stream as a non-optional dependency, which in turn lists tokio. No transport or encoding choice on opentelemetry-otlp 0.31 avoids those types. That left hand-rolling an OTLP encoder or dropping the exporter, and nothing in the fleet had the feature enabled, so the exporter went.

OtelConfig remains in types, inert. It is a bool, two Option<String>s and a map, carrying no dependency of its own, and four backends name it in a LoggingConfig struct literal — deleting it would be a source break for no compile-time gain. It is also the seam to reattach an exporter to if one ever comes back on a tokio-free transport.

Being inert is the part to read carefully: setting enabled: true exports nothing. It is not ignored silently — setup_logging warns once, under the otel::setup target and naming the configured endpoint, because an operator who pointed a process at a collector is entitled to find out that nothing arrives there. But no traces and no logs are forwarded, and there is no guard to keep alive because there is nothing to flush.

Transports (2.0)

The server core is transport-agnostic. Alongside the WebSocket path (listen()), these entry points let the same handlers, roles, typed errors and MCP surface run over a Unix socket, a Windows named pipe, or macOS XPC.

// Server: one already-established connection, any transport.
server.serve_connection(peer, states, stream, /* auth token */ None).await;

// Server: accept loop over any listener.
server.serve_with(my_listener).await?;   // my_listener: SessionListener

// Client: the mirror image.
let client = WsClient::from_stream(stream);

Both sides need a MessageStream. For byte-stream transports, the framed-transport feature supplies one. It takes futures_io::AsyncRead/AsyncWrite, so a tokio stream is bridged on the caller's side with tokio-util's compat shim:

use endpoint_libs::libs::ws::transport::{TransportStream, framed_json_neutral};

let stream: Box<dyn MessageStream> =
    Box::new(TransportStream::new(framed_json_neutral(unix_stream)));

The examples/uds_echo.rs worked example was deleted in 3.2.0 with the rest of the tokio-bound examples. tests/transport_seam.rs and tests/nagoya_transport.rs are the runnable references for this path.

framed_json_neutral wire format

One length-delimited frame per message — implementable by a non-Rust peer in a few lines:

+---------------+--------+--------------------------+
| u32 BE length | u8 kind| payload (length-1 bytes) |
+---------------+--------+--------------------------+

length counts the kind byte plus payload. kind is 0=Text, 1=Binary, 2=Ping, 3=Pong, 4=Close. Text is UTF-8; Close is empty or u16 BE code + UTF-8 reason. Default max frame is 16 MiB (framed_json_neutral_with_max_frame to change it).

Peer identity and attestation

WsConnection.peer / RequestContext.peer carry a PeerIdentity: Network(SocketAddr) for TCP, or Local(LocalPeer { pid, uid, attestation }). Attestation::Verified { mechanism, subject } records code identity a transport verified — an XPC code-signing requirement, an executable digest, a SID. This crate defines the vocabulary; the platform implementations live in a sibling crate.

Hooks

BeforeRequest (may reject and may attach claims to ctx.extensions), AfterRequest (observes outcomes), OnConnect (refuses a peer once, rather than per request), and OnDisconnect (cleans up connection-owned work after the peer leaves). Request hooks run on both the legacy and MCP dispatch paths unless MCP-only mode rejects legacy frames first.

server.add_before_hook(MyMissionTokenCheck);
server.add_on_connect_hook(RefuseUnattestedPeers);
server.add_on_disconnect_hook(CleanUpConnectionWork);

Note: MessageStream's futures are not Send, so serve_connection, serve_with and a from_stream client must be polled on the thread that owns the stream. There is no LocalSet anywhere in this crate any more — the last one existed because the hyper upgrader spawn_localed onto TokioExecutor, and the upgrade is nago-wss's now. Any single-threaded executor satisfies the requirement; nagoya::reactor::TaskSet under block_on_with is the one this crate reaches for, and a bare nagoya::block_on does for a single connection.

Logging Setup

The setup_logging function (available without any optional features) provides a batteries-included tracing subscriber with:

  • Stdout logging with thread names and line numbers
  • Optional file logging with configurable rotation
  • Runtime log level reloading via LogReloadHandle
  • Optional error_aggregation layer (requires error_aggregation feature)

OpenTelemetry (OTel) — removed

This crate no longer forwards anything to an OTLP collector. The exporter, its tracing layer, the OtelGuards type and the setup.otel_guards field are gone, as is the otel feature that turned them on. Why, and what it cost, is in otel is gone. The OTEL_* environment variables this section used to document are read by nothing here.

OtelConfig survives as an inert struct in types, so an existing LoggingConfig literal still compiles unchanged:

use std::collections::HashMap;
use endpoint_libs::libs::log::{LogLevel, LoggingConfig, OtelConfig};

let config = LoggingConfig {
    level: LogLevel::Info,
    file_config: None,
    // Compiles, and forwards nothing. `enabled: true` logs one warning at setup
    // naming this endpoint, and no trace or log reaches a collector.
    otel_config: OtelConfig {
        enabled: true,
        service_name: Some("my-service".into()),
        endpoint: Some("http://localhost:4317".into()),
        headers: HashMap::new(),
    },
};

let setup = setup_logging(config)?;
// There is no `setup.otel_guards` to keep alive: nothing buffers, so nothing flushes.

A service that needs distributed tracing exports it from its own crate, or reattaches an exporter to OtelConfig, which is kept partly to be that seam.

Config Loading

A load_config utility parses a JSON config file, defaulting to etc/config.json or overridden via --config/CONFIG env var. Supports an optional --config-entry for selecting a sub-key within the config object.


Releasing

Put the Cargo.toml version bump in a pull request. After merge, the Rust workflow waits for tests, clippy, formatting, and the security audit, then runs cargo publish when the package version changed in that master update. The workflow uses the repository's CARGO_REGISTRY_TOKEN secret.

To verify the package locally without publishing:

cargo publish --dry-run

About

endpoint gen libs dependency and common files

Resources

Stars

2 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages