Azure Logger-klientbibliotek för JavaScript – version 1.1.4

  • Artikel

Det @azure/logger paketet 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

@azure/logger-paketet stöder följande loggnivåer som anges i ordning efter de mest utförliga till minst utförliga:

  • mångordig
  • information
  • varning
  • fel

När du ställer in en loggnivå, antingen programmatiskt eller via AZURE_LOG_LEVEL miljövariabel, 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 på warning kommer alla loggar som har loggnivån warning eller error att genereras.

OBS: 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",
  • "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",
  • "Origin",
  • "Acceptera",
  • "Accept-Encoding",
  • "Cache-Control",
  • "Anslutning",
  • "Innehållslängd",
  • "Innehållstyp"
  • "Datum",
  • "ETag",
  • "Upphör att gälla",
  • "If-Match",
  • "If-Modified-Since",
  • "If-None-Match",
  • "If-Unmodified-Since",
  • "Senast ändrad"
  • "Pragma",
  • "Request-Id",
  • "Försök igen efter"
  • "Server",
  • "Transfer-Encoding",
  • "User-Agent",
  • "WWW-Authenticate",

Exempel

Exempel 1 – grundläggande användning

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

Exempel 2 – utdata från omdirigeringslogg

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

Med hjälp av AzureLoggerkan du omdirigera loggningsutdata från Azure SDK:er genom att åsidosätta metoden AzureLogger.log. 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.

visningar