Azure Logger-Clientbibliothek für JavaScript– Version 1.1.2

Das @azure/logger-Paket kann verwendet werden, um die Protokollierung in den Azure SDKs für JavaScript zu aktivieren.

Die Protokollierung kann auf folgende Weise für das Azure SDK aktiviert werden:

• Festlegen der Umgebungsvariable AZURE_LOG_LEVEL
• Aufrufen von setLogLevel, importiert aus "@azure/logger"
• Aufrufen von „enable()“ in bestimmten Protokollierungen
• Verwenden der Umgebungsvariablen DEBUG.

Beachten Sie, dass AZURE_LOG_LEVEL, sofern festgelegt, Vorrang vor DEBUG hat. Verwenden Sie nur DEBUG ohne Angabe von AZURE_LOG_LEVEL oder Aufrufen von „setLogLevel“.

Erste Schritte

Installation

Installieren Sie diese Bibliothek mithilfe von npm wie folgt

npm install @azure/logger

Wichtige Konzepte

Das @azure/logger-Paket unterstützt die folgenden Protokollebenen (absteigend nach Ausführlichkeit sortiert):

• Ausführlich
• info
• warning
• error

Wenn Sie eine Protokollebene festlegen (entweder programmgesteuert oder über die Umgebungsvariable AZURE_LOG_LEVEL), werden alle Protokolle ausgegeben, deren Protokollebene der ausgewählten Ebene entspricht oder darunter liegt.

Wenn Sie die Protokollebene z. B. auf warning festlegen, werden alle Protokolle mit den Protokollebenen warning oder error ausgegeben.

HINWEIS: Beim Protokollieren von Anforderungen und Antworten bereinigen wir diese Objekte, um sicherzustellen, dass Header Authorization , die Geheimnisse enthalten, nicht protokolliert werden.

Anforderungs- und Antworttexte werden nie protokolliert. Header werden standardmäßig redigiert, es sei denn, sie sind in der folgenden Liste enthalten oder vom Client-SDK explizit zugelassen:

• "x-ms-client-request-id",
• "x-ms-return-client-request-id",
• "x-ms-useragent",
• "x-ms-correlation-request-id",
• "x-ms-request-id",
• "client-request-id",
• "ms-cv",
• "return-client-request-id",
• "traceparent",
• "Access-Control-Allow-Credentials",
• "Access-Control-Allow-Headers",
• "Access-Control-Allow-Methods",
• "Access-Control-Allow-Origin",
• "Access-Control-Expose-Headers",
• "Access-Control-Max-Age",
• "Access-Control-Request-Headers",
• "Access-Control-Request-Method",
• "Ursprung",
• "Annehmen",
• "Accept-Encoding",
• "Cache-Control",
• "Verbindung",
• "Content-Length",
• "Content-Type",
• "Datum",
• "ETag",
• "Läuft ab",
• "If-Match",
• "If-Modified-Since",
• "If-None-Match",
• "If-Unmodified-Since",
• "Last-Modified",
• "Pragma",
• "Request-ID",
• "Retry-After",
• "Server",
• "Transfer-Encoding",
• "User-Agent",
• "WWW-Authenticate",

Beispiele

Beispiel 1 – grundlegende Verwendung

const { EventHubClient } = require('@azure/event-hubs');

const logger = require('@azure/logger');
logger.setLogLevel('info');

// operations will now emit info, warning, and error logs
const client = new EventHubClient(/* params */);
client.getPartitionIds()
  .then(ids => { /* do work */ })
  .catch(e => { /* do work */ });
});

Beispiel 2 – Umleiten der Protokollausgabe

const { AzureLogger, setLogLevel } = require("@azure/logger");

setLogLevel("verbose");

// override logging to output to console.log (default location is stderr)
AzureLogger.log = (...args) => {
  console.log(...args);
};

Mit der Verwendung von AzureLogger ist es möglich, die Protokollierungsausgabe aus den Azure SDKs umzuleiten, indem Sie die AzureLogger.log-Methode außer Kraft setzen. Dies kann nützlich sein, wenn Sie die Protokolle an einen anderen Ort als „stderr“ umleiten wollen.

Nächste Schritte

Sie können die Tests lokal entwickeln und ausführen, indem Sie rushx test ausführen. Erkunden Sie den Ordner test, um die erweiterte Nutzung und das Verhalten der öffentlichen Klassen kennenzulernen.

Problembehandlung

Wenn bei Nutzung dieser Bibliothek Probleme auftreten, können Sie uns gerne ein Problem melden.

Mitwirken

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie die Anleitung für Mitwirkende, um mehr darüber zu erfahren, wie Sie den Code erstellen und testen können.