Skip to navigation
ReferenceAPIsRust Library Referencenemo-relay-plugin

Module diagnostics

View as Markdown

Generated from cargo doc --no-deps -p nemo-relay -p nemo-relay-adaptive -p nemo-relay-pii-redaction -p nemo-relay-ffi -p nemo-relay-types -p nemo-relay-plugin -p nemo-relay-worker-proto -p nemo-relay-worker.

Native diagnostic authoring and authorized reads. Native diagnostic authoring and explicitly authorized canonical reads. Recording is synchronous, state-only, and independent of operational logs. Disabled/unsupported facades skip factories. Diagnostic errors must not be propagated as plugin execution failures unless the application chooses so.

Modules

  • abi: Append-only native diagnostic ABI. All input spans are borrowed for one call. Nonempty spans and output pointers must be valid for their stated size; arrays must be aligned. No callback retains plugin memory. Integer tags are validated.

Structs

  • Classification: Shared classification payload for producers, projections, and decoded evidence.
  • ClassificationError: A cause is missing, forbidden, or unsupported by the selected catalogue code.
  • ComponentDeclaration: Borrowed component declaration evaluated only when collection is available.
  • DeliveryStats: Local delivery totals, not core observation or retention totals.
  • DiagnosticComponent: Shared producer registration. Last drop closes it; explicit close fences clones.
  • DiagnosticCorrelation: Optional caller correlation identifiers, excluded from aggregation keys.
  • DiagnosticCount: Magnitude of an occurrence or loss counter, including overflow visibility.
  • DiagnosticDiscovery: Side-effect-free discovery, available even when snapshot queries are disabled.
  • DiagnosticMemoryPage: Bounded independent memory view; inspection neither records nor freezes history.
  • DiagnosticQuery: Portable bounded selection; consumers never reset or mutate evidence.
  • DiagnosticReader: Authorized read facade; each call independently checks live host authority.
  • DiagnosticSnapshot: Read evidence from one source incarnation, using the canonical snapshot schema.
  • Diagnostics: Cloneable activation-scoped diagnostic facade. It does not start a service. Clones share four concurrent-call slots and one in-flight read-buffer slot. Same-thread recursion into the same activation returns DiagnosticError::Busy.
  • Observation: Typed observation with borrowed detail and shared caller correlation.
  • RecordReceipt: Accepted lifetime and current-summary update.

Enums

  • BuiltinDiagnosticCode: Fixed-size canonical authoring value with one authoritative hierarchy.
  • CommonPluginFailureCode: Plugin failures supported by phase-one activation recording.
  • DiagnosticAvailability: Availability of evidence, without applying deployment or application health.
  • DiagnosticCode: One declared code. Extension namespace and component ownership are host-assigned.
  • DiagnosticError: Diagnostic operation error. These values never classify plugin execution.
  • DiagnosticOutcome: Observed operation outcome; severity does not imply this value.
  • DiagnosticReadReason: Stable reasons shared by canonical snapshot adapters. These are operation results, never a source health classification or a producer failure code. Include a fallback arm when matching: future releases can add reasons.
  • DiagnosticSeverity: Severity of evidence, independent of an operation’s outcome.
  • EvidenceDisposition: Evidence retention is independent of numeric acceptance.
  • FailureClass: Supported general cause, independent of health, retries, and operation outcome.
  • FailureCode: Failure event hierarchy for integrated producers.
  • PluginFailureCode: Plugin failure hierarchy for integrated producers.
  • RecordOutcome: Accepted collection or intentional disablement.

Traits

  • DiagnosticClassifier: Pure producer behavior: borrow original evidence and return shared classification metadata.