Ruby agent release notesRSS

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.enabled has been removed. Public API methods NewRelic::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, and NewRelic::Agent::Transaction::ExternalRequestSegment#read_response_headers have also been removed. PR#3333

Breaking 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>

Breaking Change: Rename bin/newrelic command to bin/newrelic_rpm

The executable file for the agent's CLI has been renamed from bin/newrelic to bin/newrelic_rpm. This change resolves a name collision with the standalone New Relic CLI tool. PR#3323

Breaking Change: Remove the newrelic deployments CLI command

The deprecated newrelic deployments CLI 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#3299

Breaking Change: Remove the NewRelic::Agent::SqlSampler#notice_sql method

Users should call NewRelic::Agent::Datastores.notice_sql instead. PR#3338

Breaking Change: Remove unused arguments from various NewRelic::Agent::Datastores APIs

The following APIs from the NewRelic::Agent::Datastores class have had method arguments removed:

• NewRelic::Agent::Datastores.notice_sql, previously had three positional arguments, query, scoped_metric and elapsed. Now, it only has query.
• NewRelic::Agent::Datastores.notice_statement, previously had two positional arguments query and elapsed. Now it only has query.
• NewRelic::Agent::Datastores.wrap requires 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_sampled and distributed_tracing.sampler.remote_parent_not_sampled was default, which used the pre-existing adaptive sampler. The default option has been renamed to adaptive. PR#3363

Feature: Add logger as a dependency

The logger gem 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#3293

Feature: 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#3327

Feature: Use Ruby's built-in Gzip compression

The agent now uses the built-in Zlib.gzip method from the Ruby standard library for compression, replacing the previous custom implementation. PR#3332

Feature: Add argument validation for the NewRelic::Agent#record_custom_event API

The NewRelic::Agent#record_custom_event API now raises an ArgumentError when an invalid event_type is provided. A valid event type must consist only of alphanumeric characters, underscores (_), colons (:), or spaces ( ). PR#3319

Feature: 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#3330

There are four modes available:

Feature: 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_based and then set the corresponding distributed_tracing.sampler.*.trace_id_ratio_based.ratio sampler 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.5

This 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.root
• distributed_tracing.sampler.remote_parent_sampled
• distributed_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 NoMethodError in GCP utilization detection.

The GCP metadata discovery logic will now gracefully handle nil or unexpected values, preventing service initialization crashes. PR#3388

recurso: Lembrete de descontinuação da APISqlSampler#notice_sql

O método NewRelic::Agent::SqlSampler#notice_sql está obsoleto e será removido em uma futura versão principal. Em vez disso, o usuário deve chamar NewRelic::Agent::Datastores.notice_sql. PR#3345

recurso: Aviso de obsolescência para o segundo e terceiro argumentos em Datastores.notice_sql API

O segundo (scoped_metric) e o terceiro (elapsed) argumentos no método NewRelic::Agent::Datastores.notice_sql estão obsoletos. Eles não são usados por esse método há algum tempo. Em vez disso, esses valores serão definidos com base no segmento atual no momento em que a API for chamada. PR#3345

recurso: Aviso de depreciação para o segundo argumento em Datastores.notice_statement API

O segundo argumento (elapsed) no método NewRelic::Agent::Datastores.notice_statement está obsoleto. Esse método não é utilizado há algum tempo. Em vez disso, esse valor será definido com base no segmento atual no momento em que a API for chamada. PR#3346

recurso: Aviso de descontinuação para o segundo e terceiro argumentos do procedimento na APIDatastores.wrap

O método NewRelic::Agent::Datastores.wrap está mudando. Em uma futura versão principal, o procedimento aceitará apenas um único argumento, o resultado do yield. O nome da métrica com escopo e os argumentos decorridos serão removidos, pois estão sendo removidos do método Datastores.notice_sql. O nome da métrica definida e os valores decorridos são derivados do segmento atual quando o loop é acionado. PR#3346

recurso: Adicionar sidekiq.ignore_retry_errors opção de configuração

Uma nova opção de configuração, sidekiq.ignore_retry_errors, foi adicionada para controlar se as tentativas de repetição de tarefas do Sidekiq são capturadas. Os erros de repetição são capturados por padrão, mas agora se sidekiq.ignore_retry_errors for definido como true, o agente ignorará as exceções geradas durante as tentativas de repetição do Sidekiq e só relatará o erro se o trabalho falhar permanentemente. Obrigado DonGiulio por reconhecer essa melhoria e contribuir com uma solução. PR#3317

recurso: Aviso de descontinuação para registro de implantação usando Capistrano

O envio de informações de implantação do aplicativo usando uma receita Capistrano está obsoleto e será removido na versão 10.0.0 do agente. Para registro de implantação, consulte nosso guia de Monitoramento de Alterações para obter uma lista de opções disponíveis.

recurso: Use configuração de amostragem pai remota para decisões em mais cenários

Anteriormente, as opções de configuração distributed_tracing.sampler.remote_parent_sampled e distributed_tracing.sampler.remote_parent_not_sampled eram usadas para a decisão de amostragem apenas quando os cabeçalhos traceparent e tracestate estavam presentes. Agora, essas opções de configuração são aplicadas nos casos em que o cabeçalho tracestate está ausente e quando apenas o cabeçalho newrelic está disponível. Essa mudança torna a amostragem distributed trace mais consistente e previsível. PR#3306

recurso: Instrumentação em uma etapa para Kubernetes

O Kubernetes APM auto-attach automaticamente o aplicativo instrumentado e gerencia atualizações de agente dentro da implantação Kubernetes. Este recurso saiu da versão de pré-visualização e agora está disponível para o público em geral. Saiba mais sobre a anexação automática do Kubernetes. PR#2635 PR#3287

Recurso: Aviso de descontinuação do Ruby 2.4 e Ruby 2.5

O suporte ao agente Ruby para as versões 2.4 e 2.5 do Ruby está obsoleto e será removido na versão 10.0.0 do agente. A nova versão mínima necessária do Ruby será o Ruby 2.6 e pararemos de testar com o Ruby 2.4 e 2.5. PR#3288

Recurso: Aviso de descontinuação do comando newrelic deployments

O suporte para gravação de implantação usando o comando newrelic deployments agora está obsoleto e será removido na versão 10.0.0 do agente.

No futuro, há uma série de maneiras automatizadas e manuais de registrar alterações no New Relic. Consulte nosso guia de Monitoramento de Alterações para obter uma lista de opções disponíveis. PR#3262

Recurso: Lembrete de descontinuação para rastreamento multiaplicativo

O rastreamento multiaplicativo foi descontinuado desde a versão principal 8.0.0 do Ruby Agente. Removeremos totalmente o suporte a ele na versão 10.0.0 do agente. PR#3288

Recurso: Garanta a compatibilidade com a alteração Ruby 3.5 para Method#source_location

O agente foi atualizado para analisar corretamente o valor de retorno de Method#source_location, que está mudando no Ruby 3.5 de uma matriz de dois elementos para uma de cinco elementos. Essa alteração mantém o suporte para versões mais antigas do Ruby e, ao mesmo tempo, adiciona suporte para a versão futura. PR#3257

Recurso: No modo Serverless APM, use o nome da origem do evento como prefixo do nome da transação

O agente agora usará o nome da fonte do evento como prefixo para o nome da transação no modo Serverless APM. Isso ajudará a identificar melhor a origem da transação na interface do usuário do New Relic. PR#3245

Bugfix: Reverter a lógica alterada de como rastreamos o thread em que o intervalo começa

Essa alteração restaura o comportamento anterior de rastrear o thread em que o intervalo começa, resolvendo problemas que surgiram da lógica atualizada. Obrigado @david-zw-liu por nos alertar sobre isso. PR#3248