Freigeben über

Azure Logger-Clientbibliothek für JavaScript – Version 1.1.4

  • Artikel

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 umgebungsvariablen AZURE_LOG_LEVEL
  • Aufrufen von setLogLevel aus "@azure/Logger" importiert
  • Aufrufen von enable() für bestimmte Logger
  • Verwenden der umgebungsvariablen DEBUG.

Beachten Sie, dass AZURE_LOG_LEVEL, falls festgelegt, Vorrang vor DEBUG hat. Verwenden Sie DEBUG nur, ohne AZURE_LOG_LEVEL oder setLogLevel aufzurufen.

Erste Schritte

Installation

Installieren Sie diese Bibliothek mithilfe von npm wie folgt:

npm install @azure/logger

Schlüsselkonzepte

Das @azure/logger-Paket unterstützt die folgenden Protokollebenen, die in der Reihenfolge der ausführlichsten bis kleinsten ausführlich angegeben sind:

  • wortreich
  • Info
  • Warnung
  • Fehler

Wenn Sie eine Protokollebene entweder programmgesteuert oder über die AZURE_LOG_LEVEL Umgebungsvariable festlegen, werden alle Protokolle, die mit einer Protokollebene geschrieben wurden, die gleich oder kleiner als die von Ihnen ausgewählte Protokollebene ist, ausgegeben.

Wenn Sie beispielsweise die Protokollebene auf warning festlegen, werden alle Protokolle mit der Protokollebene warning oder error ausgegeben.

HINWEIS: Beim Protokollieren von Anforderungen und Antworten werden diese Objekte sanitiert, um sicherzustellen, dass Elemente wie Authorization Header, die geheime Schlüssel enthalten, nicht protokolliert werden.

Anforderungs- und Antworttexte werden nie protokolliert. Kopfzeilen sind standardmäßig redigiert, es sei denn, sie sind in der folgenden Liste enthalten oder explizit vom Client-SDK 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",
  • "Zugriffssteuerung-Allow-Credentials",
  • "Access-Control-Allow-Headers",
  • "Access-Control-Allow-Methods",
  • "Access-Control-Allow-Origin",
  • "Access-Control-Expose-Header",
  • "Access-Control-Max-Age",
  • "Access-Control-Request-Headers",
  • "Access-Control-Request-Method",
  • "Origin",
  • "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",
  • "Zuletzt geändert",
  • "Pragma",
  • "Anforderungs-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 : Ausgabe des Umleitungsprotokolls

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 AzureLoggerist es möglich, die Protokollierungsausgabe von den Azure-SDKs umzuleiten, indem die AzureLogger.log-Methode überschrieben wird. Dies kann nützlich sein, wenn Sie Protokolle an einen anderen Speicherort als stderr umleiten möchten.

Nächste Schritte

Sie können die Tests lokal erstellen und ausführen, indem Sie rushx testausführen. Erkunden Sie den Ordner test, um die erweiterte Verwendung und das Verhalten der öffentlichen Klassen anzuzeigen.

Fehlerbehebung

Wenn bei der Verwendung dieser Bibliothek Probleme auftreten, Sie ein Problem.

Beitragend

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie bitte den mitwirkenden Leitfaden, um mehr über das Erstellen und Testen des Codes zu erfahren.

Aufrufe