Skip to main content
Version: 11.5.0

Long-Term Audit and Telemetry

HYPR AgentPass™ records who or what made each request, how the gateway handled it, and who changed what. You read that record, and keep it as long as you need, in your own audit or analytics store.

Reading the Audit Trail​

The audit trail is the part of the record that answers who changed or decided what. It spans two event categories on Data Management:

  • Audit holds administrative changes, such as Data management settings, policy mode changes, directory provisioning changes and access reviews. AgentPass keeps these indefinitely.
  • Enforcement holds policy decisions, access denials and the approval workflow: each request raised, approved, denied, expired, revoked or deleted.

You read the audit trail where AgentPass sends it, in the systems your organization already uses:

DestinationHow you read it
Export filesJSON Lines files on each gateway node, which your collector ships to your compliance or analytics store. See Export Files
Log streamOne line per event in the gateway's logs, which your log collector forwards to your SIEM. See Send the Request Log to Your SIEM
Forensics StoreLong-term storage for your organization's events, when your deployment has one connected. See Forensics Store

An Admin sets this up, with Data retention: Manage: they turn on the destination and route the Audit and Enforcement categories to it. Expand each category on Settings › Data management, select the destinations it goes to, and click Save changes.

An Auditor holds Data retention: View, and can confirm the setup without changing it. On Settings › Data management, expand Audit and Enforcement to see where each is sent. Click an event type to see what it records, and the values it carries in the export files under In export files. See What an Event Carries.

Requests themselves are Activity events, which every role with Request log: View can also read in the console. See Request Log.

Keep Audit Data Longer​

The database keeps request activity for 30 days, and policy and approval records for 90 days. It keeps administrative audit records indefinitely. Each category shows its window on Data Management.

To keep an independently retained copy, you need Data retention: Manage, which only Admin holds:

  1. Open Settings › Data management.
  2. On the Export files card, click Directory and retention settings.
  3. Select Write export files on each gateway node.
  4. Set the directory and how many days to keep files.
  5. Click Write test to check that the gateway can write to the directory.
  6. For each attribute, set how it leaves the gateway: Clear text, Hashed or Not sent. Send only what your audit or analytics store needs.
  7. Route the categories you need to Export files.
  8. Click Save changes. The header reads No unsaved changes.
  9. Collect the hourly JSON Lines files from every gateway node, and ship them to your external store.
  10. Apply access, encryption and retention controls in that store.

Export files are off by default. AgentPass writes these files, but never reads them back. Keep files for sets how long a file waits for your collector. Your external store controls how long it keeps the copies it receives.

Every exported event carries the source IP of the request that caused it. See What an Exported Event Carries.