modulelogs v1.0.3

Module de Logs API

Le module de Logs API est une bibliothèque JavaScript conçue pour faciliter la récupération des logs d'une API associée et les envoyer vers une autre API chargée de les enregistrer. Il offre deux middlewares essentiels qui facilitent cette fonctionnalité :

• morganConfig : Ce middleware permet d'envoyer les logs des réponses correctes. Il est utilisé pour enregistrer les informations sur les requêtes réussies de l'API associée.

• errorMiddleware : Ce middleware permet d'envoyer les logs lorsqu'une erreur se produit. Il est utilisé pour enregistrer les informations sur les erreurs survenues lors du traitement des requêtes de l'API associée. Assure-toi de le placer à la fin de ton fichier serveur.js ou app.js, juste avant l'instruction module.exports = app;, pour capturer et gérer toutes les erreurs de manière appropriée.

Configuration

Le module de Logs API est configurable via quatre variables d'environnement :

• IDENTIFIANT_API_LOGS : C'est l'identifiant utilisé pour identifier l'API sur l'API qui enregistre les logs. Cette variable est obligatoire.
• KEY_API_LOGS : C'est la clé d'API utilisée pour authentifier l'envoi des logs vers l'API d'enregistrement. Cette variable est obligatoire.
• URL_API_LOGS : C'est l'URL de l'API qui enregistre les logs. Les logs seront envoyés à cette URL pour être stockés. Cette variable est obligatoire.
• BLACKLIST_API_LOGS : Cette variable permet de spécifier une liste de méthodes à blacklister pour le middleware morganConfig. Les requêtes associées à ces méthodes ne seront pas enregistrées dans les logs.

Installation

Pour installer le module de Logs API, utilisez npm en exécutant la commande suivante :

npm install modulelogs

Utilisation

Voici un exemple simple d'utilisation du module de Logs API dans une application Express.js :

// Importer le module
const moduleDeLogsApi = require('module-de-logs-api');

// Configurer les variables d'environnement
process.env.IDENTIFIANT_API_LOGS = 'identifiant-api-logs'; // Remplacez par votre identifiant
process.env.KEY_API_LOGS = 'cle-api-logs'; // Remplacez par votre clé d'API
process.env.URL_API_LOGS = 'https://api-enregistrement-logs.com'; // Remplacez par l'URL de votre API d'enregistrement
process.env.BLACKLIST_API_LOGS = 'POST,PUT';

// Utiliser les middlewares
app.use(moduleDeLogsApi.morganConfig);

// Autres middlewares et logique de l'application
// ...

// Middleware errorMiddleware
app.use(moduleDeLogsApi.errorMiddleware);

// Exporter l'application
module.exports = app;

Support

Nous espérons que le module de Logs API sera utile pour récupérer et enregistrer les logs de votre API associée. Si vous avez des questions ou des commentaires, n'hésitez pas à nous contacter à s.cao@m-energies.fr

Note Assure-toi de remplacer les valeurs IDENTIFIANT_API_LOGS, KEY_API_LOGS, URL_API_LOGS, BLACKLIST_API_LOGS