Expand description
Enterprise Audit System for copybook-rs
EXPERIMENTAL: This crate is experimental and subject to breaking changes.
It lives outside the stable copybook-core surface; depend on
copybook-audit explicitly to opt in.
§Status
This audit system is under active development and should be considered unstable. The API may change significantly between releases, and production use is not recommended without thorough validation in your specific environment.
§Opt-in dependency
To enable the audit system, depend on this crate directly:
[dependencies]
copybook-audit = "0.5"Performance Note: Keep this dependency out of hot paths unless you require comprehensive audit capabilities for compliance or security monitoring.
§Capabilities
When enabled, this module provides comprehensive audit capabilities for enterprise mainframe data processing, including:
- Regulatory Compliance: SOX, HIPAA, GDPR, PCI-DSS compliance tracking
- Security Monitoring: Access control validation and security event auditing
- Performance Tracking: Throughput metrics and regression detection
- Data Lineage: Complete field-level transformation and impact tracking
- Audit Trail Integrity: Cryptographic hash chains for tamper detection
§Stability Guarantees
None. This is experimental software:
- APIs may change without notice between minor versions
- Serialization formats may be incompatible across releases
- Performance characteristics are not yet optimized
- Error handling patterns may evolve
Use at your own risk and validate thoroughly before production deployment.
Re-exports§
pub use compliance::ComplianceConfig;pub use compliance::ComplianceEngine;pub use compliance::ComplianceProfile;pub use compliance::ComplianceResult;pub use compliance::ComplianceViolation;pub use context::AuditContext;pub use context::EnvironmentContext;pub use context::ProcessingConfig;pub use context::SecurityContext;pub use event::AuditEvent;pub use event::AuditEventType;pub use event::AuditPayload;pub use event::AuditSeverity;pub use lineage::FieldLineage;pub use lineage::ImpactAnalyzer;pub use lineage::ImpactAssessment;pub use lineage::LineageRecord;pub use lineage::LineageTracker;pub use lineage::RiskLevel;pub use lineage::TransformationType;pub use logger::AuditLogger;pub use logger::AuditLoggerConfig;pub use logger::LogFormat;pub use logger::RetentionPolicy;pub use performance::BaselineManager;pub use performance::PerformanceAuditor;pub use performance::PerformanceBaseline;pub use performance::RegressionDetector;pub use performance::ResourceMetrics;pub use performance::ThroughputMetrics;pub use report::AuditReport;pub use report::ComplianceReport;pub use report::PerformanceReport;pub use report::ReportFormat;pub use report::ReportGenerator;pub use report::SecurityReport;pub use security::AccessAuditor;pub use security::AccessEvent;pub use security::AccessResult;pub use security::EncryptionConfig;pub use security::EventMonitor;pub use security::SecurityAuditor;pub use security::SecurityMonitor;pub use security::SecurityValidation;pub use security::SecurityViolation;
Modules§
- compliance
- Enterprise Compliance Engine
- context
- Audit Context System
- event
- Audit Event System
- lineage
- Data Lineage Tracking System
- logger
- Audit Logger Framework
- performance
- Performance Audit Subsystem
- report
- Audit Reporting System
- security
- Security Audit System
Enums§
- Audit
Error - Enterprise audit system error types
- Security
Severity - Security severity levels for audit events
Functions§
- generate_
audit_ id - Generate a unique audit event identifier
- generate_
integrity_ hash - Generate a cryptographic hash for audit trail integrity
- generate_
lightweight_ audit_ id - Generate a lightweight audit ID for performance-critical operations Uses thread-local counter instead of expensive timestamp and crypto
- validate_
audit_ chain - Validate audit trail integrity chain
Type Aliases§
- Audit
Result - Audit result type