Libreria client di Azure Logger per JavaScript - versione 1.1.4

  • Articolo

Il pacchetto @azure/logger può essere usato per abilitare la registrazione negli SDK di Azure per JavaScript.

La registrazione può essere abilitata per Azure SDK nei modi seguenti:

  • Impostazione della variabile di ambiente AZURE_LOG_LEVEL
  • Chiamata di setLogLevel importato da "@azure/logger"
  • Chiamata di enable() in logger specifici
  • Uso della variabile di ambiente DEBUG.

Si noti che AZURE_LOG_LEVEL, se impostato, ha la precedenza su DEBUG. Usare DEBUG solo senza specificare AZURE_LOG_LEVEL o chiamare setLogLevel.

Introduttiva

Installazione

Installare questa libreria usando npm come indicato di seguito

npm install @azure/logger

Concetti chiave

Il pacchetto @azure/logger supporta i livelli di log seguenti specificati in ordine di dettaglio minimo:

  • prolisso
  • Informazioni
  • avvertimento
  • errore

Quando si imposta un livello di log, a livello di codice o tramite la variabile di ambiente AZURE_LOG_LEVEL, tutti i log scritti usando un livello di log uguale o inferiore a quello scelto verranno generati.

Ad esempio, l'impostazione del livello di log su warning causerà l'emissione di tutti i log con livello di log warning o error.

NOTA: quando si registrano richieste e risposte, questi oggetti vengono sanificati per assicurarsi che elementi come le intestazioni Authorization che contengono segreti non vengano registrati.

I corpi di richiesta e risposta non vengono mai registrati. Le intestazioni vengono elaborate per impostazione predefinita, a meno che non siano presenti nell'elenco seguente o consentite in modo esplicito dall'SDK client:

  • "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",
  • "Origine",
  • "Accept",
  • "Accept-Encoding",
  • "Cache-Control",
  • "Connessione",
  • "Content-Length",
  • "Content-Type",
  • "Date",
  • "ETag",
  • "Expires",
  • "If-Match",
  • "If-Modified-Since",
  • "If-None-Match",
  • "If-Unmodified-Since",
  • "Ultima modifica",
  • "Pragma",
  • "Request-Id",
  • "Retry-After",
  • "Server",
  • "Transfer-Encoding",
  • "User-Agent",
  • "WWW-Authenticate",

Esempi

Esempio 1 - Utilizzo di base

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

Esempio 2: reindirizzare l'output del log

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

Usando AzureLogger, è possibile reindirizzare l'output di registrazione dagli SDK di Azure eseguendo l'override del metodo AzureLogger.log. Questo può essere utile se si desidera reindirizzare i log a una posizione diversa da stderr.

Passaggi successivi

È possibile compilare ed eseguire i test in locale eseguendo rushx test. Esplorare la cartella test per visualizzare l'utilizzo e il comportamento avanzati delle classi pubbliche.

Risoluzione dei problemi

Se si verificano problemi durante l'uso di questa libreria, è possibile segnalare un problema.

Contribuire

Per contribuire a questa libreria, leggere la guida contribuire per altre informazioni su come compilare e testare il codice.

impressioni