Skip to main content
Version: v1.7.5-2 🚧

Audit trail

Overview​

Enterprise h2oGPTe streams a record of security-relevant user actions to the H2O AI Cloud (HAIC) Audit Trail service for compliance and governance tracking. The audit trail answers "who did what, where, and when" for direct end-user actions in the platform.

note

The audit trail is a platform-level compliance feature. Your deployment administrator enables it at the infrastructure level — it's not a setting available inside Enterprise h2oGPTe's System Dashboard, and audit events themselves are never visible inside Enterprise h2oGPTe's own interface. It's also separate from the Live Logs page in the System Dashboard, which shows application logs rather than a compliance-grade audit record.

h2ogpt:
config:
cloudConfigurations:
auditTrail:
enabled: true

Audit events are viewed in the HAIC Audit Trail UI, or its REST/gRPC read API. Contact your deployment administrator for access to your environment's Audit Trail UI.

What gets audited​

The audit trail only records direct end-user actions — actions a user explicitly triggers through the UI or API. A small number of asynchronous background jobs that directly correspond to a user action (such as collection deletion or document ingestion) are also recorded, but most other background job types, along with automated processes that aren't triggered by a user action (such as scheduled syncs) and internal service-to-service calls, are excluded.

caution

Only successful operations produce audit events. If a user attempts an action that fails (for example, due to insufficient permissions or a database error), no audit event is recorded. The only exception is guardrail violations, which are always recorded regardless of outcome.

Audited operations cover the following domains:

DomainActions covered
CollectionsCreate, update, delete; share or unshare with a user, group, or all users; make public or private; set or reset the prompt template, collection settings, chat settings, or RAG type — see Collection lifecycle for the complete list
Chat sessionsCreate a session; delete sessions; delete individual messages within a session
DocumentsIngest a document (upload or plain text only — cloud storage, website, and filesystem ingests are not yet audited); delete documents
Roles and permissionsCreate/delete a role; add/remove a role to or from a user or group; reset roles; assign or add permissions; set role priority; set or bulk-delete role configuration; set the default role
User groupsCreate a group; delete groups by ID or by name
API keysCreate a key (including collection- or user-scoped keys); deactivate a key; set expiration; set the inactivity interval; admin-initiated deletion
SecretsCreate, update, delete
ConfigurationSet global or user configuration; bulk-delete global or user configuration; reset user configuration
User managementDelete a user
GuardrailsGuardrail violation (blocked prompt or response)
note

Additional domains are planned for future releases. The preceding table reflects the operations audited in the current release.

What an audit event contains​

Each audit event captures the actor, the action, the affected resource, and the actor's IP address. Events include resource-identifying metadata (such as role names and configuration keys) but exclude the data values themselves. For example, creating a role produces an event with fields similar to:

FieldExample value
actionactions/h2ogpte/roles/CREATE
eventSourceh2ogpte-mux
principalusers/<user-uuid>
resource//h2ogpte/<workspace>/roles/<role-uuid>
workspaceworkspaces/<workspace-uuid> (carried in the event's metadata)
status.codeOK
eventTimeTimestamp of when the event was recorded (typically within seconds of the action)
typeTYPE_API
note

Most events have a status.code of OK. Guardrail violation events use PERMISSION_DENIED.

Sensitive values are never included in audit events​

Operations that handle secrets or credentials, such as creating an API key or updating a configuration value, are scrubbed before the event is recorded. For example, an API key creation event includes the key's identifier but never the plaintext key value itself. This scrubbing happens automatically; there's nothing for end users or administrators to configure.

Accessing audit trail data​

Events typically appear in the Audit Trail UI within 30 seconds of the action. To review them:

  1. Open the HAIC Audit Trail UI for your environment (your deployment administrator can provide the URL).
  2. In the Event Source filter, enter h2ogpte-mux to see only Enterprise h2oGPTe events.
  3. Sort by event time to review the most recent activity first.

If your environment doesn't show expected events in the HAIC Audit Trail UI, ask your deployment administrator to confirm the audit trail integration is enabled and correctly configured for your deployment.

  • Roles and Permissions - Manage the roles and permissions whose changes are recorded in the audit trail
  • Secret manager - Manage secrets whose lifecycle events are recorded in the audit trail
  • API key management - Manage API keys whose lifecycle events are recorded in the audit trail
  • Live logs - Application-level logs, distinct from the compliance-grade audit trail
  • Collection lifecycle - Detailed reference for collection-related audit events

Feedback