Freigeben über


Azure Logger-Clientbibliothek für JavaScript – Version 1.2.0

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 DEBUG Umgebungsvariablen.

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

Einrichtung

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 der wenigsten ausführlichen Protokolle angegeben werden:

  • wortreich
  • Info
  • Warnung
  • Fehler

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

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

HINWEIS: Beim Protokollieren von Anforderungen und Antworten bereinigen wir diese Objekte, um sicherzustellen, dass Dinge wie Authorization Header, die Geheimnisse 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-anforderungs-id",
  • "x-ms-return-client-anforderungs-id",
  • "x-ms-useragent",
  • "x-ms-korrelationsanforderung-id",
  • "x-ms-anforderung-id",
  • "client-anforderungs-id",
  • "ms-cv",
  • "Rückgabe-Client-Anforderungs-ID",
  • "traceparent",
  • "Zugriffssteuerung-Allow-Credentials",
  • "Zugriffssteuerung-Zulassen-Header",
  • "Zugriffskontrolle-Zulassen-Methoden",
  • "Zugriffskontrolle-Zulassen-Ursprung",
  • "Access-Control-Expose-Header",
  • "Zutrittskontrolle-Max-Alter",
  • "Zugriffssteuerung-Anforderungsheader",
  • "Zugriffssteuerung-Anforderung-Methode",
  • "Herkunft",
  • "Annehmen",
  • "Akzeptieren-Kodierung",
  • "Cache-Kontrolle",
  • "Verbindung",
  • "Inhalts-Länge",
  • "Inhaltstyp",
  • "Datum",
  • "ETag",
  • "Läuft ab",
  • "Wenn-Übereinstimmung",
  • "Wenn-geändert-seit",
  • "Wenn-keine-Übereinstimmung",
  • "Wenn-unverändert-seit",
  • "Zuletzt geändert",
  • "Pragma",
  • "Anforderungs-ID",
  • "Wiederholen nachher",
  • "Server",
  • "Übertragungs-Kodierung",
  • "User-Agent",
  • "WWW-Authentifizieren",

Beispiele

Beispiel 1 – grundlegende Verwendung

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Beispiel 2 : Ausgabe des Umleitungsprotokolls

import { setLogLevel, AzureLogger } from "@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 Beitragsleitfaden , um mehr über das Erstellen und Testen des Codes zu erfahren.