Skip to main content
This page covers two things: the runtime metrics every Bot exposes (part of @botmesh/core) and the optional operational packages (event journal, inbox, CRM, campaigns…). To send one message to many chats or start a flow from a job, see Broadcasts and Starting a flow programmatically. To survive crashes without losing or duplicating messages (durable inbox/outbox, retries, dead-letter queue), see Durable message processing. For health checks and the production checklist, see Deployment and Going to production.

​
Runtime metrics

bot.metrics() returns an in-process snapshot of counters only the engine knows. It is plain JSON and nothing is persisted: counters are monotonic since the bot was constructed, or since bot.resetMetrics() (which zeroes them and keeps the uptime).
  • messages.in counts inbound messages and interactions accepted after the access lists and dedupe. out / outFailed count the sends the provider accepted or rejected.
  • dropped.duplicate counts redeliveries dropped by inbound dedupe, blocked the messages, interactions and calls dropped by the blacklist / whitelist (every delivery, since blocked input is never recorded by dedupe), and handoff the messages not routed because the chat is handed off to a human. echo (present only with echoFilter on) counts the echoes of the bot’s own sends that the filter dropped.
  • presenceSkipped.typing / markRead count the presence hints (ctx.typing(), ctx.recording(), the automatic typing indicator, ctx.markRead()) skipped because the transport was disconnected or stopped (best-effort, see Channels).
  • flows is keyed by conversation/flow name. avgDurationMs is the mean duration of the conversations that already ended (0 when none did).
  • A flow that returns and a goto count as completed; c.end() counts as ended; a failed .guard() (farewell or redirect) counts as guarded; /cancel, /reset, a replacement or bot.stop() count as cancelled.

​
Prometheus

toPrometheus(snapshot, { prefix?, labels? }) renders a snapshot in the Prometheus text format (0.0.4), with no dependencies. Serve it with PROMETHEUS_CONTENT_TYPE:
The default prefix is botmesh_ (prefix: 'botwa_' keeps the names of the alpha releases). Families: uptime_seconds, conversations_active, conversations_started_total, conversations_ended_total{outcome} (completed / ended / guarded / cancelled / timed_out / retries_exceeded / error), conversation_duration_avg_seconds, flow_started_total{flow}, flow_ended_total{flow,outcome}, flow_duration_avg_seconds{flow}, messages_in_total, messages_out_total{result} (sent / failed), inbound_dropped_total{reason} (duplicate / blocked / handoff, plus echo with echoFilter), presence_skipped_total{kind} (typing / mark_read), triggers_total and errors_total. An invalid prefix or label name throws TypeError.

​
Conversation events

  • conversation:started fires whenever a flow or bot.conversation is entered: a trigger match, bot.trigger(), a dormant resume or a c.goto().
  • conversation:ended adds outcome ('completed' | 'ended' | 'guarded' | 'cancelled' | 'timedOut' | 'retriesExceeded' | 'error'), completed (shorthand for outcome === 'completed'), durationMs and, when it ended with a goto, the target in goto (a new started follows).
  • id is unique per conversation instance, so it pairs an ended with its started. key is the runtime key (chatId, or chatId:userId for a group participant). When a conversation is replaced, its ended (outcome: 'cancelled') is emitted before the new one’s started.
  • A listener that throws is reported on bot.on('error'); it never breaks the conversation.

​
Operational packages

@botmesh/events is published on npm (pnpm add @botmesh/events).
Product packages — not publishedThe product packages (@botmesh/inbox, @botmesh/crm, @botmesh/hub, @botmesh/campaigns and @botmesh/deployments) are real and persistent: each has a storage contract, an in-RAM reference store and a Kv* adapter over any DurableKv of the core (SQLite, PostgreSQL, Redis, Redis Cluster or a file), with a shared conformance suite and opt-in real-server suites. They live only in the repository, and their APIs may still change.
The operational packages are transport-neutral and scoped by tenant.

​
Event processing

Use MemoryEventJournal in tests. FileEventJournal.open('./data/events.json') persists a single-process journal with atomic snapshots, idempotency, leases, retries and replay. For several processes on one host, SharedFileEventJournal.open(path) shares one file under a cross-process mutex; across hosts, implement LeasedEventJournal over PostgreSQL, Redis or a broker. The file journals store JSON: an envelope with a BigInt or a circular reference is rejected with a TypeError (nothing is stored), and a Date reads back as its ISO string. A record that would not read back as a valid one (a missing partitionKey, a NaN or Date occurredAt, a toJSON that changes the event id) is rejected the same way, in every journal, so nothing a journal accepts can stop it from reopening. Every SharedFileEventJournal operation takes the mutex and re-reads the file (milliseconds on Linux, tens of milliseconds on Windows), so keep it for modest volumes. EventWorker claims events, invokes the handler, acknowledges successful work and moves exhausted retries to the dead-letter state. Every claim hands out a fencing token (record.fencingToken, strictly increasing per event and never reused, not even after replay). The worker passes it back to ack/fail, and the journal rejects a superseded token with StaleLeaseError: a worker whose lease expired while its handler was still running cannot complete, retry or dead-letter an event another worker has re-claimed. runBatch() reports those as stale ({ processed, failed, stale }), and it skips a record whose lease already ran out before its handler started, handing it back with journal.release(eventId, { now, fencingToken }) so the skip does not use up an attempt. Handlers still run at least once, so keep them idempotent (the envelope’s idempotencyKey is there for that). new EventWorker(journal, { leaseMs, clock }) sets the lease length and the time source. An EventJournal adapter for PostgreSQL or Redis must check the token (in ack, fail and release) in the same atomic update that changes the state. The same journal can also be a bot’s durability backend (eventsDurability({ journal }) from @botmesh/events/durability, see Durable message processing). The bot’s inbound records are written on their own channel ('botwa:durable'). list() and replay() show them, but an EventWorker never claims them: a claim without a channel only takes records that have none. The bot processes them itself.

​
Inbox and CRM

@botmesh/inbox provides optimistic-concurrency assignment (a compare-and-set on version), handoff, notes and unread state. Project ledger StoredMessage entries with inbox.projectMessage(message) so conversations can be rebuilt across channels; attachInbox(bot, inbox) does it for a running bot, inbound messages and accepted sends alike, without delaying either; a projection failure goes to the bot’s 'error' event ({ error }) or, with nobody listening, to the bot logger. Without a tenantId option the conversations go under the bot’s own tenant (BotConfig.tenantId). Persist with new Inbox(new KvInboxStore(kv)). Notes are paged with listNotes(tenant, conversation, { limit, after }) (after = the last note id of the previous page), and inbox.erase(tenant, conversation) deletes a conversation with its notes (right to erasure; erase the messages in the bot store too). @botmesh/crm stores contact channels, tags, attributes and marketing consent, with rule-based segments (tagsAll, attributes compared strictly, consent). ContactDirectory is async over MemoryContactStore or KvContactStore; setConsent retries concurrent writers instead of overwriting them, and erase(tenant, id) deletes a contact (right to erasure). Always segment campaigns using tenant-scoped data and consent.

​
Campaigns, plugins and deployments

@botmesh/campaigns skips opt-outs, mismatched segments and duplicate recipients. The store reserves one send slot per (tenant, campaign, recipient) with a TTL; markSent counts the send and markFailed releases the slot. sendCampaign(bot, planner, …) sends with bot.broadcast() and settles each delivery from the real result (accepted, failed, skipped by a hook or cancelled), matched by the target chat even when the provider answers with a canonical id; if the broadcast itself rejects, every reserved slot is released. @botmesh/hub validates plugin manifests, runtime compatibility and granted permissions before enabling a plugin. Manifests are treated as untrusted JSON (every field is type-checked and unknown permissions are rejected), and enabling re-checks the grants atomically, so a concurrent re-install with more permissions is never enabled without them. Installs and enable/disable are persisted per tenant; it does not execute or sandbox untrusted code by itself. @botmesh/deployments tracks immutable versions and one active deployment per tenant/bot, with reservations for running gates and an audit log of gate runs. list(tenant, bot, { limit, after }) pages the versions, prune(tenant, bot, keep) deletes the ones older than the newest keep (never the active one), and new DeploymentRegistry(store, { retainVersions }) prunes after every publish so the version list stays bounded. Connect it to your deployment system for gradual rollout and physical rollback. All five share the same storage model: Memory…Store (reference), Kv…Store over any DurableKv, a conformance suite in test-utils/, and tenant isolation enforced by the backend table name (@botmesh/tenant-kv). Every write is validated before it reaches the backend (a malformed field fails with a TypeError naming it), so one bad write can never make a tenant’s listings unreadable.

​
Tracing (OpenTelemetry)

bot.metrics() counts; traces explain. With BotConfig.telemetry the bot emits a span tree per message (inbound → dispatch → handler / conversation turn → AI model and tool calls → send), with ids hashed by default and no message content. @botmesh/otel sends those spans to OpenTelemetry (Jaeger, Grafana Tempo, any OTLP backend) and publishes bot.metrics() as OpenTelemetry metrics (bot.plug(otelMetricsPlugin())). Setup, span catalogue, personal-data policy and a Jaeger / Grafana Tempo example: Tracing.