Skip to content

MTA-7134-LLM-Proxy-Transaction-Logging-Schema-Audit-Trail-Integration#379

Open
anarnold97 wants to merge 1 commit into
migtools:mainfrom
anarnold97:MTA-7134-LLM-Proxy-Transaction-Logging-Schema-Audit-Trail-Integration
Open

MTA-7134-LLM-Proxy-Transaction-Logging-Schema-Audit-Trail-Integration#379
anarnold97 wants to merge 1 commit into
migtools:mainfrom
anarnold97:MTA-7134-LLM-Proxy-Transaction-Logging-Schema-Audit-Trail-Integration

Conversation

@anarnold97

@anarnold97 anarnold97 commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

JIRA


PREVIEW


DESCRIPTION

Add documentation for LLM proxy interaction monitoring in the Developer Lightspeed guide (MTA-7134).

New content — proc_auditing-llm-proxy-transactions.adoc:

  • Request and data handling — documents how the proxy (built on llama-stack, running as a pod in the MTA namespace) handles credential isolation (API keys stored in a Kubernetes secret), JWT-based authentication via Keycloak/JWKS, header redaction, and data persistence in two PostgreSQL tables (llm_proxy_inference_store, llm_proxy_conversations)

  • Accessing proxy logs — step-by-step oc logs procedure for streaming current proxy pod output and retrieving logs from a previous (terminated) pod, with example output

  • Planned capabilities — documents future structured per-request audit logging, anonymized user-to-request correlation, and SIEM forwarding (Splunk/Elasticsearch via OpenShift Logging Operator) that are not yet in the current release

The new module is included at the end of docs/developer-lightspeed-guide/master.adoc, after the existing logs concept.


@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@anarnold97, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 16 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f19b9701-b855-4ac5-b1a7-002bf50313b6

📥 Commits

Reviewing files that changed from the base of the PR and between 63ad26a and 3731a39.

📒 Files selected for processing (2)
  • docs/developer-lightspeed-guide/master.adoc
  • docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc
📝 Walkthrough

Walkthrough

This PR adds a new documentation page describing how to audit and monitor LLM proxy interactions in the MTA Developer Lightspeed setup, covering log access via oc logs, the transaction log JSON schema, and SIEM/log aggregator forwarding configuration. The master guide is updated to include this new topic.

Changes

LLM Proxy Auditing Documentation

Layer / File(s) Summary
Overview and log access instructions
docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc
Introduces the auditing topic, clarifies what is/isn't logged, and documents prerequisites and commands to stream or retrieve current/previous proxy pod logs.
Transaction log schema documentation
docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc
Provides an example JSON log event and a field-by-field description table, with a note on token count limitations.
SIEM/log aggregator forwarding configuration
docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc
Documents ClusterLogForwarder setup for Splunk HEC (secret, YAML, verification) and an Elasticsearch/OpenSearch output variant.
Master guide include wiring
docs/developer-lightspeed-guide/master.adoc
Adds the include directive for the new topic before the mta-developer-lightspeed block is disabled.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: djzager, fabianvf

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is specific and aligned with the added LLM proxy transaction logging and audit documentation.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc`:
- Around line 27-30: Update the prerequisites in
proc_auditing-llm-proxy-transactions.adoc so they require the minimum
namespace-scoped role needed to read proxy pod logs in the MTA namespace, rather
than cluster-admin; keep cluster-admin only for the later forwarding setup
section if needed. Reference the prerequisites list and the oc logs workflow,
and make the role requirement specific to the log-reading step instead of the
broader cluster-wide access.
- Around line 170-210: The ClusterLogForwarder example in the proxy-auditing doc
hard-codes the pod selector label, which may not match the actual proxy
workload. Update the selector in the example to use a placeholder such as
__<proxy_workload_label>__ instead of app: mta-ui-proxy, and keep the
surrounding guidance in sync by referring readers to verify the label before
applying the ClusterLogForwarder resource.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fb7c899a-f543-41b7-89c5-666f2fb4f52e

📥 Commits

Reviewing files that changed from the base of the PR and between 50da7d6 and 63ad26a.

📒 Files selected for processing (2)
  • docs/developer-lightspeed-guide/master.adoc
  • docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc

Comment thread docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc Outdated
Comment thread docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc Outdated
Comment thread docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc Outdated

@Pkylas007 Pkylas007 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only a few minor suggestions and clarifications, thank you!

Comment thread docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc Outdated
Comment thread docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc Outdated
Comment thread docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc Outdated
Comment thread docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc Outdated
Comment thread docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc Outdated
Comment thread docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc Outdated
Comment thread docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc Outdated
Comment thread docs/topics/developer-lightspeed/proc_auditing-llm-proxy-transactions.adoc Outdated

@rromannissen rromannissen left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, although I would defer to Engineering for technical validation. Only one small request to be more accurate with the Hub as OIDC provider.


Credential isolation:: LLM provider API keys are stored in a Kubernetes secret and never distributed to client applications. Only the proxy pod reads these credentials.

JWT-based authentication:: When authentication is enabled, the proxy validates every incoming request against the Hub's Keycloak instance by using its JWKS endpoint:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The dependency for Keycloak is being removed in MTA 8.2. It would be more accurate to say something like "the Hub's OIDC provider".

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am trying to get this into 8.1 docs

@migtools migtools deleted a comment from Pkylas007 Jul 13, 2026
@migtools migtools deleted a comment from Pkylas007 Jul 13, 2026
Signed-off-by: A.Arnold <anarnold@redhat.com>
@anarnold97
anarnold97 force-pushed the MTA-7134-LLM-Proxy-Transaction-Logging-Schema-Audit-Trail-Integration branch from ea5d1d8 to 3731a39 Compare July 13, 2026 18:01

@Pkylas007 Pkylas007 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!


[NOTE]
====
As of MTA 8.2, OIDC user identity is terminated at the Hub and is not passed to or stored by the proxy.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
As of MTA 8.2, OIDC user identity is terminated at the Hub and is not passed to or stored by the proxy.
As of {ProductShortName} 8.2, OpenID Connect (OIDC) user identity is terminated at the Hub and is not passed to or stored by the proxy.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants