Dela via


Azure Logger-klientbibliotek för JavaScript – version 1.1.2

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 miljövariabeln AZURE_LOG_LEVEL
  • Anropar setLogLevel som importerats från "@azure/logger"
  • Anropa enable() för specifika loggare
  • DEBUG Använda miljövariabeln.

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

Komma igång

Installation

Installera det här biblioteket med npm på följande sätt

npm install @azure/logger

Viktiga begrepp

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

  • utförlig
  • information
  • varning
  • fel

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

Om du till exempel anger loggnivån till warning kommer alla loggar som har loggnivån warning eller error som ska genereras att genereras.

Obs! När du loggar begäranden och svar rensar vi dessa objekt för att se till att sådant som Authorization rubriker som innehåller hemligheter inte loggas.

Begärande- och svarskroppar 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",
  • "Ursprung",
  • "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",
  • "Begäran-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 kan AzureLoggerdu omdirigera loggningsutdata från Azure SDK:erna genom att AzureLogger.log åsidosätta 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 rushx testköra . test Utforska mappen 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 skapa ett problem.

Bidra

Om du vill bidra till det här biblioteket kan du läsa bidragsguiden om du vill veta mer om hur du skapar och testar koden.

Visningar