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. - Substitua quaisquer pontos
.por sublinhados_.
Você também pode configurar alguns valores na interface via configuração no lado do servidor.
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. Normalmente inclui uma seção Defaults na parte superior, além de seções abaixo para cada ambiente de aplicativo (Development, Test, Staging 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 quando você deseja usar info para a configuração log_level em seu ambiente de produção e deseja configurações de 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: infodevelopment: <<: *default_settings log_level: debugO agente Ruby procura as seguintes variáveis de ambiente, nesta ordem, para localizar o ambiente do aplicativo:
NEW_RELIC_ENVRUBY_ENVRAILS_ENVAPP_ENVRACK_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 encontrar 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).
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 |
|
Variável ambiental |
|
Se true, permite que o agente Ruby seja executado.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Sua New Relic .
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
An array of ActiveSupport custom event names to subscribe to and instrument. For example: [one.custom.event, another.event, a.third.event]
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, the agent will use the ActiveRecord model's table name instead of the class name when naming ActiveRecord metrics, spans, and transaction trace segments. This can reduce cardinality when multiple models share a database table. Defaults to false.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Substituição manual do caminho para seu pacote de CA local. Este pacote de CA valida o certificado SSL apresentado pelo serviço de coleta de dados da New Relic.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, the agent captures memcache keys in transaction traces.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Se true, o agente liberará Tracer::State em Agent.drop_buffered_data.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Path to newrelic.yml. If undefined, the agent checks the following directories (in order): config/newrelic.yml -> newrelic.yml -> $HOME/.newrelic/newrelic.yml -> $HOME/newrelic.yml
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, suppresses the newrelic distributed tracing header on outbound requests.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, forces the agent to install its exit handler (which sends all cached data to the collector before shutting down), even in cases where the agent would normally skip it, such as when it detects Sinatra running as an embedded service within another framework. Sinatra runs the entire application inside its own at_exit block, so the agent skips its own at_exit handler by default to avoid conflicts. This setting overrides that. Note: send_data_on_exit must also be true for this setting to have any effect.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
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 |
|
Variável ambiental |
|
Define um nome para o arquivo de log.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Defines a path to the agent log file, excluding the filename. If you want to send your agent logs to standard out, set this to STDOUT.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Quando true, o agente transmite dados sobre seu aplicativo para o coletor New Relic .
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, usará Module#prepend em vez de alias_method para instrumentação ActiveRecord.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Define um host para comunicação com o coletor New Relic por meio de um servidor proxy.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Define uma senha para comunicação com o coletor New Relic por meio de um servidor proxy.
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Define uma porta para comunicação com o coletor New Relic por meio de um servidor proxy.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Define um usuário para comunicação com o coletor New Relic por meio de um servidor proxy.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, habilita o manipulador de saída que envia dados para o coletor New Relic antes de encerrar.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
If true, tracer state storage is thread-local, otherwise, fiber-local.
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Define o número máximo de segundos que o agente deve gastar tentando se conectar ao coletor.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, permite a captura de todos os cabeçalhos de solicitação HTTP para todos os destinos.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Uma matriz de strings CLASS#METHOD (para métodos de instância) e/ou CLASS.METHOD (para métodos de classe) representando métodos Ruby aos quais o agente pode adicionar automaticamente instrumentação personalizada. Isso não requer nenhuma modificação no código-fonte que define os métodos.
Use nomes de classe totalmente qualificados (usando o delimitador :: ) que incluam qualquer namespace de módulo ou classe.
Aqui está um código-fonte Ruby que define um método de instância render_png para uma classe Image e um método de classe notify para uma classe User , ambos dentro de um namespace de módulo MyCompany :
module MyCompany class Image def render_png # code to render a PNG end end
class User def self.notify # code to notify users end end endDado esse código-fonte, o arquivo de configuração newrelic.yml pode solicitar instrumentação para ambos os métodos, assim:
automatic_custom_instrumentation_method_list: - MyCompany::Image#render_png - MyCompany::User.notifyEsse exemplo de configuração usa a sintaxe de matriz YAML para especificar ambos os métodos. Como alternativa, você pode usar uma string delimitada por vírgulas:
automatic_custom_instrumentation_method_list: 'MyCompany::Image#render_png, MyCompany::User.notify'O espaço em branco ao redor da(s) vírgula(s) na lista é opcional. Ao configurar o agente com uma lista de métodos por meio da variável de ambiente NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST , use este formato de string delimitada por vírgulas:
$export NEW_RELIC_AUTOMATIC_CUSTOM_INSTRUMENTATION_METHOD_LIST='MyCompany::Image#render_png, MyCompany::User.notify'Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, as métricas para chamadas de transmissão do Action Cable não incluirão o valor broadcasting para uma determinada transmissão. O padrão é false. O padrão pode mudar em um futuro lançamento de versão principal.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Uma lista de nomes de classes ou módulos de middleware que o agente deve ignorar. Exemplo: ["Rack::Cors", "ActionDispatch::Reloader"]
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
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.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, habilita a coleta de rastreamento da transação.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, habilita a coleta de planos de explicação no trace da transação. Esta 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 |
|
Variável ambiental |
|
Limite (em segundos) acima do qual o agente coletará planos explicativos. Relevante apenas quando explain_enabled for verdadeiro.
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Número máximo de nós de rastreamento de transação a serem registrados em um único rastreamento de transação.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente registra os argumentos do comando Redis no rastreamento da transação.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Nível de ofuscação para consulta SQL reportado em nós de trace da transação. Por padrão, isso é definido como obfuscated, o que remove os literais numéricos e de string.
- Se você não quiser que o agente capture informações de consulta, defina como
none. - Se quiser que o agente capture todas as informações da consulta em seu formato original, defina como
raw. - Quando você ativa o modo de alta segurança, ele é automaticamente definido como
obfuscated.
Tipo | Float |
|---|---|
Padrão |
|
Variável ambiental |
|
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.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, assim que transaction_tracer.limit_segments for atingido, o agente também parará de registrar o tempo exclusivo para quaisquer segmentos criados posteriormente nessa transação. Isso pode reduzir o uso de memória para transações de execução muito longa com muitos segmentos, à custa de dados de tempo menos precisos para segmentos na transação se o limite de segmentos for atingido.
Tipo | Float |
|---|---|
Padrão |
|
Variável ambiental |
|
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.
Para obter informações sobre erros ignorados e esperados, consulte esta página em Error Analytics no APM. Para definir erro esperado através do NewRelic::Agent.notice_error Ruby método , consulte a Ruby API do agente.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente coleta TransactionError evento.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura erros de rastreamento e métrica de contagem de erros.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
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 |
|
A comma-separated list of HTTP status codes and/or status code ranges (for example, 404, 429, 500-599). Errors associated with a matching status code, if the error has one, will be treated as expected.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Uma lista de classes de erros que o agente deve ignorar.
Cuidado
Esta opção não pode ser definida por meio de variável de ambiente.
Tipo | Hash |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
A comma-separated list of HTTP status codes and/or status code ranges (for example, 404, 429, 500-599). Errors associated with a matching status code, if the error has one, will be ignored.
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Defines the maximum number of frames in an error backtrace. Backtraces over this amount are truncated in the middle by default, preserving the beginning and the end of the stack trace. See error_collector.backtrace_truncate_location to customize the truncation location.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Specifies where in the backtrace to truncate when the number of frames exceeds error_collector.max_backtrace_frames. Options are top (remove frames from the beginning), middle (remove frames from the middle, preserving the beginning and end), or end (remove frames from the end).
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Define o número máximo de TransactionError eventos reportados por ciclo de coleta.
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 |
|
Variável ambiental |
|
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).
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, habilita a autoinjeção do Content Security Policy Nonce no script de monitoramento do Browser. Por enquanto, a injeção automática só funciona com Rails 5.2+.
Evento de transação
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, habilita a amostragem de eventos de transação.
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Define o número máximo de eventos de transação reportados de uma única colheita.
Registro do aplicativo
O agente Ruby oferece suporte ao logs contextualizados APM. Para obter algumas dicas sobre como configurar o log para o agente Ruby, consulte Configurar logs contextualizados Ruby.
As opções de configuração relacionadas ao registro disponíveis incluem:
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, habilita a decoração de log e a coleta de evento de log e métrica.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura registros de log emitidos pelo seu aplicativo.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Sets the minimum level a log event must have to be forwarded to New Relic. Logs at the configured level and any higher severity are forwarded, for example, debug forwards all log events, while error forwards only error, fatal, and unknown events. Valid values, lowest to highest severity: debug, info, warn, error, fatal, unknown (case-sensitive; uppercase forms are also accepted).
This ordering is based on the integer values of Ruby's Logger::Severity constants (see https://github.com/ruby/logger/blob/113b82a06b3076b93a71cd467e1605b23afb3088/lib/logger/severity.rb).
Tipo | Hash |
|---|---|
Padrão |
|
Variável ambiental |
|
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"
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente anexa rótulos aos registros de log.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Uma matriz que não diferencia maiúsculas de minúsculas ou uma sequência de caracteres delimitada por vírgulas contendo os rótulos a serem excluídos dos registros de log.
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Define o número máximo de registros de log para armazenar em buffer na memória por vez.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente decora o log com metadados para vincular entidade, hosts, rastreamento e spans.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
If false, LLM instrumentation (OpenAI only for now) will not capture the content attribute on LlmChatCompletionMessage events or the input attribute on LlmEmbedding events. This is an optional security setting to prevent recording sensitive data sent to and received from your LLMs.
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 |
|
Variável ambiental |
|
Se true, habilita a captura de atributo para todos os destinos.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo de atributo para excluir de todos os destinos. Permite * como curinga no final.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo de atributo a incluir em todos os destinos. Permite * como curinga no final.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura o atributo do monitoramento do Browser.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo de atributo para excluir do monitoramento de Browser. Permite * como curinga no final.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo de atributo a incluir no monitoramento de Browser. Permite * como curinga no final.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura um atributo da coleta de erros.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo de atributo para excluir da coleta de erros. Permite * como curinga no final.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo do atributo a ser incluído na coleta de erros. Permite * como curinga no final.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura o atributo no evento span.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo do atributo para excluir do evento span. Permite * como curinga no final.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo do atributo a incluir no evento span. Permite * como curinga no final.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura o atributo do evento de transação.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo do atributo para excluir do evento de transação. Permite * como curinga no final.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo do atributo a ser incluído no evento da transação. Permite * como curinga no final.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura atributo em segmentos de transação.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo de atributo para excluir dos segmentos de transação. Permite * como curinga no final.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo do atributo a ser incluído nos segmentos da transação. Permite * como curinga no final.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura o atributo do rastreamento da transação.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo de atributo para excluir do rastreamento da transação. Permite * como curinga no final.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Prefixo do atributo a incluir no rastreamento da transação. Permite * como curinga no final.
Log de auditoria
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, ativa um log de auditoria que registra comunicações com o coletor New Relic .
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
List of allowed endpoints to include in the audit log.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Especifica um caminho para o arquivo de log de auditoria (incluindo o nome do arquivo).
Começo automático
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Define uma lista delimitada por vírgulas de executáveis que o agente não deve utilizar. Por exemplo, "rake,my_ruby_script.rb".
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Define uma lista delimitada por vírgulas de tarefas Rake que o agente não deve utilizar. Por exemplo, "assets:precompile,db:migrate".
Nuvem
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
The AWS account ID associated with this application.
Nível do código métrico
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente reportará a métrica de nível de código-fonte para métodos de rastreamento. Veja: https://docs.newrelic.com/docs/apm/agents/ruby-agent/features/ruby-codestream-integration/
Atributo personalizado
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se false, o atributo personalizado não será enviado no evento.
Evento personalizado
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura o evento personalizado.
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Specify a maximum number of custom events to buffer in memory at a time. When configuring the agent for AI monitoring, set to max value 100000. This ensures the agent captures the maximum amount of LLM events.
Tracer de armazenamento de dados
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If false, the agent will not add database_name parameter to transaction or slow SQL traces.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Se true, desativa a instrumentação do Action Cable.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desativa a instrumentação do Action Controller.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desativa a instrumentação da Action Mailbox.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desativa a instrumentação do Action Mailer.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desativa a instrumentação do Active Job.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, os nomes das etapas do Rails Active Job Continuations não serão incluídos nos nomes das métricas. Isso reduz a cardinalidade da métrica, mas também reduz a visibilidade do desempenho da etapa individual. Defina isso como true apenas se estiver enfrentando problemas de cardinalidade de métrica devido a jobs com muitas etapas ou etapas nomeadas dinamicamente.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desativa a instrumentação do Active Storage.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desativa a instrumentação do Active Support.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desabilita a instrumentação do Active Record.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, disables instrumentation for Active Record 4+.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente não fará uma amostragem do uso da CPU do processo host.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente não medirá a profundidade das filas de trabalhos atrasados.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, disables the use of GC::Profiler to measure time spent in garbage collection.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente não fará uma amostra do uso de memória do processo host.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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).
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desativa a instrumentação Sequel.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desativa a instrumentação do Sidekiq.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desabilita o middleware do agente para Roda. Este middleware é responsável pelo suporte avançado a recursos, como tempo de carregamento de página e coleta de erros.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desativa o middleware do agente para Sinatra. Este middleware é responsável pelo suporte a recursos avançados, como rastreamento distribuído, tempo de carregamento da página e coleta de erros.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desativa a instrumentação de visualização.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente não coletará amostras de medidas de desempenho da VM Ruby.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desabilita a instrumentação de estatísticas do servidor Puma que coleta amostras de Ruby/Puma/* métricas do processo mestre do Puma. Esta instrumentação está desabilitada por padrão. Quando habilitado, o agente inicia uma thread de relatórios no processo mestre do Puma para entregar essas métricas.
Distributed tracing
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
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.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
This setting controls the behavior of transaction sampling for transactions without a remote parent (traces that originate within this instance of the New Relic agent). Available values are adaptive (the default), always_on, always_off, and trace_id_ratio_based.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Esta configuração controla o comportamento da amostragem de transações quando um pai remoto é amostrado. Os valores disponíveis são adaptive (o padrão), always_on, always_off e trace_id_ratio_based.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Esta configuração controla o comportamento da amostragem de transações quando um pai remoto não é amostrado. Os valores disponíveis são adaptive (o padrão), always_on, always_off e trace_id_ratio_based.
Elasticsearch
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura o Elasticsearch cluster nome no rastreamento da transação.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura a consulta do Elasticsearch no rastreamento da transação.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente ofusca a consulta do Elasticsearch no rastreamento da transação.
Heroku
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente usará nomes dinâmicos Heroku como nome do host.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
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 |
|
Variável ambiental |
|
Configura a porta TCP/IP para o host observador trace
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Configure o nível de compactação para dados enviados ao observador trace . Pode ser um dos seguintes: :none, :low, :medium, :high. Defina o nível como :none para desabilitar a compactação.
Instrumentação
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
An allowlist of ActiveSupport notification event names (mostly caching events and message-serializer events) that the agent subscribes to. Any event name not included here is ignored. Provide complete event names only, such as cache_fetch_hit.active_support. Do not provide asterisks or regex patterns, and do not escape any characters with backslashes.
For the complete list of possible event names, see the Rails documentation's list of caching names and messages names.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Controla a instrumentação automática do bunny na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática da biblioteca semantic_logger na inicialização. Pode ser um de auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a auto-instrumentação da biblioteca paralela na inicialização. Pode ser um de auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática da biblioteca AWS-sdk-firehose na inicialização. Pode ser um de auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática da biblioteca aws_sdk_lambda na inicialização. Pode ser um de auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática da biblioteca AWS-sdk-kinesis na inicialização. Pode ser um de auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática da biblioteca ruby-kafka na inicialização. Pode ser um de auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática da biblioteca opensearch-ruby na inicialização. Pode ser um de auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática da biblioteca rdkafka na inicialização. Pode ser um de auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática da biblioteca aws-sdk-sqs na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática da biblioteca aws-sdk-dynamodb na inicialização. Pode ser um de auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Controla a instrumentação automática do Curb na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Controls auto-instrumentation of ethon at start up. May be one of auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática do Excon na inicialização. Pode ser um dos seguintes: enabled, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática do Grape na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
A comma-separated list of regular expression patterns matching gRPC hostnames whose traffic New Relic should ignore. New Relic's gRPC client instrumentation skips tracing calls made to a host matching any of these patterns, and its gRPC server instrumentation skips tracing requests received by a server running on a matching host. For example, "private.com$,exception.*" Empty by default, meaning no traffic is ignored..
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Controla a instrumentação automática do HTTPClient na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Controls auto-instrumentation of httpx at start up. May be one of auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Controla a auto-instrumentação da biblioteca de logs na inicialização. Pode ser um de auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática da biblioteca LogStasher na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação de Rails.event como logs estruturados. Pode ser um dos seguintes: enabled, disabled.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
An array of Rails.event names to capture as structured log events. For example: [user.signup, payment.processed, order.created]. Leave empty to capture all Rails.event notifications. Events are logged with level UNKNOWN (ensuring they're never filtered) unless overridden via a :level key in the event payload.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Controla a instrumentação automática do Mongo na inicialização. Pode ser um dos seguintes: enabled, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Controla a instrumentação automática da gema ruby-openai na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled. O padrão é disabled no modo de alta segurança.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Controla a instrumentação automática do rake na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática do Redis na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática de resque na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática do Roda na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática do Sinatra na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática do Stripe na inicialização. Pode ser um dos seguintes: enabled, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Controla a instrumentação automática do ViewComponent na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
Controla a instrumentação automática do Typhoeus na inicialização. Pode ser um dos seguintes: auto, prepend, chain, disabled.
Tracer de mensagens
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente coletará metadados sobre mensagens e os anexará como parâmetro de segmento.
Mongo
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura a consulta Mongo no rastreamento da transação.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente ofusca a consulta do Mongo no rastreamento da transação.
Opensearch
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente captura a consulta do OpenSearch no rastreamento da transação.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente ofusca a consulta do OpenSearch no rastreamento da transação.
OpenTelemetry
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
A global configuration option for disabling all OpenTelemetry signals sent through New Relic. If false, no OpenTelemetry signals will be sent to New Relic. If true, the signal-specific enabled config option (e.g. opentelemetry.traces.enabled) determines whether telemetry of that signal type will be reported to New Relic.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Permite a criação de segmentos de Rastreamento de transação e métricas de timeslice a partir de Spans do OpenTelemetry. Isso ajudará a impulsionar a experiência da interface de usuário do New Relic para spans do OpenTelemetry.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Uma lista de rastreadores do OpenTelemetry delimitada por vírgulas, representada como uma string (por exemplo, "AppTracer1,OpenTelemetry::Instrumentation::Bunny::Instrumentation"), que terão seus traces enviados para a New Relic.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Uma lista de Tracers do OpenTelemetry delimitada por vírgulas, representada como uma string (por exemplo, "AppTracer1,OpenTelemetry::Instrumentation::Bunny::Instrumentation"), que não terão seus traces enviados para o New Relic.
Anfitrião do processo
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Specify a custom hostname for display in the New Relic UI.
Puma
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Número de segundos entre as amostras de estatísticas do servidor Puma coletadas no processo mestre do Puma.
Ancinho
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Specify an Array of Rake tasks to automatically instrument. This configuration option converts the Array to a RegEx list. No rake tasks will be instrumented unless they're added to this list. If you'd like to allow all tasks by default, use rake.tasks: [.+]. For more information, visit the New Relic Rake Instrumentation docs.
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Defines the number of seconds to wait for a connection to complete before running a Rake task.
Regras
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Define transactions you want the agent to ignore by specifying a list of patterns matching the URIs to exclude. For more detail, see the docs on ignoring specific transactions.
Segurança
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, the security agent is loaded (a Ruby 'require' is performed).
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, the security agent is started (the agent runs in its event loop).
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Defines the mode for the security agent to operate in. Currently only IAST is supported.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Defines the endpoint URL for posting security-related data.
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
A porta em que o aplicativo está escutando. Esta configuração é obrigatória para servidores Passenger. O agente detecta outros servidores por padrão.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Define os caminhos da API que o agente de segurança deve ignorar nas verificações IAST. Aceita uma matriz de padrões regex correspondentes ao URI a ser ignorado. O padrão regex deve encontrar uma correspondência completa para a URL sem o endpoint. Por exemplo, [".*account.*"], [".*/\api\/v1\/.*?\/login"]
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Uma matriz de cabeçalhos de solicitação HTTP que o agente de segurança deve ignorar nas varreduras IAST . A matriz deve especificar uma lista de padrões correspondentes aos cabeçalhos a serem ignorados.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Uma matriz de parâmetros de consulta de solicitação HTTP que o agente de segurança deve ignorar em varreduras IAST . A matriz deve especificar uma lista de padrões correspondentes à solicitação HTTP consulta parâmetro a ser ignorada.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Uma matriz de chaves de corpo de solicitação HTTP que o agente de segurança deve ignorar nas verificações IAST.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, disables the detection of low-severity insecure settings. For example, hash, crypto, cookie, random generators, and trust boundary.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desabilita as detecções IAST relacionadas à operação do arquivo (violação de acesso ao arquivo e integridade do aplicativo)
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desabilita a detecção de injeção de SQL em varreduras IAST.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, disables NoSQL injection detection in IAST scans.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desabilita a detecção de injeção de LDAP em varreduras IAST.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, disables JavaScript injection detection in IAST scans.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desabilita a detecção de injeção de comando do sistema em varreduras IAST.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, disables XPath injection detection in IAST scans.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, disables Server-Side Request Forgery (SSRF) detection in IAST scans.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, desabilita a detecção de script entre sites refletido (RXSS) em verificações IAST .
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Especifica o tempo de atraso (em minutos) antes do início da varredura IAST após o início do aplicativo.
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Specifies the duration (in minutes) for which the IAST scan is performed.
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
Especifica uma expressão cron que define quando a verificação IAST deve ser executada.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, permite que IAST reúna continuamente dados trace em segundo plano. O agente de segurança usa os dados coletados para executar uma verificação IAST no horário agendado.
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Sets the maximum number of HTTP requests allowed per minute for the IAST scan. Must be an integer between 12 and 3600 (default).
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
O número de instância do aplicativo para uma entidade específica na qual realizar a análise IAST .
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, habilita o envio de corpos de respostas HTTP. Desabilitar isso também desabilita a detecção de vulnerabilidades do Reflected Cross-Site Script (RXSS).
Tipo | Corda |
|---|---|
Padrão |
|
Variável ambiental |
|
A unique test identifier when running IAST in a CI/CD environment to differentiate between different test runs. For example, a build number.
Modo sem servidor
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente operará em um modo simplificado adequado para uso com funções sem servidor de curta duração. OBSERVAÇÃO:AWS Somente a função do Lambda é suportada atualmente e esta opção não deve ser usada sem a New Relic Ruby Lambda oferta da camada da .
Auxiliar
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
An array of strings that will collectively serve as an allowlist for filtering which Sidekiq job arguments get reported to New Relic. To capture any Sidekiq arguments, job.sidekiq.args.* must also be added to the separate attributes.include configuration option. Each string in this array will be turned into a regular expression via Regexp.new to permit advanced matching. For job argument hashes, if either a key or value matches, the pair will be included. All matching job argument array elements and job argument scalars will be included.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
An array of strings that will collectively serve as a denylist for filtering which Sidekiq job arguments get reported to New Relic. To capture any Sidekiq arguments, job.sidekiq.args.* must also be added to the separate attributes.include configuration option. Each string in this array will be turned into a regular expression via Regexp.new to permit advanced matching. For job argument hashes, if either a key or value matches, the pair will be excluded. All matching job argument array elements and job argument scalars will be excluded.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente ignorará as exceções geradas durante as tentativas de repetição do Sidekiq e só reportará o erro se o trabalho falhar permanentemente.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente inicia uma nova transação quando um job do Sidekiq é executado durante uma transação da web. Isso impede que o tempo de execução do job do Sidekiq seja incluído nas métricas de transação da web.
SQL lento
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente coleta consultas SQL lentas.
Tipo | Float |
|---|---|
Padrão |
|
Variável ambiental |
|
Especifique um limite em segundos. O agente coleta consultas SQL lentas e explica os planos que excedem esse limite.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
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 |
|
Variável ambiental |
|
If true, the agent generates a longer sql_id for slow SQL traces. sql_id is used for aggregation of similar queries.
Evento de extensão
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, habilita a amostragem de eventos de extensão.
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Define o número máximo de eventos de span para buffer durante o streaming para o observador trace .
Tipo | Inteiro |
|---|---|
Padrão |
|
Variável ambiental |
|
Defines the maximum number of span events reported from a single harvest. Any Integer between 1 and 10000 is valid. When configuring the agent for AI monitoring, set to max value 10000. This ensures the agent captures the maximum amount of distributed traces.
Remover mensagens de exceção
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
If true, the agent strips messages from all exceptions except those in the allowed classes list. Enabled automatically in high security mode.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
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 |
|
Uma matriz de strings para especificar quais chaves dentro do hash user_data de um evento Stripe devem ser reportadas ao New Relic. Cada string nesta matriz será transformada em uma expressão regular via Regexp.new para habilitar a correspondência avançada. Definir o valor como ["."] reportará todos user_data.
Tipo | Matriz |
|---|---|
Padrão |
|
Variável ambiental |
|
Uma matriz de strings para especificar quais chaves e/ou valores dentro do hash user_data de um evento do Stripe não devem ser reportados ao New Relic. Cada string nesta matriz será transformada em uma expressão regular via Regexp.new para permitir correspondência avançada. Para cada par de hash aplica, se a chave ou o valor forem correspondidos, o par não será relatado. Por padrão, nenhum user_data é relatado. Use esta opção somente se a opção stripe.user_data.include também for usada.
Profiler de thread
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, habilita o uso do thread profiler.
Utilização
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente detectará automaticamente que está em execução em um ambiente AWS.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente detecta automaticamente que está em execução em um ambiente do Azure.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente detecta automaticamente que está em execução no Docker.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente detectará automaticamente que está em execução em um ambiente do Google Cloud Platform.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente relata o ID da instância do GCP como o nome do host ao ser executado no Google Cloud Run.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente adiciona o valor K_REVISION como prefixo ao ID da instância do GCP para formar o nome do host ({K_REVISION}-{instance id}) no Google Cloud Run. Não tem efeito a menos que utilization.gcp_cloud_run.use_instance_as_host também seja true.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente detectará automaticamente que está em execução no Kubernetes.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente detectará automaticamente que está em execução em um ambiente Pivotal Cloud Foundry.
Tipo | Boleano |
|---|---|
Padrão |
|
Variável ambiental |
|
Se true, o agente executará a detecção de ambiente em paralelo para acelerar o tempo de inicialização do agente.