Esta tradução de máquina é fornecida para sua comodidade.
In the event of any inconsistency between the English version and the translated version, the English versionwill take priority. Please visit this page for more information.
Você pode configurar o agente New Relic Ruby com configurações em um arquivo de configuração, variáveis de ambiente ou programaticamente com Configuração no lado do servidor. Este documento resume as opções de configuração disponíveis para o agente Ruby.
Se o valor padrão para uma opção de configuração for (Dynamic), isso significa que o agente Ruby calcula o padrão em tempo de execução. O valor da configuração padrão é o valor de outra configuração, conforme apropriado.
Métodos de configuração e precedência
O método principal (padrão) para configurar o agente Ruby é por meio do arquivo de configuração (newrelic.yml) no subdiretório config . Para definir valores de configuração usando variáveis de ambiente:
Adicione o prefixo NEW_RELIC_ ao nome da configuração.
O agente Ruby segue esta ordem de precedência para configuração:
Variáveis ambientais
Configuração no lado do servidor
Arquivo de configuração (newrelic.yml)
Configurações de configuração padrão
Em outras palavras, as variáveis de ambiente substituem todas as outras definições e informações de configuração, a configuração no lado do servidor substitui o arquivo de configuração e as definições de configuração padrão e assim por diante.
Visualizar e editar opções do arquivo de configuração
O newrelic.yml do agente Ruby é um arquivo de configuração YAML padrão. Geralmente inclui uma seção Defaults na parte superior, além de seções abaixo para cada ambiente de aplicativo; por exemplo, Development, Testing e Production.
O agente Ruby determina qual seção do arquivo de configuração newrelic.yml ler, observando determinadas variáveis de ambiente para derivar o ambiente do aplicativo. Isso pode ser útil, por exemplo, quando você deseja usar info para a configuração log_level em seu ambiente de produção e deseja configurações log_level mais detalhadas (como debug em seu ambiente de desenvolvimento.
Aqui está um exemplo de arquivo de configuração newrelic.yml :
common:&default_settings
license_key:'YOUR_LICENSE_KEY'
app_name:'My Application Name'
production:
<<:*default_settings
log_level: info
development:
<<:*default_settings
log_level: debug
Para aplicativos não Rails, o agente Ruby procura as seguintes variáveis de ambiente, nesta ordem, para determinar o ambiente do aplicativo:
NEW_RELIC_ENV
RUBY_ENV
RAILS_ENV
APP_ENV
RACK_ENV
Se o agente Ruby não detectar valores para nenhuma dessas variáveis de ambiente, ele padronizará o ambiente do aplicativo como development e lerá a seção development do arquivo de configuração newrelic.yml .
Ao executar o agente Ruby em um aplicativo Rails, o agente primeiro procura a variável de ambiente NEW_RELIC_ENV para determinar o ambiente do aplicativo e qual seção do newrelic.yml usar. Se NEW_RELIC_ENV não estiver presente, o agente usa o ambiente Rails (RAILS_ENV ou RAILS.env, dependendo da versão do Rails).
Ao editar o arquivo de configuração, certifique-se de:
Recuar apenas com dois espaços.
Recue apenas quando relevante, em seções como
error_collector
.
Se você não recuar corretamente, o agente poderá gerar um erro Unable to parse configuration file na inicialização.
Para visualizar a lista mais atual de opções de configuração do agente Ruby disponíveis, use o comando rake newrelic:config:docs . Este documento descreve as opções mais comuns.
Atualize o arquivo de configuração
Esta documentação se aplica à versão mais recente do agente Ruby. Para obter detalhes sobre versões anteriores, consulte os comentários no próprio newrelic.yml .
Para atualizar o arquivo newrelic.yml após uma nova versão, use o modelo no diretório base do gem do agente. Ao atualizar para novas versões do gem, examine ou diferencie config/newrelic.yml e newrelic.yml no diretório de instalação para aproveitar as novas opções de configuração.
Importante
Atualizar a gem não atualiza automaticamente config/newrelic.yml.
Em geral
Essas configurações estão disponíveis para configuração do agente. Algumas configurações dependem do nível de assinatura do seu New Relic.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_AGENT_ENABLED
Se true, permite que o agente Ruby seja executado.
Tipo
Corda
Padrão
(Dynamic)
Variável ambiental
NEW_RELIC_APP_NAME
Especifique 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 ;. Por exemplo, MyApp ou MyStagingApp;Instance1.
Tipo
Corda
Padrão
""
Variável ambiental
NEW_RELIC_LICENSE_KEY
Sua New Relic .
Tipo
Corda
Padrão
"info"
Variável ambiental
NEW_RELIC_LOG_LEVEL
Define o nível de detalhe da mensagem do log. Os possíveis níveis de log, em detalhamento crescente, são: error, warn, info ou debug.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_ACTIVE_SUPPORT_CUSTOM_EVENTS_NAMES
Uma variedade de nomes de eventos personalizados do ActiveSupport para assinatura e instrumento. Por exemplo,
one.custom.event
another.event
a.third.event
Tipo
Corda
Padrão
""
Variável ambiental
NEW_RELIC_API_KEY
Sua New Relic . Obrigatório ao usar a API REST v2 do New Relic para registrar a implantação usando o comando newrelic deployments .
Backporta a pesquisa de conexão ActiveRecord mais rápida introduzida no Rails 6, que melhora o desempenho do agente quando instrumentado ActiveRecord. Observe que esta configuração pode não ser compatível com outras gemas que corrigem o ActiveRecord.
Tipo
Corda
Padrão
nil
Variável ambiental
NEW_RELIC_CA_BUNDLE_PATH
Substituição manual do caminho para seu pacote de CA local. Este pacote CA será usado para validar o certificado SSL apresentado pelo serviço de coleta de dados da New Relic.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_CAPTURE_MEMCACHE_KEYS
Habilite ou desabilite a captura de chaves do memcache do rastreamento da transação.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_CAPTURE_PARAMS
Quando true, o agente captura parâmetros de solicitação HTTP e os anexa ao rastreamento da transação, erros de rastreamento e eventoTransactionError.
Cuidado
Ao usar a configuração capture_params , o agente Ruby não tentará filtrar informações secretas. Recommendation: Para filtrar informações secretas do parâmetro de solicitação, use a configuraçãoattributes.include. Para mais informações, veja os exemplos de atributo Ruby.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_CLEAR_TRANSACTION_STATE_AFTER_FORK
Se true, o agente liberará Tracer::State em Agent.drop_buffered_data.
Tipo
Corda
Padrão
(Dynamic)
Variável ambiental
NEW_RELIC_CONFIG_PATH
Caminho para newrelic.yml. Se indefinido, o agente verifica os seguintes diretórios (em ordem):
config/newrelic.yml
newrelic.yml
$HOME/.newrelic/newrelic.yml
$HOME/newrelic.yml
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_EXCLUDE_NEWRELIC_HEADER
Permite que cabeçalhos distributed tracing newrelic sejam suprimidos em solicitações de saída.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_FORCE_INSTALL_EXIT_HANDLER
Força a instalação do manipulador de saída que envia todos os dados armazenados em cache ao coletor antes de desligar, independentemente da detecção de cenários onde geralmente não deveria estar. O caso de uso conhecido para esta opção é quando o Sinatra está sendo executado como um serviço integrado em outra framework e o agente detecta o aplicativo Sinatra e, como resultado, ignora o gerenciador at_exit. Sinatra normalmente executa o aplicativo inteiro em um bloco at_exit e, de outra forma, se comportaria mal se o manipulador at_exit do agente também fosse instalado nessas circunstâncias. Nota: send_data_on_exit também deve ser definido como true junto com esta configuração.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_HIGH_SECURITY
Se true, ativa o modo de alta segurança. Certifique-se de compreender as implicações do modo de alta segurança antes de ativar esta configuração.
Tipo
Corda
Padrão
""
Variável ambiental
NEW_RELIC_LABELS
Um dicionário de nomes e valores de rótulos que serão aplicados aos dados enviados deste agente. Também pode ser expresso como uma sequência ; delimitada por ponto e vírgula de pares : separados por dois pontos. Por exemplo, Server:One;Data Center:Primary.
Tipo
Corda
Padrão
"newrelic_agent.log"
Variável ambiental
NEW_RELIC_LOG_FILE_NAME
Define um nome para o arquivo de log.
Tipo
Corda
Padrão
"log/"
Variável ambiental
NEW_RELIC_LOG_FILE_PATH
Define um caminho para o arquivo de log do agente, excluindo o nome do arquivo.
Tipo
Corda
Padrão
"json"
Variável ambiental
NEW_RELIC_MARSHALLER
Especifica um empacotador para transmitir dados ao coletor New Relic. Atualmente json é o único valor válido para esta configuração.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_MONITOR_MODE
Quando true, o agente transmite dados sobre seu aplicativo para o coletor New Relic .
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_PREPEND_ACTIVE_RECORD_INSTRUMENTATION
Se true, usará Module#prepend em vez de alias_method para instrumentação ActiveRecord.
Tipo
Corda
Padrão
nil
Variável ambiental
NEW_RELIC_PROXY_HOST
Define um host para comunicação com o coletor New Relic por meio de um servidor proxy.
Tipo
Corda
Padrão
nil
Variável ambiental
NEW_RELIC_PROXY_PASS
Define uma senha para comunicação com o coletor New Relic por meio de um servidor proxy.
Tipo
Inteiro
Padrão
8080
Variável ambiental
NEW_RELIC_PROXY_PORT
Define uma porta para comunicação com o coletor New Relic por meio de um servidor proxy.
Tipo
Corda
Padrão
nil
Variável ambiental
NEW_RELIC_PROXY_USER
Define um usuário para comunicação com o coletor New Relic por meio de um servidor proxy.
Tipo
Corda
Padrão
""
Variável ambiental
NEW_RELIC_SECURITY_POLICIES_TOKEN
Aplica configurações de política de segurança do agente de idioma.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_SEND_DATA_ON_EXIT
Se true, habilita o manipulador de saída que envia dados para o coletor New Relic antes de encerrar.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_SYNC_STARTUP
Quando definido como true, força uma conexão síncrona com o coletor New Relic durante a inicialização do aplicativo. Para processos de curta duração, isso ajuda a garantir que o agente da New Relic tenha tempo para reportar.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_THREAD_LOCAL_TRACER_STATE
Se true, o armazenamento do estado tracer for thread-local, caso contrário fiber-local
Tipo
Inteiro
Padrão
120
Variável ambiental
NEW_RELIC_TIMEOUT
Define o número máximo de segundos que o agente deve gastar tentando se conectar ao coletor.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_ALLOW_ALL_HEADERS
Se true, permite a captura de todos os cabeçalhos de solicitação HTTP para todos os destinos.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DEFER_RAILS_INITIALIZATION
Se true, quando o agente estiver em um aplicativo usando Ruby on Rails, ele será iniciado após a execução de config/initializers .
Cuidado
Esta opção só pode ser definida por variável de ambiente.
Tracerde transação
O recurso trace da transação coleta informações detalhadas de uma seleção de transações, incluindo um resumo da sequência de chamada, um detalhamento do tempo gasto e uma lista de consultas SQL e seus planos de consulta (em MySQL e postgresql). Os recursos disponíveis dependem do nível de assinatura do seu New Relic.
Se true, habilita a coleta de planos explicativos no rastreamento da transação. Essa configuração também será aplicada para explicar planos em rastreamento SQL lento se slow_sql.explain_enabled não for definido separadamente.
Tipo
Float
Padrão
0.5
Variável ambiental
NEW_RELIC_TRANSACTION_TRACER_EXPLAIN_THRESHOLD
Limite (em segundos) acima do qual o agente coletará planos explicativos. Relevante apenas quando explain_enabled for verdadeiro.
Tipo
Inteiro
Padrão
4000
Variável ambiental
NEW_RELIC_TRANSACTION_TRACER_LIMIT_SEGMENTS
Número máximo de nós de rastreamento de transação a serem registrados em um único rastreamento de transação.
Especifique um limite em segundos. O agente inclui rastreamento de pilha nos nós de rastreamento da transação quando a duração stack trace excede esse limite.
Especifique um limite em segundos. transações com duração superior a esse limite são elegíveis para rastreamento da transação. Especifique um valor float ou a sequência apdex_f.
Erro no coletor
O agente coleta e relata todas as exceções não detectadas por padrão. Essas opções de configuração permitem personalizar a coleta de erros.
Se true, o agente captura erros de rastreamento e métrica de contagem de erros.
Tipo
Matriz
Padrão
[]
Variável ambiental
None
Uma lista de classes de erros que o agente deve tratar conforme esperado.
Cuidado
Esta opção não pode ser definida por meio de variável de ambiente.
Tipo
Hash
Padrão
{}
Variável ambiental
None
Um mapa de classes de erro para uma lista de mensagens. Quando ocorrer um erro de uma das classes especificadas aqui, se sua mensagem de erro contiver uma das strings correspondentes aqui, esse erro será tratado conforme o esperado.
Cuidado
Esta opção não pode ser definida por meio de variável de ambiente.
Tipo
Corda
Padrão
""
Variável ambiental
NEW_RELIC_ERROR_COLLECTOR_EXPECTED_STATUS_CODES
Uma lista separada por vírgulas de códigos de status, possivelmente incluindo intervalos. Erros associados a esses códigos de status, quando aplicável, serão tratados conforme esperado.
Tipo
Hash
Padrão
{}
Variável ambiental
None
Um mapa de classes de erro para uma lista de mensagens. Quando ocorrer um erro de uma das classes aqui especificadas, se sua mensagem de erro contiver uma das strings correspondentes aqui, esse erro será ignorado.
Cuidado
Esta opção não pode ser definida por meio de variável de ambiente.
Tipo
Corda
Padrão
""
Variável ambiental
NEW_RELIC_ERROR_COLLECTOR_IGNORE_STATUS_CODES
Uma lista separada por vírgulas de códigos de status, possivelmente incluindo intervalos. Os erros associados a estes códigos de status, quando aplicável, serão ignorados.
Tipo
Inteiro
Padrão
50
Variável ambiental
NEW_RELIC_ERROR_COLLECTOR_MAX_BACKTRACE_FRAMES
Define o número máximo de quadros em um backtrace de erro. Os backtraces acima desse valor são truncados no meio, preservando o início e o fim do stack trace.
Se definido como false, o agente omite o conteúdo de entrada e saída (como sequências de texto de prompt e respostas) capturado no evento LLM.
Remove content atributo de LlmChatCompletionMessage evento
Descarta input atributo do evento LlmEmbedding
Esta é uma configuração de segurança opcional se você não quiser registrar dados confidenciais enviados e recebidos de seus LLMs.
Monitoramento de browser
O recursode tempo de carregamento de página (às vezes chamado de monitoramento de usuário real ou RUM) fornece informações sobre o desempenho que o usuário real está obtendo em seu website. Isso é feito medindo o tempo que o browser do seu usuário leva para baixar e renderizar suas páginas da web, injetando uma pequena quantidade de código JavaScript no cabeçalho e rodapé de cada página.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_BROWSER_MONITORING_AUTO_INSTRUMENT
Se true, habilita a injeção automática do cabeçalho JavaScript para tempo de carregamento da página (às vezes chamado de monitoramento de usuário real ou RUM).
Evento de transação
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_TRANSACTION_EVENTS_ENABLED
Se true, habilita a amostragem de eventos de transação.
Tipo
Inteiro
Padrão
1200
Variável ambiental
NEW_RELIC_TRANSACTION_EVENTS_MAX_SAMPLES_STORED
Define o número máximo de eventos de transação reportados de uma única colheita.
A intenção é encaminhar o log com o nível dado à configuração, bem como qualquer log com maior nível de severidade.
Por exemplo, definir esse valor como "debug" encaminhará todos os eventos de log para o New Relic. Definir este valor como "erro" apenas encaminhará eventos de log com os níveis "erro", "fatal" e "desconhecido".
Valores válidos (ordenados do menor para o maior):
Aplica hash com pares de valores principais para adicionar como atributo personalizado a todos os eventos de log encaminhados para New Relic. Se enviar usando uma variável de ambiente, o valor deve ser formatado como: "key1=value1,key2=value2"
Se true, o agente decora o log com metadados para vincular entidade, hosts, rastreamento e spans.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_APPLICATION_LOGGING_METRICS_ENABLED
Se true, o agente captura métricas relacionadas à geração de registros para seu aplicativo.
AI Monitoring
Esta seção inclui configuração do agente Ruby para configurar AI Monitoring.
Importante
Você precisa habilitar distributed tracing para capturar dados trace e feedback. Ele está ativado por padrão no agente Ruby 8.0.0 e superior.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_AI_MONITORING_ENABLED
Se false, toda a instrumentação LLM (apenas OpenAI por enquanto) será desativada e nenhuma métrica, evento ou intervalo será enviado. O AI Monitoring será desativado automaticamente se o modo high_security estiver ativado.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_AI_MONITORING_RECORD_CONTENT_ENABLED
Se false, a instrumentação LLM (apenas OpenAI por enquanto) não capturará conteúdo de entrada e saída em evento LLM específico.
Os atributos excluídos incluem:
content do evento LlmChatCompletionMessage
input do evento LlmEmbedding
Atributo
atributo são pares de valores principais contendo informações que determinam as propriedades de um evento ou transação. Esses pares de valor principal podem ser visualizados no rastreamento da transação no APM, rastreamento de erros no APM, evento de transação no painel e visualizações de página no painel. Você pode personalizar exatamente qual atributo será enviado para cada um desses destinos
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_ATTRIBUTES_ENABLED
Se true, habilita a captura de atributo para todos os destinos.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_ATTRIBUTES_EXCLUDE
Prefixo de atributo para excluir de todos os destinos. Permite * como curinga no final.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_ATTRIBUTES_INCLUDE
Prefixo de atributo a incluir em todos os destinos. Permite * como curinga no final.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_ENABLED
Se true, o agente captura o atributo do monitoramento do Browser.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_EXCLUDE
Prefixo de atributo para excluir do monitoramento de Browser. Permite * como curinga no final.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_BROWSER_MONITORING_ATTRIBUTES_INCLUDE
Prefixo de atributo a incluir no monitoramento de Browser. Permite * como curinga no final.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_ENABLED
Se true, o agente captura um atributo da coleta de erros.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_EXCLUDE
Prefixo de atributo para excluir da coleta de erros. Permite * como curinga no final.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_ERROR_COLLECTOR_ATTRIBUTES_INCLUDE
Prefixo do atributo a ser incluído na coleta de erros. Permite * como curinga no final.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_ENABLED
Se true, o agente captura o atributo no evento span.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_EXCLUDE
Prefixo do atributo para excluir do evento span. Permite * como curinga no final.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_SPAN_EVENTS_ATTRIBUTES_INCLUDE
Prefixo do atributo a incluir no evento span. Permite * como curinga no final.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_ENABLED
Se true, o agente captura o atributo do evento de transação.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_EXCLUDE
Prefixo do atributo para excluir do evento de transação. Permite * como curinga no final.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_TRANSACTION_EVENTS_ATTRIBUTES_INCLUDE
Prefixo do atributo a ser incluído no evento da transação. Permite * como curinga no final.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_ENABLED
Se true, o agente captura atributo em segmentos de transação.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_EXCLUDE
Prefixo de atributo para excluir dos segmentos de transação. Permite * como curinga no final.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_TRANSACTION_SEGMENTS_ATTRIBUTES_INCLUDE
Prefixo do atributo a ser incluído nos segmentos da transação. Permite * como curinga no final.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_ENABLED
Se true, o agente captura o atributo do rastreamento da transação.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_EXCLUDE
Prefixo de atributo para excluir do rastreamento da transação. Permite * como curinga no final.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_TRANSACTION_TRACER_ATTRIBUTES_INCLUDE
Prefixo do atributo a incluir no rastreamento da transação. Permite * como curinga no final.
Log de auditoria
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_AUDIT_LOG_ENABLED
Se true, ativa um log de auditoria que registra comunicações com o coletor New Relic .
Tipo
Matriz
Padrão
[".*"]
Variável ambiental
NEW_RELIC_AUDIT_LOG_ENDPOINTS
Lista de endpoints permitidos para inclusão no log de auditoria.
Tipo
Corda
Padrão
log/newrelic_audit.log
Variável ambiental
NEW_RELIC_AUDIT_LOG_PATH
Especifica um caminho para o arquivo de log de auditoria (incluindo o nome do arquivo).
Especifique uma lista de constantes que devem impedir que o agente seja iniciado automaticamente. Separe as constantes individuais com uma vírgula ,. Por exemplo, "Rails::Console,UninstrumentedBackgroundJob".
Tipo
Corda
Padrão
"irb,rspec"
Variável ambiental
NEW_RELIC_AUTOSTART_DENYLISTED_EXECUTABLES
Define uma lista delimitada por vírgulas de executáveis que o agente não deve utilizar. Por exemplo, "rake,my_ruby_script.rb".
Definir uma das tags a seguir ajudará você a identificar quais versões do seu software estão produzindo erros.
NEW_RELIC_METADATA_SERVICE_VERSION irá criar tag.service.version nos dados do evento contendo a versão do seu código que está implantada, em muitos casos uma versão semântica como 1.2.3, mas nem sempre.
NEW_RELIC_METADATA_RELEASE_TAG criará tags.releaseTag nos dados do evento contendo a tag de lançamento (como v0.1.209 ou release-209).
NEW_RELIC_METADATA_COMMIT criará tag.commit nos dados do evento contendo o commit sha. O sha inteiro pode ser usado ou apenas os primeiros sete caracteres (por exemplo, 734713b).
Uma próxima versão da Errors Inbox rastreará automaticamente quais versões do seu software estão produzindo erros. Quaisquer dados de versão também serão exibidos no CodeStream.
Se false, o agente não reportará métrica da instância do datastore, nem adicionará parâmetro host ou port_path_or_id para operação ou rastreamento SQL lento.
Desativando
Use essas configurações para alternar os tipos de instrumentação durante a inicialização do agente.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_ACTION_CABLE_INSTRUMENTATION
Se true, desativa a instrumentação do Action Cable.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_ACTION_CONTROLLER
Se true, desativa a instrumentação do Action Controller.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_ACTION_MAILBOX
Se true, desativa a instrumentação da Action Mailbox.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_ACTION_MAILER
Se true, desativa a instrumentação do Action Mailer.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_ACTIVEJOB
Se true, desativa a instrumentação do Active Job.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_ACTIVE_STORAGE
Se true, desativa a instrumentação do Active Storage.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_ACTIVE_SUPPORT
Se true, desativa a instrumentação do Active Support.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_ACTIVE_RECORD_INSTRUMENTATION
Se true, desabilita a instrumentação do Active Record.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_ACTIVE_RECORD_NOTIFICATIONS
Se true, desativa a instrumentação para Active Record 4+
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_CPU_SAMPLER
Se true, o agente não fará uma amostragem do uso da CPU do processo host.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_DELAYED_JOB_SAMPLER
Se true, o agente não medirá a profundidade das filas de trabalhos atrasados.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_GC_PROFILER
Se true, desativa o uso de GC::Profiler para medir o tempo gasto na coleta de lixo
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_MEMORY_SAMPLER
Se true, o agente não fará uma amostra do uso de memória do processo host.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_MIDDLEWARE_INSTRUMENTATION
Se true, o agente não agrupará middlewares de terceiros na instrumentação (independentemente de serem instalados via Rack::Builder ou Rails).
Importante
Quando a instrumentação de middleware estiver desabilitada, se um aplicativo estiver usando middleware que possa alterar o código de resposta, o código de status HTTP relatado na transação poderá não refletir o valor alterado.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_SAMPLERS
Se true, desabilita a coleta de métricas do amostrador. Métricas de amostra são métricas que não são baseadas em eventos (como tempo de CPU ou uso de memória).
O rastreamento multiaplicativo foi descontinuado em favor do distributed tracing. distributed tracing está ativado por padrão para o agente Ruby versões 8.0.0 e superiores. Middlewares não são necessários para suportar distributed tracing.
Para continuar usando o rastreamento multiaplicativo, atualize as seguintes opções no arquivo de configuração newrelic.yml :
# newrelic.yml
cross_application_tracer:
enabled:true
distributed_tracing:
enabled:false
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_DISABLE_VIEW_INSTRUMENTATION
Se true, desativa a instrumentação de visualização.
Distributed tracing permite ver o caminho que uma solicitação percorre em seus sistemas distribuídos. Habilitar distributed tracing altera o comportamento de alguns recursos do New Relic, portanto consulte cuidadosamente o guia de transição antes de habilitar este recurso.
Elasticsearch
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_ELASTICSEARCH_CAPTURE_QUERIES
Se true, o agente captura a consulta do Elasticsearch no rastreamento da transação.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_ELASTICSEARCH_OBFUSCATE_QUERIES
Se true, o agente ofusca a consulta do Elasticsearch no rastreamento da transação.
Heroku
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_HEROKU_USE_DYNO_NAMES
Se true, o agente usará nomes dinâmicos Heroku como nome do host.
Tipo
Matriz
Padrão
["scheduler", "run"]
Variável ambiental
NEW_RELIC_HEROKU_DYNO_NAME_PREFIXES_TO_SHORTEN
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).
Rastreamento infinito
Tipo
Corda
Padrão
""
Variável ambiental
NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_HOST
Configura o nome do host para o host observador trace . Quando configurado, permite amostras baseadas na cauda, enviando todos os intervalos registrados para um observador trace para decisões de amostragem adicionais, independentemente de qualquer decisão usual de amostragem do agente.
Tipo
Inteiro
Padrão
443
Variável ambiental
NEW_RELIC_INFINITE_TRACING_TRACE_OBSERVER_PORT
Configura a porta TCP/IP para o host observador trace
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_INFINITE_TRACING_BATCHING
Se true (o padrão), os dados enviados ao observador trace serão agrupados em lote em vez de enviar cada intervalo individualmente.
Tipo
Símbolo
Padrão
:high
Variável ambiental
NEW_RELIC_INFINITE_TRACING_COMPRESSION_LEVEL
Configure o nível de compactação dos dados enviados ao observador trace .
Pode ser um dos seguintes: :none, :low, :medium, :high.
Defina o nível como :none para desativar a compactação.
Controla a instrumentação automática de ActiveSupport::BroadcastLogger na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled. Usado em versões Rails >= 7.1.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_ACTIVE_SUPPORT_LOGGER
Controla a instrumentação automática de ActiveSupport::Logger na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled. Usado em versões Rails abaixo de 7.1.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_ASYNC_HTTP
Controla a instrumentação automática de Async::HTTP na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_BUNNY
Controla a instrumentação automática do bunny na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_FIBER
Controla a instrumentação automática da classe Fiber na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_CONCURRENT_RUBY
Controla a instrumentação automática da biblioteca Ruby simultânea na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_CURB
Controla a instrumentação automática do Curb na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_DELAYED_JOB
Controla a instrumentação automática do trabalho atrasado na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_ELASTICSEARCH
Controla a instrumentação automática da biblioteca elasticsearch na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_ETHON
Controla a instrumentação automática do ethon na inicialização. Pode ser um dos [auto|prepend|chain|disabled]
Tipo
Corda
Padrão
enabled
Variável ambiental
NEW_RELIC_INSTRUMENTATION_EXCON
Controla a instrumentação automática do Excon na inicialização. Pode ser um dos seguintes: enabled, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_GRAPE
Controla a instrumentação automática do Grape na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_GRPC_CLIENT
Controla a instrumentação automática de clientes gRPC na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_INSTRUMENTATION_GRPC_HOST_DENYLIST
Especifica uma lista de padrões de nome do host separados por vírgulas que corresponderão ao nome do host gRPC para o qual o tráfego deve ser ignorado pelo New Relic. A instrumentação do cliente gRPC da New Relic ignorará o tráfego transmitido para um host que corresponda a qualquer um desses padrões, e a instrumentação do servidor gRPC da New Relic ignorará o tráfego para um servidor em execução em um host cujo nome do host corresponda a qualquer um desses padrões. Por padrão, nenhum tráfego é ignorado quando a instrumentação gRPC está habilitada. Por exemplo, "private.com$,exception.*"
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_GRPC_SERVER
Controla a instrumentação automática de servidores gRPC na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_HTTPCLIENT
Controla a instrumentação automática do HTTPClient na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_HTTPRB
Controla a instrumentação automática da gem http.rb na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_HTTPX
Controla a instrumentação automática de httpx na inicialização. Pode ser um dos [auto|prepend|chain|disabled]
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_LOGGER
Controla a instrumentação automática do agente da biblioteca padrão Ruby na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_MEMCACHE
Controla a instrumentação automática do dalli gem para Memcache na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_MEMCACHED
Controla a instrumentação automática do gem memcached para Memcache na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_MEMCACHE_CLIENT
Controla a instrumentação automática da gema do cliente memcache para Memcache na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
enabled
Variável ambiental
NEW_RELIC_INSTRUMENTATION_MONGO
Controla a instrumentação automática do Mongo na inicialização. Pode ser um dos seguintes: enabled, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_NET_HTTP
Controla a instrumentação automática de Net::HTTP na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_RUBY_OPENAI
Controla a instrumentação automática da gema ruby-openai na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_PUMA_RACK
Controla a instrumentação automática de Puma::Rack. Quando ativado, o agente se conecta ao método to_app em Puma::Rack::Builder para encontrar gemas para o instrumento durante a inicialização do aplicativo. Pode ser um dos: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_PUMA_RACK_URLMAP
Controla a instrumentação automática de Puma::Rack::URLMap na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_RACK
Controla a instrumentação automática do Rack. Quando ativado, o agente se conecta ao método to_app em Rack::Builder para encontrar gemas para o instrumento durante a inicialização do aplicativo. Pode ser um dos: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_RACK_URLMAP
Controla a instrumentação automática de Rack::URLMap na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_RAKE
Controla a instrumentação automática do rake na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_REDIS
Controla a instrumentação automática do Redis na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_RESQUE
Controla a instrumentação automática de resque na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_RODA
Controla a instrumentação automática do Roda na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_SINATRA
Controla a instrumentação automática do Sinatra na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
"enabled"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_STRIPE
Controla a instrumentação automática do Stripe na inicialização. Pode ser um dos seguintes: enabled, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_VIEW_COMPONENT
Controla a instrumentação automática do ViewComponent na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_THREAD
Controla a instrumentação automática da classe Thread na inicialização para permitir que o agente aninhe corretamente os spans dentro de uma transação assíncrona. Isso não permite que o agente trace automaticamente todos os threads criados (consulte instrumentation.thread.tracing). Pode ser um de: auto, prepend, chain, disabled.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_INSTRUMENTATION_THREAD_TRACING
Controla a instrumentação automática da classe Thread na inicialização para adicionar automaticamente rastreamento a todos os Threads criados no aplicativo.
Tipo
Corda
Padrão
"auto"
Variável ambiental
NEW_RELIC_INSTRUMENTATION_TILT
Controla a instrumentação automática da biblioteca de renderização de modelos Tilt na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo
Corda
Padrão
auto
Variável ambiental
NEW_RELIC_INSTRUMENTATION_TYPHOEUS
Controla a instrumentação automática do Typhoeus na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Especifique uma matriz de tarefas Rake para serem instrumentadas automaticamente. Esta opção de configuração converte a matriz em uma lista RegEx. Se quiser permitir todas as tarefas por padrão, use rake.tasks: [.+]. Nenhuma tarefa de rake será instrumentada a menos que seja adicionada a esta lista. Para obter mais informações, visite a documentação sobre instrumentação do New Relic Rake.
Tipo
Inteiro
Padrão
10
Variável ambiental
NEW_RELIC_RAKE_CONNECT_TIMEOUT
Tempo limite para esperar a conclusão da conexão antes de uma tarefa rake
Regras
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_RULES_IGNORE_URL_REGEXES
Defina a transação que você deseja que o agente ignore, especificando uma lista de padrões que correspondem ao URI que você deseja ignorar. Para obter mais detalhes, consulte a documentação sobre como ignorar transações específicas.
Modo sem servidor
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_SERVERLESS_MODE_ENABLED
Se true, o agente operará em um modo simplificado adequado para uso com função serverless de curta duração. NOTA: Somente a função do AWS Lambda é suportada atualmente e esta opção não se destina ao uso sem a oferta da camada Ruby Lambda da New Relic.
Auxiliar
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_SIDEKIQ_ARGS_INCLUDE
Uma matriz de strings que servirá coletivamente como uma lista de permissões para filtrar quais argumentos de trabalho do Sidekiq serão relatados ao New Relic. Para capturar quaisquer argumentos do Sidekiq, 'job.sidekiq.args.*' deve ser adicionado à opção de configuração :'attributes.include' separada. Cada string nesta matriz será transformada em uma expressão regular por meio de Regexp.new para permitir correspondência avançada. Para argumento de trabalho aplique hash, se uma chave ou valor corresponder, o par será incluído. Todos os elementos da matriz de argumentos de trabalho e escalares de argumentos de trabalho correspondentes serão incluídos.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_SIDEKIQ_ARGS_EXCLUDE
Uma matriz de strings que servirá coletivamente como uma lista de bloqueios para filtrar quais argumentos de trabalho do Sidekiq serão relatados ao New Relic. Para capturar quaisquer argumentos do Sidekiq, 'job.sidekiq.args.*' deve ser adicionado à opção de configuração :'attributes.include' separada. Cada string nesta matriz será transformada em uma expressão regular por meio de Regexp.new para permitir correspondência avançada. Para argumento de trabalho aplique hash, se uma chave ou valor corresponder, o par será excluído. Todos os elementos da matriz de argumentos de trabalho e escalares de argumentos de trabalho correspondentes serão excluídos.
Especifique um limite em segundos. O agente coleta consultas SQL lentas e explica os planos que excedem esse limite.
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_SLOW_SQL_EXPLAIN_ENABLED
Se true, o agente coleta planos explicativos em consulta SQL lenta. Se esta configuração for omitida, a configuração transaction_tracer.explain_enabled também será aplicada como configuração padrão para planos de explicação em SQL lento.
Tipo
Corda
Padrão
obfuscated
Variável ambiental
NEW_RELIC_SLOW_SQL_RECORD_SQL
Define um nível de ofuscação para consultas SQL lentas. As opções válidas são obfuscated, raw ou none.
Tipo
Boleano
Padrão
false
Variável ambiental
NEW_RELIC_SLOW_SQL_USE_LONGER_SQL_ID
Gere um sql_id mais longo para rastreamento SQL lento. sql_id é usado para agregação de consultas semelhantes.
Evento de extensão
Tipo
Boleano
Padrão
true
Variável ambiental
NEW_RELIC_SPAN_EVENTS_ENABLED
Se true, habilita a amostragem de eventos de extensão.
Tipo
Inteiro
Padrão
10000
Variável ambiental
NEW_RELIC_SPAN_EVENTS_QUEUE_SIZE
Define o número máximo de eventos de span para buffer durante o streaming para o observador trace .
Tipo
Inteiro
Padrão
2000
Variável ambiental
NEW_RELIC_SPAN_EVENTS_MAX_SAMPLES_STORED
Define o número máximo de eventos de span relatados de uma única colheita. Qualquer número inteiro entre 1 e 10000 é válido.
Ao configurar o agente para AI Monitoring, defina o valor máximo 10000. Garante que o agente capture a quantidade máxima de rastreio distribuído.
Especifique uma lista de exceções que você não deseja que o agente remova quando strip_exception_messages for true. Separe as exceções com vírgula. Por exemplo, "ImportantException,PreserveMessageException".
Stripe
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_STRIPE_USER_DATA_INCLUDE
Uma matriz de strings para especificar quais chaves dentro do hash aplicar user_data de um evento Stripe deve ser relatada ao New Relic. Cada string nesta matriz será transformada em uma expressão regular por meio de Regexp.new para permitir correspondência avançada. Definir o valor como ["."] reportará todos user_data.
Tipo
Matriz
Padrão
[]
Variável ambiental
NEW_RELIC_STRIPE_USER_DATA_EXCLUDE
Uma matriz de strings para especificar quais chaves e/ou valores dentro do hash de aplicação user_data de um evento Stripe não devem ser relatados ao New Relic. Cada string nesta matriz será transformada em uma expressão regular por meio de Regexp.new para permitir correspondência avançada. Para cada par de hash aplicado, se a chave ou o valor corresponderem, o par não será relatado. Por padrão, nenhum user_data é relatado, portanto esta opção só deverá ser usada se a opção stripe.user_data.include estiver sendo usada.