Partilhar via

Biblioteca de cliente 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 registro em 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/logger"
  • Chamando enable() em registradores 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.

Primeiros passos

Instalação

Instale esta biblioteca usando npm da seguinte maneira:

npm install @azure/logger

Conceitos-chave

O pacote @azure/logger suporta os seguintes níveis de log especificados na ordem do mais detalhado para o menos detalhado:

  • Verborrágico
  • informação
  • Advertência
  • 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 inferior ao escolhido serão emitidos.

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

NOTA: Ao registrar solicitações e respostas, limpamos esses objetos para garantir que itens como cabeçalhos de Authorization que contêm segredos não sejam registrados.

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

  • "X-MS-CLIENT-REQUEST-ID",
  • "X-MS-RETURN-CLIENT-REQUEST-ID",
  • "x-ms-useragent",
  • "X-ms-correlação-solicitação-id",
  • "X-MS-REQUEST-ID",
  • "ID do pedido do cliente",
  • "ms-cv",
  • "Retorno-cliente-pedido-ID",
  • "traceparent",
  • "Acesso-Controle-Permitir-Credenciais",
  • "Access-Control-Allow-Headers",
  • "Acesso-Controlo-Permitir-Métodos",
  • "Acesso-Controlo-Permitir-Origem",
  • "Access-Control-Expose-Headers",
  • "Acesso-Controlo-Max-Age",
  • "Acesso-Controlo-Pedido-Cabeçalhos",
  • "Acesso-Controlo-Pedido-Método",
  • "Origem",
  • "Aceitar",
  • "Aceitação-Codificação",
  • "Cache-Control",
  • "Conexão",
  • "Comprimento do conteúdo",
  • "Tipo de conteúdo",
  • "Data",
  • "ETag",
  • "Caduca",
  • "If-Match",
  • "se-modificado-desde",
  • "Se-Nenhum-Correspondência",
  • "Se-Inalterado-Desde",
  • "Última modificação",
  • "Pragma",
  • "ID do pedido",
  • "Repetir-Depois",
  • "Servidor",
  • "Transferência-Codificação",
  • "User-Agent",
  • "WWW-Autenticar",

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 - saída de log de redirecionamento

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 os logs para um local diferente do stderr.

Próximos passos

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

Solução de problemas

Se você tiver problemas ao usar esta biblioteca, sinta-se à vontade para registrar um problema.

Contribuição

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

Impressões