ng-safelogger v1.0.5

NG SafeLogger

NG SafeLogger is an Angular package that securely captures and sends error logs to a configurable endpoint. It encrypts logs before sending, avoids duplicates, and temporarily stores logs in localStorage if the connection is unavailable.

📌 Features

• 🚀 Automatic error capturing in Angular
• 🔐 RSA encryption of logs before sending
• 🔄 Prevents duplicates and reduces log spam
• 💾 Local storage of logs when offline, auto-retries later
• ⏳ Batch sending every 30 seconds if new errors arrive
• 🔍 User action tracking before an error occurs

📦 Installation

npm install ng-safelogger

🚀 Usage in Angular

1️⃣ Import and Configure in main.ts

import { HTTP_INTERCEPTORS, provideHttpClient, withInterceptorsFromDi } from '@angular/common/http';
import { provideSafeLogger, ErrorLoggerInterceptor } from 'ng-safelogger';

bootstrapApplication(AppComponent, {
  providers: [
    provideHttpClient(withInterceptorsFromDi()),
    
    { provide: HTTP_INTERCEPTORS, useClass: ErrorLoggerInterceptor, multi: true },
    provideSafeLogger({
      enableLogging: true,
      apiUrl: 'https://my-api-logs.com/errors',
      apiKey: 'abcdef-12345',
      publicKeyUrl: 'https://my-api-logs.com/public-key',
      appName: 'MyApp',
      appEnv: 'production',
      appBuildId: 'abcdef123456'
    }),
  ],
});

2️⃣ Capture Custom Errors

If you want to manually capture errors:

import { ErrorLoggerService } from 'ng-safelogger';

constructor(private errorLogger: ErrorLoggerService) {}

try {
  throw new Error('Testing error');
} catch (error) {
  this.errorLogger.handleError(error);
}

🔑 Configuration

🔒 Security and Privacy

• Removes sensitive data such as emails, IDs, credit card info, and phone numbers before sending logs.
• Logs are encrypted via RSA before being sent to the API.

❓ FAQs

🔹 What if the logging API is unavailable?
➡️ The logs are stored in localStorage and resent when the app restarts or upon navigation.

🔹 How do I disable log capturing?
➡️ Set enableLogging: false in the initialization provider.

🔹 Can I send logs manually?
➡️ Yes, just call this.errorLogger.handleError(error) from anywhere in your code.

📝 License

This project is licensed under the MIT License. See the LICENSE file for more information.

🚀 Developed by Dyango Rodríguez | 💡 Contributions and improvements welcome.