Skip to main content

Redact PII and secrets from AI prompts, traces and tool-call arguments before they reach your loggers.

Project description

traceredact

PyPI Python CI License: Apache-2.0

Redact PII and secrets from AI prompts, agent traces and tool-call arguments before they reach your loggers / observability backend.

LLM apps log everything — prompts, agent traces, tool-call arguments — into Langfuse / Helicone / Datadog / your own DB. Customer PII and API keys leak into those traces. traceredact is a small, dependency-light library that detects and redacts that data deterministically, in-process, before it leaves you.

It is content-based: it catches a sk-… key or a credit-card number even when it sits under an innocuous JSON key — not just well-known field names.

A missed secret is a real incident, so detection is treated as safety-critical: bounded (ReDoS-safe) patterns, entropy fallback, Luhn/IBAN validation, and adversarial evasion fixtures.

Install

pip install traceredact          # or: uv add traceredact

Usage (3 lines)

from traceredact import redact

result = redact({"args": {"email": "a@b.com", "key": "sk-1234567890abcdefABCDEFGH"}})
print(result.value)      # {'args': {'email': '[REDACTED:pii]', 'key': '[REDACTED:secret]'}}
print(result.findings)   # [Finding(detector_id='pii.email', json_path='args.email', ...), ...]

redact() accepts a string, dict, list, or any nested mix. The input is never mutated; result.value is a redacted copy and result.findings lists every hit with its detector_id, category, confidence, json_path and span.

CLI (CI-gateable)

traceredact scan ./logs/            # report findings as a table; exit 1 if any
traceredact scan trace.json -f json # machine-readable output for CI
traceredact redact trace.json -o redacted.json

scan exits non-zero when anything is found, so you can gate a CI job on it.

SDK integrations

from openai import OpenAI
from traceredact.integrations.openai import wrap_openai

client = wrap_openai(OpenAI())   # prompts + completions now redacted in-flight

Also: traceredact.integrations.anthropic.wrap_anthropic(client) and traceredact.integrations.langchain.RedactingCallbackHandler().

Limitation (MVP): the wrappers patch the synchronous, non-streaming create call. Outbound prompts are always redacted, but streamed (stream=True) response content and async clients (AsyncOpenAI) are not yet redacted on the response side. Don't rely on response redaction for streaming until that lands.

Policy file (traceredact.yml)

Drop a traceredact.yml in your repo root (auto-discovered) or pass --policy:

entropy_threshold: 4.0
min_entropy_len: 20
disabled_detectors:
  - pii.phone
allowlist:
  - "noreply@example.com"
allow_patterns:
  - ".*@example\\.com"
placeholder: "[REDACTED:{category}]"
hash_correlation: false        # set true + hash_key to emit correlation tags
custom_patterns:
  - id: custom.internal_user_id
    category: pii
    regex: "ACME-USR-[0-9]{8}"
    confidence: 0.95

See traceredact.yml in this repo for a fully-commented example.

Detectors

Secrets: secrets.openai_key, secrets.aws_access_key, secrets.github_token, secrets.slack_token, secrets.slack_webhook, secrets.google_api_key, secrets.stripe_key, secrets.sendgrid_key, secrets.twilio_key, secrets.jwt, secrets.private_key, secrets.basic_auth_url, secrets.env_assignment, secrets.high_entropy.

PII: pii.email, pii.credit_card (Luhn), pii.iban (mod-97), pii.ipv4, pii.phone.

Secret pattern hits are deterministic (confidence 1.0); fuzzy heuristics (entropy, phone, IP) carry lower confidence so policy thresholds can gate them.

Design & safety

  • Deterministic, no data retained. Pure functions; nothing is stored.
  • Copy, never mutate. Your objects are untouched.
  • ReDoS-safe. Cheap literal prefilters gate bounded regexes; no nested quantifiers; input length is capped.
  • Fail-closed. Hash correlation without a key, or exceeding max_depth, raises rather than silently leaking.

Detectors were hardened against adversarial evasion cases (see tests/test_evasion.py).

License

Apache-2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

traceredact-0.1.1.tar.gz (33.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

traceredact-0.1.1-py3-none-any.whl (27.8 kB view details)

Uploaded Python 3

File details

Details for the file traceredact-0.1.1.tar.gz.

File metadata

  • Download URL: traceredact-0.1.1.tar.gz
  • Upload date:
  • Size: 33.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for traceredact-0.1.1.tar.gz
Algorithm Hash digest
SHA256 fb7cc1395a6d3a92d8c49c74befbb17e62898fec61feef42bcd4f78701375932
MD5 060e0cfa6b222c5eada0038ee0a71919
BLAKE2b-256 aead25ed30e3850f2ba58356b294dff390da69849ed5b015988b8054be88c871

See more details on using hashes here.

Provenance

The following attestation bundles were made for traceredact-0.1.1.tar.gz:

Publisher: release.yml on traceredact/traceredact

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file traceredact-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: traceredact-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 27.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for traceredact-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5b1de093d503c59aba7697362ceddb7f3a27ee04777d58ae6763f664765d594e
MD5 84a28b55cd1800f5f7386f1f970ba4ac
BLAKE2b-256 85eff9aac1dd22f1f4d51f57c6f9990819daa27e3fdffe16a5af1f94fe992e07

See more details on using hashes here.

Provenance

The following attestation bundles were made for traceredact-0.1.1-py3-none-any.whl:

Publisher: release.yml on traceredact/traceredact

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page