# encoding: utf-8 # This file is distributed under New Relic's license terms. # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details. require 'new_relic/agent/priority_sampled_buffer' module NewRelic module Agent class EventAggregator class << self def named named = nil named ? @named = named.to_s.freeze : @named end def capacity_key key = nil key ? @capacity_key = key : @capacity_key end # An aggregator can specify one or more keys to check to see if it is # enabled. Multiple keys will be &&'d and the enabled status of the # aggregator will be reset when agent configuration changes. def enabled_keys *keys if keys.empty? @enabled_keys ||= [] else @enabled_keys = Array(keys) @enabled_fn = ->(){ @enabled_keys.all? { |k| Agent.config[k] } } end end alias_method :enabled_key, :enabled_keys # This can be used instead of `enabled_key(s)` for more fine grained # control over whether an aggregator should be enabled. The enabled fn # will be reevaluated after configuration changes def enabled_fn fn = nil fn ? @enabled_fn = fn : @enabled_fn end def buffer_class klass = nil if klass @buffer_class = klass else @buffer_class ||= PrioritySampledBuffer end end end def initialize events @lock = Mutex.new @buffer = self.class.buffer_class.new NewRelic::Agent.config[self.class.capacity_key] @enabled = self.class.enabled_fn ? self.class.enabled_fn.call : false @notified_full = false register_capacity_callback register_enabled_callback events after_initialize end # interface method for subclasses to override to provide post-initialization setup def after_initialize end # interface method for subclasses to override to provide post harvest functionality def after_harvest metadata end def enabled? @enabled end def has_metadata? true end def harvest! metadata = nil samples = [] @lock.synchronize do samples.concat @buffer.to_a metadata = @buffer.metadata reset_buffer! end after_harvest metadata [reservoir_metadata(metadata), samples] end # Merges samples from payload back into buffer and optionally adjusts the count of # the buffer to ensure accuracy of buffer of metadata. We want to make sure not to # double count samples being merged back in from a failed harvest, yet we do not # want to under-count samples being merged from the PipeService. def merge! payload, adjust_count = true @lock.synchronize do _, samples = payload if adjust_count @buffer.decrement_lifetime_counts_by samples.count end samples.each { |s| @buffer.append event: s } end end def reset! @lock.synchronize do reset_buffer! end end private def reservoir_metadata metadata { :reservoir_size => metadata[:capacity], :events_seen => metadata[:seen] } end def register_capacity_callback NewRelic::Agent.config.register_callback(self.class.capacity_key) do |max_samples| NewRelic::Agent.logger.debug "#{self.class.named} max_samples set to #{max_samples}" @lock.synchronize do @buffer.capacity = max_samples end end end def register_enabled_callback events events.subscribe(:server_source_configuration_added) { @enabled = self.class.enabled_fn.call reset! if @enabled == false ::NewRelic::Agent.logger.debug "#{self.class.named} will #{@enabled ? '' : 'not '}be sent to the New Relic service." } end def notify_if_full return unless !@notified_full && @buffer.full? NewRelic::Agent.logger.debug "#{self.class.named} capacity of #{@buffer.capacity} reached, beginning sampling" @notified_full = true end def reset_buffer! @buffer.reset! @notified_full = false end end end end