nano SIEM
Settings

Evidence Pack

Supported in:Self-hosted

Export compliance evidence for an audit period as JSON, CSV and PDF, with an optional mapping to SOC 2, ISO 27001, Essential Eight, ISM, NIS2 and DORA controls. Metadata only, every file hashed. Self-run, from v2.0.25.

The Evidence Pack exports the evidence an auditor asks for, for one audit period, in one step. Each pack is three files: a JSON document, a zip of CSV files and a PDF report. You can hand them to an auditor or upload them to a compliance platform.

  • Metadata only. A pack holds source names, counts, sizes, timestamps, identifiers, settings, rule names, actor emails and audit action names. It never holds log content. See What a pack never contains.
  • Mapped to controls. An optional control mapping shows which parts of the pack support evidence for SOC 2, ISO/IEC 27001, Essential Eight, ASD ISM, NIS2 and DORA controls.
  • Hashed. Every file has a sha256, and the PDF prints the hash of the JSON, so you can show the three files belong together and have not changed.

Availability

  • Self-run only, from v2.0.25. It is included with Self-run at no extra charge. It is not a separate purchase.
  • Open builds have no Evidence Pack. The endpoints do not exist and the Settings entry is not shown.
  • License: the endpoints need a live license. When the license is at its hard stop, every /api/compliance/* call returns 403 LICENSE_REQUIRED and the page shows Evidence Pack is locked. Packs already stored stay in the database and download again once the license is restored.
  • Air-gapped installs work the same way. The pack is built from your own databases, the PDF is rendered in-process with embedded fonts, and nothing is sent to nano or any third party. See Air-gapped deployment.

Permission

Every Evidence Pack endpoint, and the page, require the compliance:export permission.

  • Upgrading to v2.0.25 grants it to the built-in Admin role only.
  • Custom roles, groups and existing API keys do not receive it. Grant it under Settings → Access Control → Roles, or create an API key that includes it. See Access control.
  • Permissions are carried in the session. Admins sign in again after the upgrade before the page appears.
  • An account restricted to particular log sources gets 403, because a pack covers every source.
  • Packs are install-wide. Anyone with compliance:export can list, download and delete every pack on the install, not only their own.

Generate a pack

In the UI

  1. Open Settings → Evidence Pack (/settings/compliance/evidence-pack). It sits next to GDPR & Compliance.
  2. Under Audit period, pick Last quarter, Last 6 months, Last 12 months or Custom. Dates are UTC. With Custom, the end date is inclusive.
  3. Leave Include control mapping on to add the control mapping. Under Frameworks, pick the frameworks to map. None selected means all.
  4. Select Generate pack. The run shows its progress section by section.
  5. When it succeeds, download the JSON, the CSV zip or the PDF from Past packs. Each file shows its size and sha256, which you can copy.

One pack runs at a time. Generate pack stays disabled while a pack is generating.

With the API

Use an API key (or session) with compliance:export.

export NANO_URL=https://nano.example.com
export NANO_API_KEY=nsk_your_api_key_here

# Start a pack for October 2026. The period is [start, end), UTC.
curl -sS -X POST "$NANO_URL/api/compliance/evidence-packs" \
  -H "X-API-Key: $NANO_API_KEY" -H 'Content-Type: application/json' \
  -d '{
        "period_start": "2026-10-01T00:00:00Z",
        "period_end":   "2026-11-01T00:00:00Z",
        "frameworks": ["soc2", "iso27001"],
        "include_control_mapping": true
      }'
# -> 202 {"id": "evp_01…", "status": "queued", …}

# Poll until status is succeeded, failed or interrupted.
curl -sS "$NANO_URL/api/compliance/evidence-packs/evp_01…" -H "X-API-Key: $NANO_API_KEY"

# Download the files (kind: json | csv | pdf).
for kind in json csv pdf; do
  curl -sS -OJ "$NANO_URL/api/compliance/evidence-packs/evp_01…/artifacts/$kind" \
    -H "X-API-Key: $NANO_API_KEY"
done
Method and pathResult
POST /api/compliance/evidence-packs202 with the queued run. 400 if the period or a framework id is invalid. 409 if 5 packs are already waiting
GET /api/compliance/evidence-packs{ "runs": [...], "next_cursor": ... }. Takes limit
GET /api/compliance/evidence-packs/{id}The run: status, progress, section statuses, error, and its files (kind, filename, size, sha256; for json also uncompressed_size_bytes and uncompressed_sha256)
GET /api/compliance/evidence-packs/{id}/artifacts/{kind}The file, as an attachment
DELETE /api/compliance/evidence-packs/{id}204. Deleting a queued run cancels it. 409 while the run is generating
GET /api/compliance/frameworksThe six frameworks with their mapped controls

Request fields:

  • period_start, period_end: required, RFC 3339 UTC.
  • include_control_mapping: optional, default true.
  • frameworks: optional. Filters the control mapping only; leave it empty for every framework. The sections always cover everything. Valid ids: soc2, iso27001, e8, ism, nis2, dora.

A run's status is queued, running, succeeded, failed or interrupted. A run is interrupted when the API process running it stopped, for example during a restart.

What's in a pack

Files

KindFilenameContent
jsonevidence-pack-<id>.json.gzThe whole pack (schema_version: "1"), gzip-compressed. This is the reference file
csvevidence-pack-<id>-csv.zipOne <section>__<table>.csv per table, plus manifest.csv with the pack id, period, generation time, install id, schema version and json_sha256
pdfevidence-pack-<id>.pdfThe auditor report: cover, summary, one part per section, the control mapping, and an appendix with the policy template and field definitions

The JSON and CSV files carry every row. The PDF prints the first 200 rows of each table; its row counts are always complete. CSV list values are joined with ;.

Sections

SectionWhat it showsWhere it comes from
CollectionEach log source with its events, bytes, first and last event in the period, collection gaps (hour resolution, at least the source's stale threshold) and ingestion outagesThe hourly per-source rollup, source health episodes, ingestion pause history, the ingest watchdog journal
RetentionThe configured TTL per events table, the storage tiers, whether retention is met (the oldest searchable data reaches back the TTL), retention changes in the period, and per-source samplingTable definitions, storage parts (day resolution), audit events
Integrity and timeThe tamper-protection controls this install has, each enabled, disabled, not_present or unknown, and the ingest lag per source as the clock signalClickHouse grants, ingest guards, the durable audit outbox, backup status, the hourly rollup
DetectionRules active in the period, and their change history (who, what, when)Rules, rule versions, rule audit events
ReviewEvery alert created in the period, with reviewer, outcome, timestamps and time to triage. This is the population an auditor samples fromAlerts
ResponseCases and incidents open in the period, with their workflow timelineCases, case workflow events, incidents
AccessUsers with status, MFA and effective roles; roles and permissions; API key metadata; admin and audit-log activity in the periodUsers, roles, API keys, the audit log

Each section has a status:

  • ok: built in full.
  • partial: built, with a caveat in its reason. For example, the audit log does not reach back to the period start.
  • unavailable: could not be built, with the reason.

A failed section never fails the pack.

Retention is configured per events table and applies to every source; there is no per-source retention. A source with a sampling_ratio below 1 is listed with its ratio.

Coverage windows

Every pack prints two windows under coverage:

  • Audit coverage window (audit_window_start): the oldest audit event still searchable. Audit events are stored with your logs and expire with the log retention. Audit-retention pruning moves this window forward, and on OCSF installs a GDPR erasure can remove a subject's audit events. Anything that depends on the audit log (rule lifecycle changes, retention changes, admin activity, failed logins) is complete only after this time. A section whose period starts earlier is marked partial.
  • Collection rollup coverage (collection_rollup_start): when the hourly per-source rollup first wrote data. The rollup is created when you upgrade to v2.0.25 and is not backfilled. For earlier parts of a period, the pack uses the 7-day five-minute rollup where it overlaps and otherwise reports the data as not recorded. Raw event tables are never scanned. The rollup keeps 400 days, so a 12-month pack is fully covered about a year after the upgrade. After a switch from UDM to OCSF, Collection is marked partial until the new schema's rollup has data.

What a pack never contains

Every section reads from an explicit column allowlist, and tests fail if a content value appears in the JSON, the CSV files or the PDF text. A pack never includes:

  • event payloads, raw data, messages or any event field value;
  • rule queries;
  • case titles, descriptions, notes, AI summaries, wall entries or entities;
  • the matched events of alerts;
  • audit-event details;
  • password hashes, API key hashes or TOTP secrets.

Failed logins show the actor as (unknown user) when the typed username doesn't match a user, so a password typed into the username field never ends up in a pack. Events from a source that isn't a registered log source appear as one unregistered row with counts only.

Control mapping

With Include control mapping on, the pack lists, for each selected framework, the controls that pack sections can support evidence for, with a short rationale per control. It appears in the JSON as control_mapping and in the PDF.

IdFrameworkControls
soc2SOC 2 (Trust Services Criteria 2017, revised points of focus 2022)CC7.2, CC7.3
iso27001ISO/IEC 27001:2022 Annex AA.8.15, A.8.16, A.8.17
e8Essential Eight (ML2 and ML3)Central logging, log protection, timely analysis
ismASD ISM, September 2026, Guidelines for system monitoringEvent-logging controls, including ISM-1405, ISM-1815, ISM-1906, ISM-1228 and ISM-1988
nis2NIS2 Implementing Regulation (EU) 2024/2690, Annex section 3.23.2.1 to 3.2.6
doraDORA RTS (EU) 2024/1774, Article 12Art. 12(1), 12(2)(a), (c), (d), (e), (f)

GET /api/compliance/frameworks returns the full list of controls, with the sections each one maps to.

Every rationale reads "This section supports evidence for …". The mapping shows where evidence can be found. It does not claim or certify compliance with any framework. Your assessor decides what evidence is sufficient, and many controls also depend on policies, processes and systems outside nano. Every pack carries this disclaimer.

The mapping is versioned data (map_version in the pack, currently 1.0.0). A changed mapping ships with a new nano version and a new map_version, and each pack records the version it used.

Policy template

Every pack includes a Logging and Monitoring Policy template in Markdown, as policy_template in the JSON and as appendix A of the PDF. It covers purpose, scope, roles, log sources, retention, log protection, time synchronization, alert review, incident escalation, access to logs and policy review.

It is a starting point, not a policy. Replace every bracketed placeholder (such as [Organization] and [retention period]), remove what does not apply, and add the requirements of the frameworks and laws you follow.

Verify the files

The JSON downloads gzip-compressed, so it has two hashes:

HashCoversWhere you see it
sha256 of jsonThe .json.gz file as downloadedThe run's file list
uncompressed_sha256 of jsonThe JSON after gunzipThe run's file list, the PDF cover, json_sha256 in manifest.csv
sha256 of csv and pdfThe zip and the PDF as downloadedThe run's file list
shasum -a 256 evidence-pack-evp_01….json.gz     # = the run's sha256 for json
gunzip -k evidence-pack-evp_01….json.gz         # keeps the .gz, writes the .json
shasum -a 256 evidence-pack-evp_01….json        # = PDF cover, manifest json_sha256,
                                                #   and the run's uncompressed_sha256

On Linux, use sha256sum instead of shasum -a 256. Check the zip and the PDF against the run's list the same way.

The pack is not signed. The hashes show that the three files belong together and have not changed since the run listed them. Keep the run list, or the audit event of the download, as your record of the hashes.

Audit log

Requesting, downloading and deleting a pack are written to the audit log as security-critical actions: evidence_pack_requested, evidence_pack_downloaded and evidence_pack_deleted. Find them in Settings → Audit Log. See Platform audit logging.

Limits and sizing

  • Period: at most 400 days. The end must be after the start and not in the future (5 minutes of clock tolerance).
  • Queue: one run at a time per install. Further requests queue and run oldest first. Up to 5 can wait; a sixth gets 409. Queued runs resume after an API restart.
  • Timeout: a run stops after 30 minutes.
  • File size: each stored file is capped at 256 MB, and the JSON and the CSV each at 1 GiB uncompressed. Tables other than alerts are capped at 200,000 rows. The outages table is cut at 200,000 rows instead and marks Collection partial. Alerts take about 550 bytes of JSON each (about 80 bytes gzipped), so a year with a million alerts is a JSON of about 590 MB, stored as about 81 MB.
  • Audit events: the Access section lists at most the newest 100,000 audit events in the period. Its summary counts cover every audit event in the period. When the list is cut, the section says so.
  • Pack retention: the newest 20 packs are kept, none older than 90 days. Download the files you need to keep.

Memory

A pack streams its alerts and keeps one section in memory at a time. Since v2.0.26, the memory a pack needs depends on its period: about 80 MiB plus 100 KiB per day of period at peak.

Before a run starts, nano checks the API container's memory limit and requires twice the expected peak free: about 160 MiB for a 7- or 30-day period, about 230 MiB for 365 days. If less is free, the run fails at once. With no memory limit set, there is no check.

  • Docker Compose: on a Self-run install, install.sh sizes the API at least 1 GiB where the host allows, taking the memory from PostgreSQL (down to 512 MiB) and then ClickHouse. Re-run install.sh after upgrading to pick up the new size. To set it yourself, add NANO_API_MEM_LIMIT to .env below the # END NANO AUTO SIZING line, then re-run install.sh.
  • Helm: the presets give the API 2 GiB or more. Raise it with api.resources.limits.memory.
  • Override: NANO_EVIDENCE_PACK_MIN_HEADROOM_MB on the API sets a fixed threshold for every period instead. 0 turns the check off.

What a pack does not prove

The pack reports what nano records. It is not a certification, and some things are outside it:

  • No audit-log hash chain or signing. Audit events are not tamper-evident on their own. The Integrity and time section reports this as not_present.
  • No WORM or object lock on log or audit storage, also reported as not_present.
  • No runtime clock-sync probe. The installer and upgrade preflight check host time sync. At runtime the pack reports ingest lag per source (insert time minus event time); a negative lag means the source's clock is ahead. Host synchronization needs separate evidence.
  • Not the design of detections. Rule queries are excluded, so the logic of each rule must be evidenced separately.
  • Not the depth of investigations. Case narratives are excluded; use the case record itself.
  • Alert history is current state. Alerts keep their current state. Reassignments are visible only through alert_* audit events inside the audit coverage window.
  • Rule lifecycle history (pause, resume, promote, demote) comes from audit events, so it is bounded by the audit coverage window.
  • Sources, not event types. Collection lists log sources. Whether each source carries the event types a control requires is for you and your assessor to confirm.
  • Systems outside nano are covered only through the sources nano collects.

Troubleshooting

SymptomCause and fix
No Evidence Pack entry in SettingsOpen build, no live license, or no compliance:export. After an upgrade, sign in again so the session picks up the permission
Evidence Pack is locked or 403 LICENSE_REQUIREDThe license is at its hard stop. Restore it; stored packs download again
403 "Evidence Packs cover every log source"The account is restricted to particular log sources. Use an account without source restrictions
400 "the period may be at most 400 days"Split the audit period into consecutive packs
400 "period_end must not be in the future"Use an end at or before now (UTC)
409 "too many queued packs"5 runs are already waiting. Wait for them, or delete a queued run
409 on deleteThe run is generating. Wait for it to finish
Run fails with "not enough memory to generate an Evidence Pack safely"The message names a limit that fits. Raise the API memory as in Memory, choose a shorter period, or retry when the API is less busy
Run fails with "pack exceeds 256 MB; shorten the period"Generate consecutive shorter packs that together cover the audit period
Run fails with "timed out after 30 minutes"Use a shorter period
Run shows interruptedThe API restarted while it ran. Generate it again
A section is partialRead its reason. Usually the audit coverage window or the collection rollup starts after the period start

Failed runs show the status of every section they reached, so you can see which section was too large.

On this page