compliance_logger 0.1.0-beta.1

PII-redacting logger for Dart and Flutter. Masks emails, phone numbers, tokens, API keys, card numbers and IBANs before any sink sees them.

example/compliance_logger_example.dart

// ignore_for_file: avoid_print

import 'dart:convert';

import 'package:compliance_core/compliance_core.dart';
import 'package:compliance_logger/compliance_logger.dart';

Future<void> main() async {
  final audit = InMemoryAuditTrail(maxEvents: 500);

  final logger = ComplianceLogger(
    name: 'example',
    minLevel: LogLevel.debug,
    redactor: Redactor(
      rules: BuiltInRules.defaults(
        email: const RuleSettings(mode: MaskMode.partial),
        phone: const RuleSettings(mode: MaskMode.hash),
        ipAddress: const RuleSettings(),
      ),
      customRules: [
        RegexRedactionRule(id: 'customer_id', pattern: RegExp(r'CUST-\d{8}')),
      ],
      allowlist: {'[e-mail]'},
      // In a real app, load a key from secure storage so hashes stay
      // comparable across restarts. Never hard-code it.
      hashKey: utf8.encode('example-only-key-do-not-reuse!!'),
    ),
    sinks: [
      const ConsoleSink(),
      CallbackSink((record) {
        if (record.level.isAtLeast(LogLevel.error)) {
          // Forward to a crash reporter here. The record is already redacted.
        }
      }),
    ],
    auditTrail: audit,
  );

  logger
    ..info('Signup by [e-mail], contact [e-mail]')
    ..info('Callback number [phone] for CUST-12345678')
    ..debug('Request from 203.0.113.7 with Authorization: Bearer abc123def456')
    ..warning(
      'Payment details updated',
      fields: {
        'card': '4111 1111 1111 1111',
        'iban': 'DE89 3704 0044 0532 0130 00',
        'password': 'not-a-real-password',
      },
    );

  try {
    throw const FormatException('Bad input from [e-mail]');
  } on FormatException catch (e, st) {
    logger.error('Parsing failed', error: e, stackTrace: st);
  }

  await Future<void>.delayed(Duration.zero);
  print('\nAudit events (counts only):');
  for (final event in audit.history) {
    print(event.metadata);
  }
  await audit.dispose();
}