Visão geral da configuração

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:

1. Adicione o prefixo NEW_RELIC_ ao nome da configuração.
2. 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:

1. Variáveis ambientais
2. Configuração no lado do servidor
3. Arquivo de configuração (newrelic.yml)
4. 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: info
development:
  <<: *default_settings
  log_level: debug

O agente Ruby procura as seguintes variáveis de ambiente, nesta ordem, para localizar o ambiente do aplicativo:

1. NEW_RELIC_ENV
2. RUBY_ENV
3. RAILS_ENV
4. APP_ENV
5. 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 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.

Referência de configurações

Todas as definições de configuração estão documentadas nas subpáginas abaixo. Cada definição mostra seu tipo, valor padrão e a variável de ambiente equivalente.