Azure Logger-klientbibliotek för JavaScript – version 1.2.0

Paketet @azure/logger kan användas för att aktivera loggning i Azure SDK:er för JavaScript.

Loggning kan aktiveras för Azure SDK på följande sätt:

• Ange AZURE_LOG_LEVEL miljövariabeln
• Anropa setLogLevel importerat från "@azure/logger"
• Anropa enable() på specifika loggare
• Använda miljövariabeln DEBUG .

Observera att AZURE_LOG_LEVEL, om det anges, har företräde framför FELSÖKNING. Använd endast FELSÖKNING utan att ange AZURE_LOG_LEVEL eller anropa setLogLevel.

Komma igång

Installation

Installera det här biblioteket med npm enligt följande

npm install @azure/logger

Viktiga begrepp

Paketet @azure/logger stöder följande loggnivåer som anges i ordning från mest utförlig till minst utförlig:

• mångordig
• information
• varning
• fel

När du anger en loggnivå, antingen programmatiskt eller via miljövariabeln AZURE_LOG_LEVEL , genereras alla loggar som skrivs med en loggnivå som är lika med eller mindre än den du väljer.

Om du till exempel ställer in loggnivån warning på kommer alla loggar som har loggnivån warning eller error att genereras.

När du loggar begäranden och svar sanerar vi dessa objekt för att se till att saker som Authorization rubriker som innehåller hemligheter inte loggas.

Begärande- och svarsorgan loggas aldrig. Rubriker redigeras som standard, såvida de inte finns i följande lista eller uttryckligen tillåts av klient-SDK:t:

• "x-ms-client-request-id"
• "x-ms-return-client-request-id",
• "x-ms-useragent",
• "x-ms-correlation-request-id",
• "x-ms-request-id",
• "klient-begäran-ID",
• "ms-cv",
• "return-client-request-id",
• "traceparent",
• "Access-Control-Allow-Credentials"
• "Access-Control-Allow-Headers"
• "Åtkomst-Kontroll-Tillåt-Metoder",
• "Åtkomstkontroll-Tillåt-Ursprung",
• "Access-Control-Expose-Headers"
• "Åtkomstkontroll-Max-Ålder",
• "Access-Control-Request-Headers"
• "Åtkomstkontroll-Begäran-Metod",
• "Ursprung",
• "Acceptera",
• "Acceptera-kodning",
• "Cache-Kontroll",
• "Anslutning",
• "Innehållslängd",
• "Innehållstyp"
• "Datum",
• "ETag",
• "Upphör att gälla",
• "Om-Match",
• "Om-Ändrad-Sedan",
• "Om-ingen-match",
• "Om-oförändrad-sedan",
• "Senast ändrad"
• "Pragma",
• "Begäran-ID",
• "Försök igen efter"
• "Server",
• "Överföringskodning",
• "Användaragent",
• "WWW-Autentisera",

Exempel

Exempel 1 – grundläggande användning

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

setLogLevel("info");

Exempel 2 – utdata från omdirigeringslogg

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);
};

Med AzureLoggerhjälp av är det möjligt att omdirigera loggningsutdata från Azure SDK:er genom att åsidosätta AzureLogger.log metoden. Detta kan vara användbart om du vill omdirigera loggar till en annan plats än stderr.

Nästa steg

Du kan skapa och köra testerna lokalt genom att köra rushx test. Utforska mappen test för att se avancerad användning och beteende för de offentliga klasserna.

Felsökning

Om du stöter på problem när du använder det här biblioteket kan du fil ett problem.

Bidragande

Om du vill bidra till det här biblioteket kan du läsa bidragsguide för att lära dig mer om hur du skapar och testar koden.