Skip to content

docs: document Event metadata injection - #801

Draft
ericevans-nv wants to merge 1 commit into
NVIDIA:mainfrom
ericevans-nv:docs/event-metadata-injection
Draft

docs: document Event metadata injection#801
ericevans-nv wants to merge 1 commit into
NVIDIA:mainfrom
ericevans-nv:docs/event-metadata-injection

Conversation

@ericevans-nv

Copy link
Copy Markdown
Contributor

Overview

Documents the Event metadata injection middleware introduced in PR #800. The updated middleware guide explains how injectors are registered, when they run, what metadata they may add, and how failures and duplicate keys are handled.

  • I confirm this contribution is my own work, or I have the right to submit it under this project's license.
  • I searched existing issues and open pull requests, and this does not duplicate existing work.

Details

This PR updates the middleware guide to cover:

  • Global, scope-local, and native-plugin injector registration.
  • Immutable Event context and insert-only metadata additions.
  • Supported key and value formats.
  • Deterministic priority and registration-name ordering.
  • Callback error, panic, and invalid-output behavior.
  • Processing order between internal transforms, metadata injection, sanitization, and subscriber delivery.
  • Updated publication-flow descriptions and Mermaid diagrams.

This documentation depends on the Event metadata injection implementation in PR #800 and should merge after that implementation.

The full just docs build is currently unavailable because uv is missing from PATH. The commit-time Markdown link check will still run.

Where should the reviewer start?

Start with the Event Metadata Injection and Queued Event Publication sections in docs/about-nemo-relay/concepts/middleware.mdx.

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

Signed-off-by: Eric Evans <194135482+ericevans-nv@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Aug 18, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: ea91f177-208b-4ede-b37d-bb5809ab343e

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added size:M PR is medium Documentation documentation-related labels Aug 18, 2026
@github-actions

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation documentation-related size:M PR is medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant