Sha256: a20fb9e38670152afbc8030697041832dfef54e3d03ea62ca80f7c09725fb751

Contents?: true

Size: 1.76 KB

Versions: 11

Compression:

Stored size: 1.76 KB

Contents

# 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.
#
# A Sampler is used to capture meaningful metrics in a background thread
# periodically.  They will be invoked about once a minute, each time the agent
# sends data to New Relic's servers.
#
# Samplers can be added to New Relic by subclassing NewRelic::Agent::Sampler.
# Instances are created when the agent is enabled and installed.  Subclasses
# are registered for instantiation automatically.
module NewRelic
  module Agent
    class Sampler

      # Exception denotes a sampler is not available and it will not be registered.
      class Unsupported < StandardError;  end

      attr_reader :id
      @sampler_classes = []

      class << self
        attr_reader :shorthand_name
      end

      def self.named(new_name)
        @shorthand_name = new_name
      end

      def self.inherited(subclass)
        @sampler_classes << subclass
      end

      # Override with check.  Called before instantiating.
      def self.supported_on_this_platform?
        true
      end

      def self.enabled?
        if shorthand_name
          config_key = "disable_#{shorthand_name}_sampler"
          !(Agent.config[config_key])
        else
          true
        end
      end

      def self.sampler_classes
        @sampler_classes
      end

      # The ID passed in here is unused by our code, but is preserved in case
      # we have clients who are defining their own subclasses of this class, and
      # expecting to be able to call super with an ID.
      def initialize(id=nil)
        @id = id || self.class.shorthand_name
      end

      def poll
        raise "Implement in the subclass"
      end
    end
  end
end

Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
newrelic_rpm-8.2.0 lib/new_relic/agent/sampler.rb
newrelic_rpm-8.1.0 lib/new_relic/agent/sampler.rb
newrelic_rpm-8.0.0 lib/new_relic/agent/sampler.rb
newrelic_rpm-7.2.0 lib/new_relic/agent/sampler.rb
newrelic_rpm-7.1.0 lib/new_relic/agent/sampler.rb
newrelic_rpm-7.0.0 lib/new_relic/agent/sampler.rb
newrelic_rpm-6.15.0 lib/new_relic/agent/sampler.rb
newrelic_rpm-6.14.0 lib/new_relic/agent/sampler.rb
newrelic_rpm-6.13.1 lib/new_relic/agent/sampler.rb
newrelic_rpm-6.13.0 lib/new_relic/agent/sampler.rb
newrelic_rpm-6.12.0.367 lib/new_relic/agent/sampler.rb