Configuração do agente Python

Normalmente você configura seu agente Python a partir de um arquivo de configuração local no sistema host do agente. Forneça o caminho para o arquivo de configuração na inicialização usando um destes métodos:

• Ao chamar newrelic.agent.initialize(), forneça o caminho para o arquivo de configuração como primeiro argumento.

  OU

• Defina a variável de ambiente NEW_RELIC_CONFIG_FILE . Se você usar o script wrapper newrelic-admin , deverá usar a variável de ambiente porque o script wrapper chama o agente automaticamente.

  O arquivo de configuração usa uma estrutura semelhante aos arquivos .ini do Microsoft Windows. Para obter mais informações, consulte a documentação de formato de arquivo do módulo Python ConfigParser.

  Dica

  Um arquivo de configuração de amostra está incluído no agente Python como newrelic/newrelic.ini. Você também pode gerar um a partir do script newrelic-admin usando o comando generate-config ou fazer download de uma cópia em nosso repositório de download.

A configuração no lado do servidor permite definir determinadas configurações na interface do New Relic. Isso aplica suas alterações automaticamente a todos os agentes, mesmo que eles sejam executados em vários hosts. Quando disponível, este documento inclui os rótulos de interface para configuração do lado do servidor em opções de configuração individuais como Server-side label.

As variáveis de ambiente permitem substituir os padrões de determinadas configurações principais. Se a configuração equivalente estiver listada explicitamente no arquivo de configuração do agente, as configurações do arquivo de configuração terão precedência sobre a variável de ambiente. Quando disponíveis, as variáveis de ambiente são documentadas abaixo em opções de configuração individuais como Environ variable.

Para configurações simples, você pode usar as variáveis de ambiente em conjunto com a configuração no lado do servidor e evitar completamente o arquivo de configuração do agente. Esta é a configuração padrão do Heroku, onde a instalação do complemento New Relic preenche automaticamente as variáveis de ambiente necessárias.

Se você estiver usando New Relic CodeStream para monitor o desempenho do seu IDE, talvez você também queira associar o repositório aos seus serviços e associar SHAs de compilação ou tags de lançamento aos erros.

Para determinados servidores WSGI, você pode substituir o nome do aplicativo e capturar configurações de atributo por solicitação. Isso é possível com servidores WSGI onde é possível definir pares de valores principais adicionais que são passados para o dicionário de ambiente WSGI por solicitação.

Defina esses valores com as strings on, off, true, false, 1 e 0. Se definido a partir de um mecanismo de configuração implementado usando código Python, os objetos Python avaliados como True ou False também serão aceitos.

Além de poder substituir determinadas definições de configuração do agente, você pode definir outras definições de configuração por solicitação com sua chave de ambiente WSGI:

Especifica o chave de licençada sua conta New Relic. Esta chave associa a métrica do seu aplicativo à sua conta New Relic.

O nome do aplicativo usado para agregar dados na interface do New Relic. Para relatar dados para vários aplicativos ao mesmo tempo, especifique uma lista de nomes separados por ponto e vírgula ;. Não coloque um espaço antes do ponto e vírgula, o que faz com que o analisador de configuração do Python interprete o nome como um comentário incorporado.

Quando true, o agente coleta dados de desempenho sobre seu aplicativo e reporta esses dados ao nosso coletor de dados.

Quando true, o agente instrumentará seu aplicativo da web, mas não enviará nenhum dado real. Neste modo offline, você não será cobrado por um agente ativo.

Use o modo de desenvolvedores para testar novas versões do agente ou teste o agente em pacotes de terceiros em um ambiente de desenvolvedores. O modo offline não é uma forma de executar o APM localmente, pois as métricas coletadas pelo agente não são reportadas em lugar nenhum.

Define o nome de um arquivo de log, que é útil para depurar problemas com o agente. Isso não é definido por padrão, pois o agente não conhece o usuário pai do processo do aplicativo Web ou em quais diretórios esse processo tem permissão para gravar. Para obter informações detalhadas, consulte logging do agente Python.

Independentemente do que você definir, certifique-se de que as permissões para o diretório que o contém e o próprio arquivo estejam corretas e que o usuário que seu aplicativo da Web executa possa gravar no arquivo.

Define o nível de detalhe da mensagem do log, caso você tenha definido o local do arquivo de log. Este log_level não afetará o nível de log do módulo de registro do Python. Os valores possíveis, em ordem crescente de detalhes, são critical, error, warning, info e debug.

Para relatar problemas de agentes, a configuração mais útil é debug. Porém, debug gera muitas informações muito rapidamente, portanto não mantenha o agente neste nível por mais tempo do que o necessário para reproduzir seu problema.

O modo de alta segurança impõe determinadas configurações de segurança e evita que sejam substituídas, para que nenhum dado confidencial seja enviado para nós. Ativar o modo de alta segurança significa que os parâmetros da solicitação não serão coletados e você não poderá enviar SQL bruto.

Para ativar o modo de alta segurança, defina-o como true no arquivo de configuração .ini local and e ative-o na página Account settings . Para obter mais informações, consulte Alta segurança.

Por padrão, o agente Python tenta se conectar diretamente aos nossos servidores. Se houver um firewall entre seu host e nosso coletor que exija o uso de um proxy HTTP, defina proxy_host e proxy_port com os valores necessários para seu proxy HTTP. Se a autenticação de proxy for implementada pelo proxy HTTP, configure também proxy_user e proxy_pass.

A configuração proxy_scheme determina qual esquema de protocolo é usado para se comunicar com o proxy HTTP. Quando definido como http, o agente usa um túnel SSL por meio do proxy HTTP para criptografia de ponta a ponta.

Em vez de definir as configurações proxy_scheme, proxy_host e proxy_port , você também pode definir a configuração proxy_host como um URI válido para o proxy. Inclua o esquema, host e porta; por exemplo, http://proxy-host:8000. Isso também funciona se você definir os detalhes do proxy HTTP com a variável de ambiente NEW_RELIC_PROXY_HOST .

Define o nome do arquivo de log de auditoria. Se definido, o agente registra detalhes de mensagens transmitidas entre o processo monitor e o coletor. Isso permite avaliar a segurança do agente Python.

Use um caminho absoluto, a menos que você tenha certeza de qual será o diretório de trabalho do seu aplicativo na inicialização. Qualquer que seja a configuração, certifique-se de que as permissões do diretório que o contém e do próprio arquivo estejam corretas. Certifique-se também de que o usuário pai do seu aplicativo Web possa gravar no arquivo.

Adiciona etiqueta. Especifique name:value separado por dois pontos : e separe a tag adicional com ponto e vírgula ;.

labels = Server:One;Data Center:Primary

Define o nome do host a ser exibido na interface do APM. Se definido, substitui o nome do host padrão que o agente captura automaticamente.

Define o api_key a ser usado com newrelic-admin record-deploy.

Substituição manual do caminho para seu pacote de CA local. Este pacote CA será utilizado para validar o certificado SSL apresentado pelo nosso serviço de coleta de dados.

Registraremos o rastreamento da transação quando eles excederem esse limite. O formato é um número de segundos (são permitidos pontos decimais).

Veja nossa entrada no glossário para apdex_t

Esta configuração pode ser usada para ativar ou desativar todos os atributos.

Se atributo estiver habilitado, as chaves de atributo encontradas nesta lista serão enviadas para nós. As chaves na lista devem ser separadas por espaços, conforme mostrado abaixo:

key1 key2 key3

As regras para atributo podem ser encontradas na página de atributo do agente.

Todas as chaves de atributo encontradas nesta lista não serão enviadas para nós. As chaves na lista devem ser separadas por espaços, conforme mostrado abaixo:

key1 key2 key3

As regras para atributo podem ser encontradas na página de atributo do agente.

Quando definido como true, ativa o AI Monitoring.

Quando definido como false, desativa a instrumentação que registra eventos de resumo e mensagem para dados de grande modelo de linguagem transmitidos.

Se definido como false, o agente omitirá o conteúdo de entrada e saída (como sequências de texto de prompt e respostas) capturado no evento LLM. Esta é uma configuração de segurança opcional se você não quiser registrar dados confidenciais enviados e recebidos de seus LLMs.

Se ativado, o tracer de transação captura informações profundas sobre transações lentas.

Limite em segundos para quando coletar um rastreamento da transação. Quando o tempo de resposta de uma ação do controlador excede esse limite, o agente registra um rastreamento da transação. Os valores válidos são qualquer float positivo ou apdex_f (quatro vezes apdex_t).

Quando o rastreador de transação está habilitado, o agente pode registrar instruções SQL. O gravador tem três modos: off (não envia SQL), raw (envia a instrução SQL em seu formato original) e obfuscated (retira literais numéricos e de string).

A maioria dos frameworks web (incluindo Django) parametrizam consultas SQL para que elas não contenham realmente os valores usados para preencher a consulta. Se você usar o modo raw com uma dessas estruturas, o agente Python verá apenas o SQL antes da inserção de valores. O SQL parametrizado será muito parecido com o modo obfuscated .

Limite em segundos para coletar rastreamento de pilha de chamadas SQL. Quando as instruções SQL excedem esse limite, o agente captura o stack trace atual. Isso é útil para identificar onde as chamadas SQL longas se originam em um aplicativo.

Determina se o agente Python capturará planos de consulta para consultas SQL lentas. Compatível apenas com MySQL e PostgreSQL.

Consulta no rastreamento da transação que excedam esse limite reportarão dados de consulta lenta e quaisquer planos de explicação disponíveis. Explique que a coleta do plano não acontecerá se transaction_tracer.explain_enabled for false.

Esta configuração pode ser usada para ativar ou desativar todos os atributos de rastreamento da transação. Se attributes.enabled no nível raiz for false, nenhum atributo será enviado para rastrear a transação, independentemente de como esta definição de configuração (transaction_tracer.attributes.enabled) estiver definida.

Se os atributo estiverem habilitados para rastreamento da transação, todas as chaves de atributo encontradas nesta lista serão enviadas para nós no rastreamento da transação. Para mais informações, consulte as regras de atribuição de agentes.

Todas as chaves de atributo encontradas nesta lista não serão enviadas no rastreamento da transação. Para mais informações, consulte as regras de atribuição de agentes.

Para as funções ou métodos especificados, o agente capturará instrumentação adicional de temporização de função. Especifique esses nomes no formato module:function ou module:class.function.

O uso de curingas (globbing) para nomes de funções e classes é possível usando padrões suportados pelo módulo fnmatch . Os caminhos dos módulos não são suportados por curingas. Especifique os padrões no formato module:function* ou module:class.*.

Por exemplo, se você deseja adicionar rastreamento de função a todas as funções de validação no arquivo abaixo:

def validate_credentials():
…
def validate_status():
…
def format_message():
…

Adicione a seguinte linha ao arquivo de configuração do agente para incluir o rastreamento de função para todas as funções de validação em my-app/common/utils.py usando caracteres curinga.

[newrelic]
...
transaction_tracer.function_trace = common.utils:validate*

Esta configuração pode ser usada para ativar ou desativar todos os atributos dos segmentos de rastreamento da transação. Se attributes.enabled no nível raiz for false, nenhum atributo será enviado para segmentos de rastreamento da transação, independentemente de como esta definição de configuração (transaction_segments.attributes.enabled) estiver definida.

Se os atributo estiverem habilitados para segmentos de trace da transação, todas as chaves de atributo encontradas nesta lista serão enviadas em segmentos de trace da transação. Para mais informações, consulte as regras de atribuição de agentes.

Todas as chaves de atributo encontradas nesta lista não serão enviadas em segmentos de rastreamento da transação. Para mais informações, consulte as regras de atribuição de agentes.

Se ativado, o coletor de erros captura informações sobre exceções não detectadas.

Para parar de coletar erros específicos, defina isso como uma lista separada por espaços de nomes de tipos de exceção do Python a serem ignorados. Use o formato module:class para o nome da exceção.

Lista códigos de status HTTP que o agente deve ignorar em vez de registrar como erros. Liste códigos de status adicionais como números inteiros separados por espaços e especifique intervalos com um hífen - separador entre os valores inicial e final. Para adicionar um dos códigos padrão à sua lista de permissões, coloque um ponto de exclamação ! no início do código.

Esta configuração só é compatível com alguns frameworks web, pois alguns frameworks não usam exceções para retornar respostas HTTP.

Impede que classes de exceção especificadas afetem taxa de erros ou pontuação Apdex enquanto ainda relatam os erros ao APM. Defina isso como uma lista separada por espaços dos nomes de tipos de exceção do Python esperados. Use o formato module:class para o nome da exceção.

Impede que códigos de status HTTP especificados afetem a taxa de erros ou a pontuação Apdex enquanto ainda relatam os erros ao APM. Liste os códigos de status como números inteiros separados por espaços e especifique intervalos com um hífen - separador entre os valores inicial e final. Para negar um dos códigos da sua lista, coloque um ponto de exclamação ! no início do código.

Esta configuração só é compatível com alguns frameworks web, pois alguns frameworks não usam exceções para retornar respostas HTTP.

Esta configuração pode ser usada para ativar ou desativar todos os atributos para erros de rastreamento. Se attributes.enabled for false no nível raiz, nenhum atributo será enviado para erros de rastreamento, independentemente de como essa definição de configuração (error_collector.attributes.enabled) estiver definida.

Se atributo estiver habilitado para erros de rastreamento, todas as chaves de atributo encontradas nesta lista serão enviadas para erros de rastreamento. Para mais informações, consulte as regras de atribuição de agentes.

As chaves atributo encontradas nesta lista não serão enviadas em erros de rastreamento. Para mais informações, consulte as regras de atribuição de agentes.

Se ativado, o coletor de erros captura dados de eventos para análise avançada. Para obter mais informações, consulte Erros de APM.

Habilita monitoramento do Browser. Para obter mais informações, consulte Tempo de carregamento da página em Python.

Para frameworks web Python suportado, esta configuração permite a inserção automática dos fragmentos JavaScript de monitoramento do browser.

Especifique o(s) HTML Content-Type(s) que nosso agente de monitoramento de Browser deverá auto-instrumentar. Adicione entradas adicionais em uma lista separada por espaços.

browser_monitoring.content_type = text/html application/xhtml+xml

Esta configuração pode ser usada para ativar ou desativar todos os atributos de monitoramento do Browser. Estes são os dados que são enviados para o evento de visualização de página. Se attributes.enabled for falso no nível raiz, nenhum atributo será enviado no monitoramento do Browser independente de como a configuração (browser_monitoring.attributes.enabled) estiver definida.

Se atributo estiver habilitado para browser_monitoring, todas as chaves de atributo encontradas nesta lista serão enviadas em visualizações de página. Para mais informações, consulte as regras de atribuição de agentes.

Todas as chaves de atributo encontradas nesta lista não serão enviadas em page views. Para mais informações, consulte as regras de atribuição de agentes.

Os dados de eventos de transação permitem a utilização de informações adicionais como histograma e percentil.

Esta configuração pode ser usada para ativar ou desativar todos os atributos do evento de transação. Se attributes.enabled for false no nível raiz, nenhum atributo será enviado para o evento de transação, independentemente de como essa definição de configuração (transaction_events.attributes.enabled) estiver definida.

Se o atributo estiver habilitado para evento de transação, todas as chaves de atributo encontradas nesta lista serão enviadas no evento de transação. Para mais informações, consulte as regras de atribuição de agentes.

Todas as chaves de atributo encontradas nesta lista não serão enviadas em evento de transação. Observe que excluir atributo do evento de transação não exclui do evento span. Para mais informações, consulte as regras de atribuição de agentes.

Permitir a gravação do evento na API de eventos por meio de record_custom_event().

Quando habilitado, o agente coleta métricas de instância do datastore (como host e porta) para algum driver do banco de dados. Estes também são relatados na consulta lenta trace e trace da transação.

Quando habilitado, o agente coleta o nome do banco de dados para algum driver do banco de dados. O nome do banco de dados é informado na consulta lenta trace e trace da transação.

Permite distributed tracing

Essa configuração pode ser usada para ativar ou desativar se o agente Python envia spans.

Esta configuração pode ser usada para ativar ou desativar todos os atributos do evento span. Se attributes.enabled no nível raiz for false, nenhum atributo será enviado para span evento, independentemente de como esta definição de configuração (span_events.attributes.enabled) estiver definida. Para mais informações, consulte as regras de atribuição de agentes.

Se atributo estiver habilitado para span evento, todas as chaves de atributo encontradas nesta lista serão enviadas em span evento. Para mais informações, consulte as regras de atribuição de agentes.

Todas as chaves de atributo encontradas nesta lista não serão enviadas no evento span. Para mais informações, consulte as regras de atribuição de agentes.

Limite de evento analítico por minuto enviado por uma instância do agente Python para a New Relic.

• Limita quantos eventos personalizados por minuto que uma instância do agente Python pode enviar para o New Relic.
• Ao configurar o agente para AI Monitoring, defina o valor máximo 100000 para garantir que o agente capture a quantidade máxima de eventos LLM.

• Limite de evento span por minuto enviado por uma instância do agente Python para o New Relic.
• Ao configurar o agente para AI Monitoring, defina o valor máximo 10000 para garantir que o agente capture a quantidade máxima de rastreamento distribuído.

Limite de evento de erro por minuto enviado por uma instância do agente Python para New Relic.

Defina como false para desativar as informações do loop de eventos.

Limite em segundos por quanto tempo uma transação deve bloquear o loop de eventos antes de gerar informações de loop de eventos.

Quando habilitado, o agente irá gerar e enviar métricas de runtime por ID do processo.

Quando habilitado, o agente irá gerar e enviar métricas de coleta de lixo.

O agente reporta métricas de contagem de objetos para os tipos de objetos mais comuns coletados pelo coletor de lixo. Para cada tipo de objeto, esta configuração permite definir o número máximo de métricas individuais que serão amostradas.

Defina como false para desativar a coleta de atributos do agente para o nível do código métrico.

O commit sha. O sha inteiro pode ser usado ou apenas os primeiros sete caracteres (por exemplo 734713b).

Uma tag de lançamento (como v0.1.209 ou release-209).

Se true, habilita a decoração de log e a coleta de evento de log e métrica de log se estes sub-recursos de configuração também estiverem habilitados. Se false, nenhum recurso de instrumentação de criação de log será ativado.

Se true, o agente captura os registros de log emitidos pelo seu aplicativo e os encaminha para o New Relic. application_logging.enabled também deve ser true para que esta configuração tenha efeito.

Se true, o agente capturará os dados de contexto disponíveis (extras, atributo de mensagem de dicionário, atributo fornecido pelo framework de registro) e adicionará seu conteúdo como atributo nos logs encaminhados para New Relic. Você pode controlar esse comportamento nas configurações da seção application_logging.forwarding.context_data .

Se atributo estiver habilitado para context_data, todas as chaves de atributo encontradas nesta lista serão enviadas para nós no rastreamento da transação. Para mais informações, consulte as regras de atribuição de agentes.

Todas as chaves de atributo encontradas nesta lista não serão enviadas em context_data. Para mais informações, consulte as regras de atribuição de agentes.

Número de registros de log a serem enviados por minuto para o New Relic. Esta configuração controla o consumo geral de memória ao usar o recurso de encaminhamento de logs.

Defina um valor mais baixo para reduzir a quantidade de linhas de log enviadas (pode causar amostragem de log). Defina um valor mais alto para enviar mais linhas de log.

Cada log recebe a mesma prioridade que sua transação associada. log que ocorrem fora de uma transação receberão uma prioridade aleatória. Alguns registros podem não ser incluídos porque são limitados por max_samples_stored. Por exemplo, se o registro em log max_samples_stored estiver definido como 10.000 e a transação 1 tiver 10.000 entradas de log, somente as entradas de log da transação 1 serão registradas. Se a transação 1 tiver menos de 10.000 logs, você receberá todos os logs da transação 1. Se ainda houver espaço, você receberá todo o log da transação 2 e assim por diante.

Se após todos os logs de transação amostrados forem registrados, e eles não atingirem o limite em max_samples_stored, então será enviada a mensagem do log de transação amostrada que não estava em nossa amostragem. Se sobrar alguma, as mensagens do log fora da transação serão registradas.

Se true, o agente captura métricas relacionadas às linhas de log enviadas pela sua aplicação. application_logging.enabled também deve ser true para que esta configuração tenha efeito.

Se true, o agente decora o log com metadados para vincular entidade, hosts, rastreamento e spans. application_logging.enabled também deve ser true para que esta configuração tenha efeito.

Quando habilitado, o agente irá capturar transações para consulta de introspecção no GraphQL.

Defina como true para ativar a coleta de atributos do agente para métricas de aprendizado de máquina.

Defina como true para ativar a captura do valor de inferência bruto.

Permitir a gravação de eventos de aprendizado de máquina na API de eventos por meio de record_ml_event().

Se true, o agente detectará automaticamente que está em execução em um ambiente AWS.

Se true, o agente detecta automaticamente que está em execução em um ambiente do Azure.

Se true, o agente detectará automaticamente que está em execução em um ambiente do Google Cloud Platform.

Se true, o agente detectará automaticamente que está em execução em um ambiente Pivotal Cloud Foundry.

Se true, o agente detecta automaticamente que está em execução no Docker.

Se ativado, o agente captura detalhes da consulta SQL de longa execução ao banco de dados.

Permite agendar sessões de criação de perfil de thread. O thread profiler capturará periodicamente um instantâneo da stack de chamadas para cada thread ativo no aplicativo para construir uma árvore de chamadas estatisticamente representativa.

Permite rastreamento multiaplicativo, que conecta seus aplicativos e serviços dentro de sua arquitetura orientada a serviços.

Se ativado, as mensagens de exceção serão removidas do rastreamento de erros antes de serem enviadas ao coletor, para evitar a captura inadvertida de informações confidenciais. Esta opção é habilitada automaticamente no modo de alta segurança.

As exceções listadas na sua lista de permissões não terão suas mensagens removidas, mesmo que strip_exception_messages.enabled seja true. A lista de permissões é uma sequência de tipos de exceção separados por espaço, cada um na forma de module:exception_name. Liste as exceções integradas como exception_name; você não precisa acrescentar module: a eles.

Example: Built-in exception and user-defined exception

KeyError my_module:MyException

Por padrão, o agente inicia quando recebe a primeira transação (seja web ou não web). O agente então inicia em paralelo, garantindo que essa solicitação inicial não seja atrasada. Entretanto, o agente não registra os detalhes dessa solicitação inicial porque o agente não pode coletar dados até que o registro seja concluído. Esta é a configuração recomendada para a maioria dos aplicativos web para não atrasar a primeira transação enquanto o New Relic é inicializado.

Para substituir isso, você pode definir um tempo limite de inicialização em segundos. O agente irá então pausar a transação inicial e aguardar a conclusão do registro. Isso pode ser útil quando se executa uma única tarefa ou programa, onde o processo é executado uma vez e termina imediatamente.

No encerramento do processo, o agente tenta fazer um upload final para o coletor. Para evitar que o agente seja executado indefinidamente em caso de problema, o processo será encerrado normalmente se o limite shutdown_timeout for atingido. Esse desligamento pode resultar em perda de dados, mas o agente prioriza os principais dados métricos durante o processo de upload.

Para sistemas de enfileiramento de tarefas em segundo plano, especialmente aqueles que executam um pequeno número de tarefas por processo, você pode querer aumentar o tempo limite de encerramento para garantir que o agente possa carregar todos os dados no encerramento do processo.

Se o limite de compactação de dados for atingido na carga útil, o agente compactará os dados usando a compactação gzip por padrão. A opção de configuração compression_content_encoding pode ser definida como deflate para usar compactação deflacionada.

Se esta configuração estiver habilitada, ela capturará informações de pacote e versão na inicialização do agente que são exibidas na guia Ambiente APM.

Se esta configuração estiver habilitada, o agente enviará mensagens detalhadas de resolução de problemas do seu script de inicialização diretamente para o seu console (STDOUT). Isso pode ser útil para depurar falhas no script de inicialização newrelic-admin , no script de inicialização alternativo bootstrap/sitecustomize.py ou na sequência de inicialização do anexo automático do Kubernetes APM.

Esta é uma configuração informativa usada para relatar quando o agente é injetado em um cluster do Kubernetes.

Esta é uma configuração informativa usada para relatar quando o agente é injetado em um aplicativo de contêiner do Microsoft Azure.

Se true, o agente usará nomes dinâmicos Heroku como nome do host.

Normalmente, o agente relata nomes dinâmicos com um ponto final e um ID de processo (por exemplo, worker.3). Você pode remover esses dados finais especificando os prefixos que deseja relatar sem dados finais (por exemplo, worker).

Adicione o seguinte ao arquivo de configuração:

[import-hook:MySQLdb]
enabled = false