Evidence Is Not A Commitment
Health, metrics, audit, logs, diagnostics, and support bundles show bounded signals. They do not create support, availability, privacy, or retention promises.
Operations guide
Verification RequiredObservability and audit guide.
Cross-product routing for health, metrics, audit, logs, diagnostics, support bundle evidence, and privacy-safe handoff. Product runbooks remain the source of truth for exact commands, expected output, remediation, and limits.
Guide Snapshot
- Products
- 4
- Signal families
- 6
- Runbook links
- 7
- Review state
- Routed
Signal Map
| Product | Health | Metrics | Audit | Logs and diagnostics | Runbook |
|---|---|---|---|---|---|
| ObjectDB | GET /health plus /v1/platform/capabilities for startup probe evidence. | No dedicated metrics surface is documented in the current runbook; use response headers, capability JSON, and S3 Core smoke evidence. | No live audit route is documented; preserve S3 operation headers, error XML, request ID, and route shape. | Service terminal output, platform capability JSON, S3 response headers, XML errors, and data-directory checks. | ObjectDB operator runbooks |
| Message Broker | Public GET /health reports readiness, storage, release metadata, and auth mode. | GET /metrics is available only when HTTP metrics exposure is enabled. | /v1/audit/events and /v1/audit/export are administrator-only and tenant-filtered in protected modes. | mq diagnostics collect, remote diagnostics reads, storage inspection routes, metrics output, audit export, and replication status. | Message Broker operator runbooks |
| LogDB | GET /health confirms the local process and bind address. | Metrics and profiles are outside the documented LogDB route surface; use OTLP admission, query metadata, segment, WAL, and BYOC preflight evidence instead. | Replay and audit foundations are preview-bound; do not present them as public audit APIs. | OTLP admission response, query response shape, WAL/data-directory context, segment bundle metadata, S3 query-read config, and BYOC preflight. | LogDB operator runbooks |
| Concordia | Cache, TSDB, Gateway, Storage validation, and active compatibility checks use local health or validation-script output. | TSDB samples are product data, not service metrics; Gateway readiness blockers and script output are diagnostic signals only. | No current cross-product audit surface is documented; capture command, status, reason code, blockers, fixture, and protocol evidence. | Validation scripts, readiness blockers, Storage boundary output, active service logs, protocol fixtures, and docs claim scan. | Concordia validation runbooks |
First Response Flow
- Identify ScopeName the product, environment, route or script, maturity label, and customer-visible symptom.
- Capture FirstSave read-only evidence before restart, cleanup, queue mutation, data-directory deletion, WAL repair, fixture change, or config mutation.
- Classify SignalMark the signal as health, metrics, audit, log, diagnostic, config, data-shape, or reviewer evidence.
- Link RunbookUse the product runbook that owns exact commands, expected output, and the nearby limits.
- Redact PackageMinimize payloads, credentials, customer identifiers, private topology, and secrets before sharing.
- Escalate With EvidenceSend the runbook link, captured evidence, limits, and required sensitive reviewers together.
Health Guidance
| Product | First check | Capture | Do not infer |
|---|---|---|---|
| ObjectDB | GET /health and /v1/platform/capabilities. | Status, headers, endpoint value, capability fields, data-directory posture, and service terminal state. | Do not infer durability, recovery, availability, performance, support, security, scale, or customer deployment readiness. |
| Message Broker | GET /health on the selected node. | Status, node id, storage status, auth mode, release metadata, endpoint, and timestamp. | Do not infer cross-site replication outcome, failover, queue recovery, support coverage, or customer topology readiness. |
| LogDB | GET /health and the configured LOGDB_BIND_ADDRESS. | Status, bind address, service terminal state, data directory, WAL mode, and query-read store. | Do not infer S3 publication, BYOC deployment readiness, support posture, external sink behavior, metrics, profiles, or GA scope. |
| Concordia | Product-specific health route or validation script output. | Bind values, readiness blockers, status, reason code, local token mode, fixture path, script name, and commit SHA. | Do not infer production identity, distributed routing, shared storage, quorum behavior, visible reads, replication, release readiness, or GA readiness. |
Metrics Guidance
| Product | Current posture | Use instead when absent | Review boundary |
|---|---|---|---|
| ObjectDB | No dedicated metrics endpoint is documented in DOCS-050. | Health, platform capabilities, S3 operation headers, request status, and data-directory evidence. | Do not invent dashboard, scrape, performance, capacity, or alert wording from local smoke output. |
| Message Broker | GET /metrics when HTTP metrics exposure is enabled. | Metrics route status, startup flag, response body header, and exporter configuration. | Tenant and stream labels need security and operations acceptance before stronger wording. |
| LogDB | Metrics and profiles are unsupported in the current compatibility matrix. | OTLP admission status, query metadata, segment counts, WAL evidence, and S3 query-read config. | Do not claim metrics or profiles ingest from logs/traces route evidence. |
| Concordia | Gateway readiness blockers and validation script summaries. | TSDB health, active service status, Storage boundary output, and the exact script command. | Keep diagnostic output local-alpha or preview-contract until product reviewers accept stronger evidence. |
Audit Guidance
| Product | Current audit signal | Capture | Redact or avoid |
|---|---|---|---|
| ObjectDB | S3-shaped route evidence and response headers. | Request method, path shape, status, operation header, request ID, and known-limits link. | Redact access keys, bearer tokens, payload bodies, sensitive object keys, tenant identifiers, and customer data. |
| Message Broker | /v1/audit/events or /v1/audit/export where auth permits. | Route, query params, auth mode, status, event count, content type, and payload-free line sample. | Redact API keys, bearer tokens, trusted headers, payloads, personal data, tenant IDs, customer stream names, and private topology. |
| LogDB | Tenant admission and query evidence; replay and audit foundations stay preview-bound. | Tenant admission result, query shape, matched count, scanned bundle count, used indexes, and preview-bound audit notes. | Redact raw telemetry, customer dataset names, sensitive record IDs, identifying trace/span IDs, account IDs, bucket names, KMS ARNs, and IAM role ARNs. |
| Concordia | Validation scripts and route reason codes provide bounded evidence. | Script name, status, reason code, blockers, fixture name, protocol result, and reviewer owner. | Redact bearer tokens, tenant IDs, dataset IDs, keys, values, personal data, customer topology, private hostnames, and future-frame claims. |
Privacy-Safe Support Practices
| Practice | Required action | Evidence owner |
|---|---|---|
| Capture Before Mutation | Save health, metrics, audit, logs, diagnostics, config, and route output before restarting, deleting, retrying with different flags, or cleaning local state. | Operations reviewer |
| Minimize Payloads | Prefer status, headers, counts, IDs, schemas, route names, and shape-only samples over raw object bodies, stream payloads, telemetry payloads, cache values, or protocol frames. | Privacy reviewer |
| Redact Credentials | Remove API keys, bearer tokens, mTLS material, access keys, private keys, trusted identity headers, AWS credentials, and shell history with secrets. | Security reviewer |
| Redact Customer Identifiers | Remove tenant identifiers, dataset names, stream names, bucket names, object keys, record IDs, trace/span IDs, private hostnames, account IDs, ARNs, and proprietary topology when sensitive. | Support reviewer |
| Keep Limits With Evidence | Include the maturity label, runbook link, compatibility or limits page, and what the evidence does not prove. | Docs QA reviewer |
| Route Sensitive Review | Use DOCS-007 and DOCS-011 for support, telemetry, logs, traces, customer data, retention, redaction, operational safety, and handoff wording. | Docs lead |
Support Bundle Shape
| Bundle section | Include | Exclude or redact |
|---|---|---|
| Case summary | Product, environment, route or script, maturity label, symptom, impact scope, timestamp, and first failing status or reason code. | Customer names, account details, private topology, and unsupported promises. |
| Health | Health route response, bind address, selected node or service, release metadata where available, and readiness blockers. | Tokens, unrelated headers, customer hostnames, and full environment dumps. |
| Metrics | Scrape status, metric-family availability, disabled response, startup metrics flag, and selected product runbook. | Tenant labels, stream names, customer dimensions, and unreviewed dashboard screenshots. |
| Audit | Route, query parameters, auth mode, event count, content type, redacted sample, and tenant-filter note. | Credentials, payloads, personal data, tenant IDs, stream names, and private topology. |
| Logs and diagnostics | Service terminal tail, diagnostics bundle summary, storage or WAL state, segment counts, protocol fixture name, and command exit code. | Raw payloads, secrets, private keys, unrelated directory listings, full customer traces, and destructive cleanup commands. |
| Config | Product-specific bind address, data directory, storage mode, query-read store, auth mode, and validation flags needed to reproduce the symptom. | Shared-state paths when unnecessary, shell history, cloud credentials, account IDs, ARNs, bucket names, and customer-specific namespaces. |
| Evidence links | Product runbook, reference page, compatibility row, limits page, evidence index row, and reviewer owner. | Roadmap promises, stronger maturity wording, and claims outside the linked evidence. |
Product Escalation Links
| Product | Start here | Reference | Limits |
|---|---|---|---|
| ObjectDB | ObjectDB operator runbooks | ObjectDB reference | ObjectDB limits |
| Message Broker | Message Broker operator runbooks | Message Broker reference | Message Broker limits |
| LogDB | LogDB operator runbooks | LogDB reference | LogDB limits |
| Concordia | Concordia validation runbooks | Concordia reference | Concordia limits |
Guide Guardrails
Payloads Are Last Resort
Prefer shape, status, count, route, header, reason-code, and reviewer evidence before including raw customer payloads or traces.
Runbooks Own Commands
This guide routes responders to the right product page; exact commands and expected outputs stay in product-specific runbooks.
Evidence
| Guide area | Evidence | Status |
|---|---|---|
| Runbook template and support handoff standard | DOCS-049 and /operations/runbook-template/ | pending |
| ObjectDB health, platform, S3 Core, data-directory, and support evidence | DOCS-050 and /products/objectdb/operations/operator-runbooks/ | pending |
| Message Broker health, metrics, audit, diagnostics, storage, quota, replication, and support evidence | DOCS-051 and /products/message-broker/operations/operator-runbooks/ | pending |
| LogDB health, OTLP, WAL, segment, S3 query-read, BYOC, and support evidence | DOCS-052 and /products/logdb/operations/operator-runbooks/ | pending |
| Concordia health, validation scripts, Gateway, TSDB, Storage, active compatibility, and protocol evidence | DOCS-053 and /products/concordia/operations/validation-runbooks/ | pending |
| Sensitive review and privacy-safe handoff routing | DOCS-007 and DOCS-011 | pending |
Limits
- This guide is an operations evidence router; it does not replace product-specific runbooks, references, compatibility matrices, known-limits pages, or reviewer decisions.
- Do not use this guide to claim centralized monitoring, dashboarding, alerting, incident response coverage, support response expectations, retention policy, audit completeness, data handling approval, security controls, compliance status, availability, performance, scale, or customer commitments.
- Do not share support evidence until the package is minimized, redacted, scoped to the issue, and linked to the relevant runbook and limits.
- Support bundle and privacy wording stays review-bound by DOCS-056.
Safe Next Steps
Available: DOCS-049
Use the runbook templateApply the standard evidence-capture, escalation, review, and limits shape when drafting new runbooks.
Available: DOCS-050
Use ObjectDB operator runbooksFollow health, platform capabilities, S3 Core smoke, data-directory, unsupported behavior, and support evidence checks.
Available: DOCS-051
Use Message Broker operator runbooksFollow health, metrics, audit, diagnostics, storage inspection, quota, replication status, and support evidence checks.
Available: DOCS-052
Use LogDB operator runbooksFollow OTLP admission, WAL, segment, query, S3 query-read, BYOC preflight, and support evidence checks.
Available: DOCS-053
Use Concordia validation runbooksFollow Cache, Gateway, Storage, TSDB, active compatibility, protocol fixture, script, and evidence handoff checks.
Available: DOCS-055
Use troubleshooting indexFind symptom-oriented first checks across ObjectDB, Message Broker, LogDB, Concordia, and support handoff.
Available: DOCS-056
Use support bundle and privacy pageApply support bundle contents, exclusions, redaction expectations, approval triggers, and privacy review boundaries.
Available: DOCS-062
Review community support snapshotUse the illustrative cross-product architecture example when adapting support evidence routing across products.
