deadair v0.8.0

deadair checks whether enabled SIEM detections still have the telemetry they need.
It reports missing or stale data, ingest delays, and schema mismatches.

Runs locally · Read-only · No agent · No telemetry upload

Read the technical write-up · Featured in Detection Engineering Weekly · Featured in tl;dr sec #341

_{Missing fields and delayed events in a disposable Elastic lab. Open the image for the short recording with playback controls, or reproduce it with make record-scan-lab.}

Why deadair

A rule can be enabled, scheduled, and error-free after the data it needs has disappeared. deadair reads the live rule inventory, resolves each rule's inputs using the backend's native semantics, and checks the concrete sources behind them.

It catches:

• rules whose index, alias, or data-stream selectors resolve to nothing;
• mixed-selector rules where one declared input has disappeared while another still resolves;
• rules whose matching sources are all stale or empty;
• on Elastic, rules running with missing declared fields;
• on Elastic and eligible Sentinel Scheduled rules, an ingest-lag blind window;
• on Sentinel, rules whose known sources use an incompatible Basic or Auxiliary table plan;
• on Elastic and OpenSearch, healthy telemetry that no enabled detection reads.

deadair supports Elastic Security, OpenSearch Security Analytics, and Microsoft Sentinel.

Quick start

Download a binary for macOS, Linux, or Windows from GitHub Releases, or install with Go:

go install github.com/alephnull-sh/deadair/cmd/deadair@latest

Print the read-only setup for your SIEM:

deadair setup elastic      # Elastic Security
deadair setup opensearch   # OpenSearch Security Analytics
deadair setup sentinel     # Microsoft Sentinel

Run one setup, then verify and scan:

deadair check   # verify the credential can scan
deadair scan    # assess live rules and telemetry

Exit codes are stable: 0 passes the configured gate, 1 means gated findings, and 2 means the scan failed.

To investigate a source and its consuming detections:

deadair scan --json-out report.json --html-out report.html
deadair inspect --source CommonSecurityLog report.json

Use a source name from your report. The investigation guide also covers individual Sentinel feeds, maintenance, and recovery tracking.

How it works

Sentinel follows the same rule-to-source model and adds literal watchlists, saved functions, ASIM parsers, mapped workspaces, and summary-table lineage. It also shows when a filtered slice of a shared table has gone quiet or a summary pipeline has fallen behind.

The usage guide describes the evidence rules, and the validation record records the live test coverage.

_{Two firewall feeds share CommonSecurityLog. One stops; the other keeps reporting. The recording shows the saved failure and recovery scans. See the validation record for the lab conditions.}

deadair checks whether a detection's telemetry is present and healthy. It does not validate rule logic or prove that a simulated attack will fire an alert. Use static rule validation and end-to-end detection tests for those jobs.

Findings

Producer and summary-pipeline findings affect exit status when their classes are selected in the policy. A quiet device feed is reported separately from other consumers of its shared table.

Every verdict is limited to what the configured credential can see. JSON reports include the configured expressions, resolved sources, resolution method, assessment status, backend metadata, and capability evidence. See the usage guide for worked examples and triage.

Connect a SIEM

Elastic:

export DEADAIR_ES_URL=https://es.example.internal:9200
export DEADAIR_KIBANA_URL=https://kibana.example.internal:5601
export DEADAIR_API_KEY=<read-only-api-key>

deadair check
deadair scan --json-out report.json --html-out report.html

OpenSearch:

export DEADAIR_BACKEND=opensearch
export DEADAIR_OPENSEARCH_URL=https://opensearch.example.internal:9200
export DEADAIR_OPENSEARCH_USERNAME=deadair
export DEADAIR_OPENSEARCH_PASSWORD=<password>

deadair check
deadair scan

Microsoft Sentinel:

az login --tenant <tenant-id>

export DEADAIR_BACKEND=sentinel
export DEADAIR_AZURE_SUBSCRIPTION_ID=<subscription-id>
export DEADAIR_AZURE_RESOURCE_GROUP=<resource-group>
export DEADAIR_SENTINEL_WORKSPACE=<workspace-resource-name>
# Optional: JSON allowlist for literal workspace() targets.
# export DEADAIR_SENTINEL_REMOTES=/restricted/path/sentinel-remotes.json

deadair check
deadair scan

Before deadair assesses a rule's mapped remote workspace, that workspace must have Sentinel deployed. Same-subscription mappings can prove source availability. Cross-subscription rules need runtime evidence tied to the exact rule identity. See the Sentinel usage details for the evidence rules, workspace and region limits, and Microsoft's performance guidance.

Use the documented read-only roles for Elastic, OpenSearch, or Microsoft Sentinel.

CI, fleets, and monitoring

# Gate a candidate rule against live source availability.
deadair scan --rule new-rule.json

# Fail only on new regressions between reports.
deadair diff yesterday.json today.json

# Scan multiple SIEM instances from one process.
deadair scan --fleet fleet.json

# Export cached scan results as Prometheus metrics.
deadair serve --interval 5m

scan --rule isolates a backend-native candidate rule or detector from unrelated backlog. diff works with redacted reports created with the same caller-held key. Fleet configuration references secrets through environment variables rather than storing secret values.

The official GitHub Action wraps single-instance candidate gates for Elastic, OpenSearch, and Sentinel. It writes a job summary, uploads a redacted JSON report, and can apply a deadair policy without installing a rule. Sentinel workflows authenticate the runner to Azure first; the Action defines no Azure credential inputs.

See CI gate behavior, fleet and MSSP deployment, and the Prometheus examples for configurations to test in your own environment.

Tested backends

The Sentinel conformance run is manual, not scheduled CI.

Security model

• All adapter calls are read-only. Trusted Elastic and OpenSearch tests plus separate Sentinel lab probes verify that the documented scan identities cannot perform representative writes.
• Reports, HTML, state files, and fleet output are written 0600 on POSIX systems.
• Credentials can come from environment variables or files, avoiding secrets in process arguments.
• --redact replaces tenant, rule, source, pattern, field, dependency, lineage, provenance, workspace, watchlist, template, and package identifiers with keyed HMAC pseudonyms. Validated dependency probe expressions and their KQL arguments are never serialized. A --redact-key-file generated from random bytes also enables redaction and keeps names stable across separate runs.
• The exporter binds to loopback by default.
• deadair has no phone-home behavior or usage telemetry.

Treat reports as sensitive SOC artifacts: they identify blind detections, source names, schema gaps, and unused collection.

Documentation

• Usage guide — first scans, report evidence, findings, CI gates, state, and fleets
• Investigate a telemetry gap — source consumers, expected feeds, and recovery
• Validation status — tested paths and current limits
• Architecture — backend contract, data model, safety properties, and limits
• Best practices — rollout order, alert context, and routing
• MSSP guide — secrets, redaction, scheduling, and tenant failure handling
• Detections that run but can't see — the problem and a reproducible simulation

Contributing

Open an issue for bugs, suggestions, or sanitized reproductions. Maintainers handle code changes. See CONTRIBUTING.md for details.

License

Apache-2.0.