Best Practice: Logging

Bei der Adapter-Entwicklung sollte man darauf achten, dass man aussagekräftige Logs schreibt. Dabei gilt es, die jeweiligen Log-Level zu berücksichtigen. Je nach eingestelltem Log-Level auf der aktuellen Instanz werden unterschiedlich viele Informationen geloggt.

Das Standard-Log-Level eines Adapters / neuer Instanzen wird in der Konfiguration in der io-package.json festgelegt (common.loglevel). Dieses Level kann später vom Benutzer auf jeder einzelnen Instanz angepasst werden!

this.log.silly('silly message'); // log message with silly level
this.log.debug('debug message'); // log message with debug level
this.log.info('info message');   // log message with info level (enabled by default for all adapters)
this.log.warn('warning');        // log message with warn level
this.log.error('error');         // log message with error level

Die Level sind dabei hierarchisch: Steht eine Instanz auf info, werden auch warn und error geloggt - aber kein debug oder silly. Gültige Werte für common.loglevel sind entsprechend silly, debug, info, warn und error.

Als Faustregel:

• error - Etwas ist fehlgeschlagen und der Nutzer muss handeln (z. B. falsche Zugangsdaten)
• warn - Etwas ist auffällig, der Adapter läuft aber weiter (z. B. unerwartete Antwort eines Gerätes)
• info - Wenige, wirklich relevante Meldungen (z. B. "Verbindung hergestellt")
• debug - Details zur Fehlersuche
• silly - Sehr detaillierte Ausgaben (z. B. komplette Requests/Responses)