Ruby métriques personnalisées

les métriques personnalisées vous permettent d'enregistrer des données de performances arbitraires via un appel d'API (par exemple, des données de timing ou de ressources informatiques). Utilisez ensuite le générateur de requêtes pour créer des graphiques et suivre cette métrique. Vous pouvez utiliser des métriques personnalisées pour unifier votre monitoring dans New Relic.

Nommer les métriques

les noms métriques identifient des valeurs de données spécifiques suivies par New Relic. Lorsque vous utilisez l'API de l'agent Ruby New Relic pour suivre les métriques personnalisées, il est important de prendre en compte la dénomination de vos métriques et la manière dont les valeurs seront agrégées.

Un nom métriques personnalisées se compose du préfixe Custom/, du nom de la classe ou de la catégorie et d'une étiquette, chacun séparé par une barre oblique /: Custom/<class>/<method> ou Custom/<category>/<name> (par exemple, Custom/MyClass/My_method).

<category>/<class>/<method>

class MetricSpec
  attr_accessor :name    # String - metric name
  attr_accessor :scope   # String - current controller action
end

class Stats
  attr_accessor :call_count           # Integer - method invocation count
  attr_accessor :total_call_time      # Float - total method call time (in seconds)
  attr_accessor :total_exclusive_time # Float - total time spent in the traced method minus any child time (in seconds)
  attr_accessor :min_call_time        # Float - the smallest method invocation time (in seconds)
  attr_accessor :max_call_time        # Float - the largest method invocation time (in seconds)
  attr_accessor :sum_of_squares       # Float - the sum of squares of response times - used for standard deviation computation
  attr_accessor :begin_time           # Time - the start of the time window for this data
  attr_accessor :end_time             # Time - end of the time window for this data
end

Enregistrer des métriques personnalisées

L'API publique pour l'enregistrement des données métriques se compose de deux méthodes sur NewRelic::Agent, record_metric et increment_metric.

record_metric(metric_name, value)

record_metric doit être utilisé pour enregistrer une métrique basée sur un événement, généralement associée à une durée particulière. metric_name doit être une chaîne suivant les règles de dénomination métrique standard. value sera généralement un numérique, mais peut également être un hacher.

Lorsque value est une valeur numérique, elle doit représenter l'ampleur d'une mesure associée à un événement, comme la durée d'un appel de méthode particulier.

Lorsque value est un hacher, il doit contenir les clés :count, :total, :min, :max et :sum_of_squares , toutes avec des valeurs numériques. Ce formulaire est utile si vous souhaitez effectuer vous-même des métriques agrégées et les signaler périodiquement (par exemple, à partir d'un fil de discussion en arrière-plan). Les statistiques fournies seront agrégées avec toutes les valeurs précédemment collectées pour la même métrique. Les noms des clés Hacher ont été choisis pour correspondre aux noms des clés utilisées par l'API de la plateforme.

increment_metric(metric_name, amount=1)

increment_metric devrait être utilisé pour mettre à jour une métrique qui agit comme un simple compteur. Le nombre de la métrique sélectionnée sera incrémenté du montant spécifié.

Exemple de métriques personnalisées

Voici un exemple qui montre comment vous pouvez utiliser des métriques pour suivre les flux monétaires sur un site :

class Cart

  def checkout()
    amount = compute_cart_total    # computes the amount to charge the customer

    ::NewRelic::Agent.record_metric('Custom/Cart/charge_amount', amount)

    charge_customer(amount)
    ...
  end
end

Pour plus d'informations sur la manière dont les données s'agrègent au fil du temps, consultez la politique d'agrégation de Stat.

Afficher les métriques personnalisées

Pour afficher ces métriques personnalisées, utilisez le générateur de requêtes pour rechercher des métriques, créer des graphiques personnalisables et ajouter ces graphiques au dashboard.