Module NewRelic::Agent::StatsEngine::MetricStats
In: lib/new_relic/agent/stats_engine/metric_stats.rb

Handles methods related to actual Metric collection @api public

Methods

apply_rules_to_metric_data   clear_stats   coerce_to_metric_spec_array   get_stats   get_stats_no_scope   harvest!   merge!   merge_transaction_metrics!   record_scoped_and_unscoped_metrics   record_unscoped_metrics   reset!   reset_stats   tl_record_scoped_and_unscoped_metrics   tl_record_supportability_metric_count   tl_record_unscoped_metrics   to_h  

Constants

SCOPE_PLACEHOLDER = '__SCOPE__'.freeze

Public Instance methods

clear_stats()

For use by test code only.

get_stats(metric_name, _ = true, scoped_metric_only = false, scope = nil)

This method is deprecated and not thread safe, and should not be used by any new client code. Use NewRelic::Agent.record_metric instead.

If scoped_metric_only is true, only a scoped metric is created (used by rendering metrics which by definition are per controller only) Leaving second, unused parameter for compatibility

@api public @deprecated Use {::NewRelic::Agent.record_metric} instead.

get_stats_no_scope(metric_name)

This method is deprecated and not thread safe, and should not be used by any new client code.

Lookup the Stats object for a given unscoped metric, returning a new Stats object if one did not exist previously.

@api public @deprecated Use {::NewRelic::Agent.record_metric} instead.

merge!(other_stats_hash)

merge data from previous harvests into this stats engine

reset_stats()

Renamed to reset!, here for backwards compatibility with 3rd-party gems (though this really isn‘t part of the public API). @deprecated

tl_record_scoped_and_unscoped_metrics(scoped_metric, summary_metrics=nil, value=nil, aux=nil, &blk)

Like tl_record_unscoped_metrics, but records a scoped metric as well.

This is an internal method, subject to change at any time. Client apps and gems should use the public API (NewRelic::Agent.record_metric) instead.

The given scoped_metric will be recoded as both a scoped and an unscoped metric. The summary_metrics will be recorded as unscoped metrics only.

If called during a transaction, all metrics will be attached to the Transaction, and not merged into the global set of metrics until the end of the transaction.

If called outside of a transaction, only the unscoped metrics will be recorded, directly into the global set of metrics (under a lock).

@api private

tl_record_supportability_metric_count(metric, value)

Helper for recording a straight value into the count

tl_record_unscoped_metrics(metric_names, value=nil, aux=nil, &blk)

Update the unscoped metrics given in metric_names. metric_names may be either a single name, or an array of names.

This is an internal method, subject to change at any time. Client apps and gems should use the public API (NewRelic::Agent.record_metric) instead.

There are four ways to use this method:

  1. With a numeric value, it will update the Stats objects associated with the given metrics by calling record_data_point(value, aux). aux will be treated in this case as the exclusive time associated with the call being recorded.
  2. With a value of :apdex_s, :apdex_t, or :apdex_f, it will treat the associated stats as an Apdex metric, updating it to reflect the occurrence of a transaction falling into the given category. The aux value in this case should be the apdex threshold used in bucketing the request.
  3. If a block is given, value and aux will be ignored, and instead the Stats object associated with each named unscoped metric will be yielded to the block for customized update logic.
  4. If value is a Stats instance, it will be merged into the Stats associated with each named unscoped metric.

If this method is called during a transaction, the metrics will be attached to the Transaction, and not merged into the global set until the end of the transaction.

Otherwise, the metrics will be recorded directly into the global set of metrics, under a lock.

@api private

to_h()

For use by test code only.

[Validate]