Importante
Recomendamos atualizar para a versão mais recente do agente assim que estiver disponível. Se você não puder atualizar para a versão mais recente, atualize seu agente para uma versão com no máximo 90 dias. Saiba mais sobre como manter o agente atualizado.
Consulte a política de fim de vida útil do agente Ruby New Relic para obter informações sobre lançamentos de agentes e datas de suporte.
v10.5.0
Recurso: adicionar suporte ao Dalli 5.0 e corrigir a instrumentação do metaprotocolo
O agente agora oferece suporte ao Dalli 5.0+, que removeu
Dalli::Protocol::Binaryexclusivamente em favor do metaprotocolo. Para Dalli 3.2.0+, A instrumentaçãopipelined_getagora temDalli::Protocol::Basecomo destino corretamente (onde o método é definido) em vez deDalli::Protocol::Binary, corrigindo uma lacuna em que as chamadasget_multinão eram instrumentadas ao usar o metaprotocolo. Para o Dalli 5.0+, o agente adicionalmente instrumentaDalli::Protocol::Meta#read_multi_req, que é invocado pela otimizaçãoget_multide servidor único do Dalli. PR#3541Recurso: adicionar opção de configuração active_record_use_table_name
Uma nova opção de configuração,
active_record_use_table_name, usa o nome da tabela de um modelo Active Record em vez do nome de sua classe ao nomear métricas, spans e segmentos de trace da transação. Isso pode ser particularmente útil para reduzir a cardinalidade em aplicativos usando herança de tabela única. A opção tem como padrãofalsepara preservar o comportamento existente. PR#3540Recurso: ocultar parcialmente chaves de licença nos logs do agente
Anteriormente, o agente ocultava completamente as chaves de licença da New Relic nos logs do agente. Agora, os primeiros 10 caracteres são visíveis enquanto o restante é substituído por
*. Isso preserva o suficiente para solucionar problemas relacionados à região sem expor a parte secreta da chave. PR#3547Correção de bug: corrigir a incompatibilidade da instrumentação do Semantic Logger com
rails_semantic_loggerAnteriormente, um
ArgumentErrorera gerado quando uma exceção atingiaActionDispatch::DebugExceptionsao usarrails_semantic_logger. Isso foi corrigido. Obrigado a @jdelStrother por relatar isso! PR#3548
Importante
Recomendamos atualizar para a versão mais recente do agente assim que estiver disponível. Se você não puder atualizar para a versão mais recente, atualize seu agente para uma versão com no máximo 90 dias. Saiba mais sobre como manter o agente atualizado.
Consulte a política de fim de vida útil do agente Ruby New Relic para obter informações sobre lançamentos de agentes e datas de suporte.
v10.4.0
Recurso: adicionar instrumentação do Rails.event para logging estruturado
O agente agora suporta Rails.event como eventos de log estruturados. Quando habilitado, os eventos publicados via
Rails.event.notifysão capturados e encaminhados para o New Relic como eventos de log. Cargas de evento, tags, contexto, timestamps e locais de origem são capturados automaticamente como atributos de log.Esta instrumentação pode ser configurada com as seguintes opções:
instrumentation.rails_event_logger- Controla se a instrumentação de Rails.event está habilitada. Por padrão, usa o valor deapplication_logging.enabled.instrumentation.rails_event_logger.event_names- Uma matriz de nomes de eventos específicos para capturar. Quando vazio (padrão), todas as notificações do Rails.event são capturadas. Use isso para filtrar eventos por nome, por exemplo:['user.signup', 'payment.processed'].
Recurso: adicionar instrumentação para Rails Active Job Continuations
O agente agora instrumenta as continuações do Active Job do Rails, fornecendo visibilidade da execução de etapas individuais em tarefas de longa duração. Os nomes dos passos são incluídos nas métricas de segmento (por exemplo,
Ruby/ActiveJob/default/MyJob/step/process_records) e atributos específicos do passo, como posição do cursor, status retomado e status interrompido, são capturados. Uma nova opção de configuração,disable_active_job_step_names, permite que os usuários excluam nomes de etapas dos nomes de métricas para reduzir a cardinalidade da métrica, se necessário (o padrão éfalse). PR#3493Recurso: Adicionar sidekiq.separate_transactions opção de configuração
Uma nova opção de configuração,
sidekiq.separate_transactions, permite que as tarefas do Sidekiq executadas durante uma transação da web sejam executadas em sua própria transação separada. Quando habilitado, isso evita que o tempo de execução do job do Sidekiq seja incluído nas métricas de transação da web, fornecendo dados de desempenho mais precisos. O recurso é opt-in (padrão: falso) para manter a compatibilidade com versões anteriores. Isso afeta apenas os trabalhos executados durante transações da web ativas; os trabalhos iniciados de forma independente ou aninhados em outros trabalhos em segundo plano não são afetados. Issue#3364 PR#3514Correção de bug: atualizar regexes que podem ter sido vulneráveis a ataques ReDOS
Anteriormente, o agente tinha algumas regexes identificadas como possíveis destinos para ataques de complexidade de tempo polinomial (ReDOS). Essas regexes agora estão atualizadas para abordar as preocupações. PR#3520
Correção de bug: evitar falhas durante a criação de segmento HTTPX
Anteriormente, se
start_external_request_segmentencontrasse um erro e retornassenil, o agente acionaria umNoMethodErrorao tentar adicionar cabeçalhos ao segmento ausente. Adicionamos uma verificação de segurança para garantir que a instrumentação lide com esses casos de forma adequada.Parabéns a @thebravoman pelo relatório! Issue#3509 PR#3510
Correção de bug: tornar Transaction#finish idempotente
Anteriormente, se o método Transaction#finish fosse chamado várias vezes, mais de uma transação poderia ser criada para a mesma operação. Agora, um mutex protege as chamadas para Transaction#finish para garantir que as operações de finalização sejam executadas apenas uma vez. PR#3513
Correção de bug: Aviso único de descontinuação do Log para a API Datastores.wrap
Anteriormente, esse aviso estava sendo registrado a cada chamada para Datastores.wrap. Agora, isso será registrado apenas na primeira chamada. Além disso, a documentação foi atualizada para indicar o status descontinuado do segundo e terceiro argumentos de retorno de chamada. Issue#3516 PR#3519
Importante
Recomendamos atualizar para a versão mais recente do agente assim que estiver disponível. Se você não puder atualizar para a versão mais recente, atualize seu agente para uma versão com no máximo 90 dias. Saiba mais sobre como manter o agente atualizado.
Consulte a política de fim de vida útil do agente Ruby New Relic para obter informações sobre lançamentos de agentes e datas de suporte.
v10.3.0
Recurso: adicionar nomenclatura de consulta ao banco de dados via comentários SQL
As consultas ao banco de dados agora podem ser nomeadas explicitamente usando comentários SQL. Consultas podem incluir comentários
/* NewRelicQueryName: CustomName */para atribuir nomes estáveis para melhor rastreamento e identificação. Isso é especialmente útil para rastrear consultas específicas ao banco de dados durante regressões de desempenho ou incidentes. PR#3480Recurso: Adicionar instrumentação do Semantic Logger
O agente agora suporta encaminhamento de logs e decoração do Semantic Logger para o gem
semantic_loggerversões 4.6.0+. Se você usava anteriormente o anexador do New Relic integrado do agente Semantic, é recomendável escolher uma abordagem para evitar o envio de logs duplicados. A instrumentação do agente Semantic da New Relic pode ser desabilitada definindoinstrumentation.semantic_loggercomodisabled. PR#3467Agradecemos a @jdelStrother por fornecer feedback valioso que ajudou a moldar esta instrumentação.
Recurso: adicionar nova configuração 'ignored_middleware_classes'
Uma nova opção de configuração,
ignored_middleware_classes, permite que os usuários excluam middlewares específicos da instrumentação (ex. Rack::Cors). O padrão é uma matriz vazia. Issue#1814 PR#3481Recurso: Adicionar nova API
NewRelic::Agent.add_transaction_log_attributesUma nova API,
NewRelic::Agent.add_transaction_log_attributes, permite aos usuários adicionar atributo personalizado com escopo de transação ao evento de log para a transação atual. Esses atributos serão aplicados apenas aos logs criados dentro do escopo da transação atual. PR#3472Correção de bug: fornecer opção de configuração para reduzir a cardinalidade de métricas de broadcast do ActionCable
Por padrão, as métricas para chamadas do método broadcast do ActionCable incluem o valor do broadcasting. Esse valor pode ter cardinalidade muito alta. Agora, a opção de configuração
:simplify_action_cable_broadcast_metricspermite que os usuários removam o valor de transmissão do nome da métrica. Isso cria uma métrica que se parece com:Ruby/ActionCable/broadcast. Quando esta opção de configuração estiver habilitada, o valor de broadcasting será adicionado como um atributo de span. PR#3463Correção de bug: remover require 'digest/md5' inativo para conformidade com FIPS/FedRAMP
Na versão 7.1.0 do agente, o uso do MD5 foi substituído pelo SHA1 para conformidade com FIPS (PR). No entanto, o antigo require para 'digest/md5' não foi removido. Removemos o requisito para ajudar nossos usuários FIPS/FedRAMP. Obrigado a @ashleyboehs por trazer isso à nossa atenção! Issue#3469 PR#3470
Correção de bug: impedir a inicialização do agente durante
rails testpara evitar atraso no desligamentoAnteriormente, o agente causava um atraso de -3 segundos no encerramento ao executar o comando
rails test. A constanteRails::Command::TestCommandfoi adicionada à listaautostart.denylisted_constantspadrão para impedir que o agente inicie durante as execuções de teste do Rails. Obrigado a @varyform por trazer isso à nossa atenção. PR#3478Correção de bug: corrige avisos de "Não foi possível calcular o tempo de transação decorrido" ao usar o servidor web Falcon
O agente agora usa
Fiber.current.object_idem vez deThread.current.object_idpara rastrear o estado da transação ao executar no Falcon, evitando colisões de requests concorrentes que compartilham a mesma thread. Também corrige um "NameError: uninitialized constantAsync::HTTP::VERSION" ao usar o Falcon. Obrigado a @97jaz e @gsar por trazerem isso à nossa atenção. PR#3483Correção de bug: corrigir erro de digitação em harvest.rb causando NoMethodError
Um erro de digitação em
lib/new_relic/agent/agent_helpers/harvest.rbcausou umNoMethodError: undefined method 'agent' for NewRelic:Module. Obrigado a @oakbow por relatar este problema. PR#3484Correção de bug: remove o uso do ObjectSpace._id2ref obsoleto
O agente agora usa uma abordagem alternativa em vez do método
ObjectSpace._id2refdescontinuado, eliminando avisos de descontinuação ao executar no Ruby 4.0+. PR#3490Correção de bug: corrigir NoMethoError na instrumentação de Logging
Anteriormente, quando a instrumentação da gem Logging tentava decorar logs locais, ela lançava um
NoMethodErrorse encontrasse um objeto não string. O problema já foi resolvido. PR#3501
Importante
Recomendamos atualizar para a versão mais recente do agente assim que estiver disponível. Se você não puder atualizar para a versão mais recente, atualize seu agente para uma versão com no máximo 90 dias. Saiba mais sobre como manter o agente atualizado.
Consulte a política de fim de vida útil do agente Ruby New Relic para obter informações sobre lançamentos de agentes e datas de suporte.
v10.2.0
Recurso: Introduzir Agente Híbrido para suporte ao Rastreamento OpenTelemetry
As APIs de rastreamento do OpenTelemetry agora podem ser traduzidas em telemetria da New Relic com os novos recursos de Agente Híbrido do agente Ruby da New Relic. Isso permite que a gem
newrelic_rpmse comporte de forma semelhante a um SDK OpenTelemetry, aceitando chamadas da API OpenTelemetry e transformando-as em Transações e Segmentos do New Relic com atributos e nomes familiares.As seguintes opções de configuração referem-se aos recursos do Hybrid Agent:
Nome da configuração Padrão Comportamento opentelemetry.enabled falseUma opção de configuração global para desativar todos os sinais do OpenTelemetry enviados pelo New Relic. opentelemetry.traces.enabled truePermite a criação de segmentos de Transaction Trace e métricas de timeslice a partir de Spans do OpenTelemetry opentelemetry.traces.include ''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 sinais de rastreamento enviados para a New Relic. opentelemetry.traces.exclude ''Uma lista de rastreadores do OpenTelemetry delimitada por vírgulas, representada como uma string (por exemplo, "AppTracer1,OpenTelemetry::Instrumentation::Bunny::Instrumentation"), que não terão seus sinais de trace enviados para o New Relic. Todos os rastreadores conhecidos para instrumentação que conflita com a instrumentação da New Relic são excluídos por padrão. Recurso: Adicionar opção de configuração error_collector.backtrace_truncate_location
Uma nova opção de configuração foi adicionada,
error_collector.backtrace_truncate_location, que permite ao usuário especificar onde truncar o backtrace quando o número de frames excedererror_collector.max_backtrace_frames. As opções são'top'(remove frames do início),'middle'(remove frames do meio, preservando o início e o fim) ou'end'(remove frames do fim). O padrão é'middle'. PR#3424Recurso: Adicionar instrumentação da gem Logging
O agente agora registrará logs gerados pela gem Logging. PR#3420
Funcionalidade: Adicionar opção de configuração utilization.detect_in_parallel
Uma nova opção de configuração foi adicionada,
utilization.detect_in_parallel, que controla se o agente usa threads ao detectar informações do provedor de nuvem para acelerar a inicialização do agente. Quando definido comofalse, a detecção de fornecedor é executada sequencialmente sem criar threads. O padrão étrue. PR#3439
Importante
We recommend updating to the latest agent version as soon as it's available. If you can't upgrade to the latest version, update your agents to a version no more than 90 days old. Read more about keeping agents up to date.
See the New Relic Ruby agent EOL policy for information about agent releases and support dates.
v10.1.0
Feature: Add support for forking processes in Parallel gem instrumentation
Parallel gem instrumentation has been added to allow more consistent monitoring in processes forked using the Parallel gem. PR#3405
Feature: Add support for Grape v3.1.0
Grape's release of v3.1.0 introduced changes that were incompatible with the agent's instrumentation, causing issues when collecting transaction names. The agent has been updated to properly extract class names for transaction naming in the updated Grape API structure. PR#3413
Bugfix: Create health check files in forked processes
The agent now properly initializes health check loops after forking, ensuring each process generates its own health check file. This fix also has the effect of correctly including
entity.guidvalues in the health check files. PR#3409 Issue#3408Bugfix: Fix
sidekiq.ignore_retry_errorsThe configuration option
sidekiq.ignore_retry_errors: truewas continuing to report retry errors. The agent now correctly ignores retry errors and only reports when jobs permanently fail. PR#3399
Importante
Major Version Update: This version of the Ruby agent is a SemVer MAJOR update and contains breaking changes. MAJOR versions may drop support for language runtimes that have reached End-of-Life according to the maintainer. Additionally, MAJOR versions may drop support for and remove certain instrumentation. For more details on these changes please see the migration guide here.
Importante
We recommend updating to the latest agent version as soon as it's available. If you can't upgrade to the latest version, update your agents to a version no more than 90 days old. Read more about keeping agents up to date.
See the New Relic Ruby agent EOL policy for information about agent releases and support dates.
v10.0.0
Breaking Change: Remove support for Ruby 2.4 and 2.5
Support for Ruby versions 2.4 and 2.5 has been removed. The new minimum required Ruby version is now 2.6. PR#3314
Breaking Change: Removal of Cross Application Tracing (CAT)
Previously, Cross Application Tracing (CAT) was deprecated in favor of Distributed Tracing. CAT functionality has now been removed. The configuration option
cross_application_tracer.enabledhas been removed. Public API methodsNewRelic::Agent::External.process_request_metadata,NewRelic::Agent::External.get_response_metadata,NewRelic::Agent::Transaction::ExternalRequestSegment#process_response_metadata,NewRelic::Agent::Transaction::ExternalRequestSegment#get_request_metadata, andNewRelic::Agent::Transaction::ExternalRequestSegment#read_response_headershave also been removed. PR#3333Breaking Change: Rename ActiveJob metrics and segments
ActiveJob metrics have been updated to include the job's class name for more specific reporting. This is a breaking change and may require updating custom dashboards or alerts. PR#3370 PR#3320
- Old format:
Ruby/ActiveJob/<QueueName>/<Method> - New format:
Ruby/ActiveJob/<QueueName>/<ClassName>/<Method>
In addition, segments created for Active Job enqueuing actions now include the job class.
- Old format:
ActiveJob/<QueueAdapter>/Queue/<Event>/Named/<QueueName> - New format:
ActiveJob/<QueueAdapter>/Queue/<Event>/Named/<QueueName>/<ClassName>
- Old format:
Breaking Change: Rename
bin/newreliccommand tobin/newrelic_rpmThe executable file for the agent's CLI has been renamed from
bin/newrelictobin/newrelic_rpm. This change resolves a name collision with the standalone New Relic CLI tool. PR#3323Breaking Change: Remove the
newrelic deploymentsCLI commandThe deprecated
newrelic deploymentsCLI command has been removed. To track changes and deployments in New Relic, please see our guide to Change Tracking for a list of available options. PR#3299Breaking Change: Remove the NewRelic::Agent::SqlSampler#notice_sql method
Users should call
NewRelic::Agent::Datastores.notice_sqlinstead. PR#3338Breaking Change: Remove unused arguments from various NewRelic::Agent::Datastores APIs
The following APIs from the
NewRelic::Agent::Datastoresclass have had method arguments removed:NewRelic::Agent::Datastores.notice_sql, previously had three positional arguments,query,scoped_metricandelapsed. Now, it only hasquery.NewRelic::Agent::Datastores.notice_statement, previously had two positional argumentsqueryandelapsed. Now it only hasquery.NewRelic::Agent::Datastores.wraprequires a proc. Previously the proc received three arguments: the result of the yield, the most specific scoped metric name, and the elapsed time of the call. Now, it only receives one: the result of the yield.
The values of the removed arguments are derived from the current segment at the time of the call. PR#3347
Breaking Change: Remove experimental feature Configurable Security Policies (CSP)
The experimental feature, Configurable Security Policies (CSP), is no longer supported and has been removed. PR#3292
Breaking Change: Remove support for Puma versions < 3.9.0
The minimum version of Puma now supported is 3.9.0 or higher. PR#3326
Breaking Change: Improve configuration validation and coercion
The internals used to coerce and validate the values provided for agent configuration are now more performant and more accurate.
- Warning messages will now be logged to the newrelic_agent.log file when nil is provided as a config value for a setting that does not support it.
- Integer values are permitted for Float configuration types
- Float values are permitted for Integer configuration types
- Fatal interruptions are prevented when a default value can be found to replace an invalid input value PR#3341
Breaking Change: Replace 'default' option with 'adaptive' for distributed tracing remote parent samplers
Previously, the default option for
distributed_tracing.sampler.remote_parent_sampledanddistributed_tracing.sampler.remote_parent_not_sampledwasdefault, which used the pre-existing adaptive sampler. Thedefaultoption has been renamed toadaptive. PR#3363Feature: Add
loggeras a dependencyThe
loggergem is now listed as a dependency of the agent to ensure continued logging functionality and support for Ruby 4.0.0 and newer versions. PR#3293Feature: Add Active Support notification allowlist configuration option
A new configuration option,
instrumentation.active_support_notifications.active_support_events, allows users to define an allowlist of Active Support notifications event names for the agent to subscribe to. By default, the agent subscribes to all Active Support: Caching and Active Support: Messages events. PR#3327Feature: Use Ruby's built-in Gzip compression
The agent now uses the built-in
Zlib.gzipmethod from the Ruby standard library for compression, replacing the previous custom implementation. PR#3332Feature: Add argument validation for the
NewRelic::Agent#record_custom_eventAPIThe
NewRelic::Agent#record_custom_eventAPI now raises anArgumentErrorwhen an invalidevent_typeis provided. A valid event type must consist only of alphanumeric characters, underscores (_), colons (:), or spaces (). PR#3319Feature: Add root sampling configuration options
You can now configure the sampling behavior for traces that originate within the current service using
distributed_tracing.sampler.root. PR#3330There are four modes available:
Mode Description adaptiveUses the existing adaptive sampler algorithm always_offMarks 0% of root traces as sampled always_onMarks 100% of root traces as sampled trace_id_ratio_basedSamples traces based on a ratio set in distributed_tracing.sampler.root.trace_id_ratio_based.ratio. The ratio must be float between 0.0 and 1.0Feature: Add Trace ID Ratio Based sampling options
The agent can now sample traces using the OpenTelemetry Trace ID Ratio Based sampler algorithm. PR#3330 This samples traces based on a probability between 0.0 and 1.0 based on the trace ID.
To use this option, you must first set your distributed tracing sampler configuration to
trace_id_ratio_basedand then set the correspondingdistributed_tracing.sampler.*.trace_id_ratio_based.ratiosampler to a Float between 0.0 and 1.0.For example:
distributed_tracing.sampler.remote_parent_sampled: 'trace_id_ratio_based'distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio': 0.5This configuration would sample approximately 50% of your traces for all traces where the remote parent is sampled.
This option is available for:
distributed_tracing.sampler.rootdistributed_tracing.sampler.remote_parent_sampleddistributed_tracing.sampler.remote_parent_not_sampled
Feature: Add Entity GUID to Agent Control health check files
When the agent is started within an Agent Control environment, a health check file is created at the configured file location for every agent process. This file now includes the guid of the entity related to the agent when available. PR#3371
Bugfix: Resolve a
NoMethodErrorin GCP utilization detection.The GCP metadata discovery logic will now gracefully handle
nilor unexpected values, preventing service initialization crashes. PR#3388