Biblioteca de clientes do Azure Logger para JavaScript – versão 1.1.4

  • Artigo

O pacote @azure/logger pode ser usado para habilitar o registro em log nos SDKs do Azure para JavaScript.

O log pode ser habilitado para o SDK do Azure das seguintes maneiras:

  • Definindo a variável de ambiente AZURE_LOG_LEVEL
  • Chamando setLogLevel importado de "@azure/agente"
  • Chamando enable() em agentes específicos
  • Usando a variável de ambiente DEBUG.

Observe que AZURE_LOG_LEVEL, se definido, tem precedência sobre DEBUG. Use apenas DEBUG sem especificar AZURE_LOG_LEVEL ou chamar setLogLevel.

Introdução

Instalação

Instalar esta biblioteca usando o npm da seguinte maneira

npm install @azure/logger

Principais conceitos

O pacote @azure/logger dá suporte aos seguintes níveis de log especificados na ordem das mais detalhadas para menos detalhadas:

  • prolixo
  • informação
  • aviso
  • erro

Ao definir um nível de log, programaticamente ou por meio da variável de ambiente AZURE_LOG_LEVEL, todos os logs gravados usando um nível de log igual ou menor que o escolhido serão emitidos.

Por exemplo, definir o nível de log como warning fará com que todos os logs que têm o nível de log warning ou error sejam emitidos.

OBSERVAÇÃO: ao registrar em log solicitações e respostas, higienizamos esses objetos para garantir que coisas como Authorization cabeçalhos que contêm segredos não sejam registradas.

Os corpos de solicitação e resposta nunca são registrados. Os cabeçalhos são redigidos por padrão, a menos que estejam presentes na lista a seguir ou explicitamente permitidos pelo SDK do cliente:

  • "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",
  • "Origem",
  • "Aceitar",
  • "Aceitar codificação",
  • "Cache-Control",
  • "Conexão",
  • "Comprimento do conteúdo",
  • "Tipo de conteúdo",
  • "Date",
  • "ETag",
  • "Expira",
  • "If-Match",
  • "If-Modified-Since",
  • "If-None-Match",
  • "If-Unmodified-Since",
  • "Última modificação",
  • "Pragma",
  • "ID de solicitação",
  • "Retry-After",
  • "Servidor",
  • "Transfer-Encoding",
  • "User-Agent",
  • "WWW-Authenticate",

Exemplos

Exemplo 1 – uso básico

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

Exemplo 2 – redirecionar a saída do 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, é possível redirecionar a saída de log dos SDKs do Azure substituindo o método AzureLogger.log. Isso pode ser útil se você quiser redirecionar logs para um local diferente de stderr.

Próximas etapas

Você pode compilar e executar os testes localmente executando rushx test. Explore a pasta test para ver o uso e o comportamento avançados das classes públicas.

Solucionando problemas

Se você tiver problemas ao usar essa biblioteca, fique à vontade para registrar um problema.

Contribuindo

Se você quiser contribuir com essa biblioteca, leia o guia de contribuição para saber mais sobre como criar e testar o código.

impressões