Intégration monitoring StatsD

Notre intégration StatsD vous permet d'obtenir facilement des données au format StatsDdans New Relic. Vous pouvez également ajouter n'importe quelle balise arbitraire (paires valeur clé) à vos données. Une fois vos métriques dans New Relic, vous pouvez interroger vos données et créer des graphiques et des dashboards personnalisés.

Vous souhaitez tester notre intégration StatsD ? Créez un compte New Relic gratuitement ! Aucune carte de crédit requise.

Exigences

Cette intégration utilise notre API métrique et notre API événement pour ingérer des données. Pour utiliser ces API, vous aurez besoin d'un .

L'intégration respecte les exigences métriques de l'API et les limites de données. Pour voir si vous atteignez la limite de débit, exécutez la requête NRQL suivante de l' événementNrIntegrationError :

SELECT count(*) FROM NrIntegrationError 
WHERE newRelicFeature = 'Metrics' 
FACET category, message
LIMIT 100 SINCE 1 day ago

L'intégration est disponible sous forme d'image de conteneur Linux dans DockerHub pour les architectures amd64 et arm64.

Installation

Cette section explique comment effectuer une installation standard. Si vous souhaitez exécuter StatsD dans Kubernetes, consultez Installation de Kubernetes.

Pour installer l'intégration StatsD, exécutez la commande suivante et incluez votre ID de compte New Relic et . Cela génère un fichier de configuration TOML utilisé par gostatsd.

bash

$docker run \
>  -d --restart unless-stopped \
>  --name newrelic-statsd \
>  -h $(hostname) \
>  -e NR_ACCOUNT_ID=YOUR_ACCOUNT_ID \
>  -e NR_API_KEY=NEW_RELIC_LICENSE_KEY \
>  -p 8125:8125/udp \
>  newrelic/nri-statsd:latest

Si votre organisation se trouve dans la région data center de l'UE, ajoutez ceci à la commande ci-dessus :

bash

$-e NR_EU_REGION=true \

Après l'installation, vous pouvez :

Effectuer une configuration supplémentairefacultative
Définissez vos métriques
Ajoutez une balise personnalisée à vos données
Créer des alertes

Installation pour Kubernetes

Voici quelques exemples de manifestes Kubernetes pour les objets de déploiement et de service :

Vous trouverez ci-dessous des exemples de manifestes Kubernetes pour déployer StatsD dans un environnement Kubernetes et créer un service StatsD nommé newrelic-statsd. Vous devez insérer votre identifiant de compte et votre .

deployment.yml:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: newrelic-statsd
  namespace: tooling
  labels:
    app: newrelic-statsd
spec:
  selector:
    matchLabels:
      app: newrelic-statsd
  replicas: 2
  revisionHistoryLimit: 2
  template:
    metadata:
      labels:
        app: newrelic-statsd
    spec:
      serviceAccountName: newrelic-statsd
      containers:
        - name: newrelic-statsd
          image: newrelic/nri-statsd:latest
          env:
            - name: NR_ACCOUNT_ID
              value: "NEW_RELIC_ACCOUNT_ID"
            - name: NR_API_KEY
              value: "NEW_RELIC_LICENSE_KEY"

service.yml:

apiVersion: v1
kind: Service
metadata:
  name: newrelic-statsd
  namespace: tooling
  labels:
    app: newrelic-statsd
spec:
  type: ClusterIP
  ports:
    - name: newrelic-statsd
      port: 80
      targetPort: 8125
      protocol: UDP
  selector:
    app: newrelic-statsd

service-account.yml:

apiVersion: v1
kind: ServiceAccount
metadata:
  name: newrelic-statsd
  namespace: default

Pour configuration plus de détails sur , consultez Kubernetes configuration.

Ce document vous a-t-il aidé lors de votre installation ?

Configure

Dans la procédure d'installation, vous exécutez nri-statsd avec des variables d'environnement, ce qui génère un fichier de configuration TOML. De plus, vous pouvez définir ces options de configuration :

Options de configuration	Description
`expiry-interval` chaîne	Si une métrique n'est pas mise à jour pendant cette période, nous cessons de signaler cette métrique. La valeur par défaut est `5m`. Si vous souhaitez envoyer les métriques uniquement si la valeur a été mise à jour entre les intervalles de vidage, configurez cette valeur sur `1ms`. Pour ne jamais faire expirer les métriques, définissez-la sur `0`.
`percent-threshold` liste d'entiers	Spécifie le centile utilisé pour l'agrégation des métriques. Par défaut : `90`.
`metrics-addr` chaîne	Indique l'adresse sur laquelle écouter les métriques. Par défaut : `:8125`. Depuis nri-statsd `v2.3.0` (goStatsD `v34.2.1`), la connexion via Unix domaine Socket (UDS) est prise en charge. Utilisez `metrics-addr=/some/path/newrelic-statsd.socket` au lieu de `[host]:port` dans la configuration.

Options de configuration

Description

expiry-interval

chaîne

Si une métrique n'est pas mise à jour pendant cette période, nous cessons de signaler cette métrique. La valeur par défaut est 5m.

Si vous souhaitez envoyer les métriques uniquement si la valeur a été mise à jour entre les intervalles de vidage, configurez cette valeur sur 1ms. Pour ne jamais faire expirer les métriques, définissez-la sur 0.

percent-threshold

liste d'entiers

Spécifie le centile utilisé pour l'agrégation des métriques. Par défaut : 90.

metrics-addr

chaîne

Indique l'adresse sur laquelle écouter les métriques. Par défaut : :8125. Depuis nri-statsd v2.3.0 (goStatsD v34.2.1), la connexion via Unix domaine Socket (UDS) est prise en charge. Utilisez metrics-addr=/some/path/newrelic-statsd.socket au lieu de [host]:port dans la configuration.

Conseil

Pour garantir la conformité FedRAMP lors de l'utilisation de l'intégration StatsD, vous devez définir le point de terminaison suivant dans la configuration personnalisée :

address = 'https://gov-insights-collector.newrelic.com/v1/accounts/$NR_ACCOUNT_ID/events'

address-metrics = 'https://gov-infra-api.newrelic.com/metric/v1'

Voici quelques exemples de personnalisation de la configuration en écrasant la configuration par défaut :

# Specify after how long do we expire metrics, default:5m
expiry-interval = '1ms'

# percent-threshold specify a list of percentiles for metrics aggregation, default:90
percent-threshold = [90, 99]

backends='newrelic'
[newrelic]
# flush types supported: metrics,  insights, infra
flush-type = 'metrics'
transport = 'default'
address = 'https://insights-collector.newrelic.com/v1/accounts/$NR_ACCOUNT_ID/events'
address-metrics = 'https://metric-api.newrelic.com/metric/v1'
api-key = 'NEW_RELIC_LICENSE_KEY'

Disable timer sub-metrics:

Par défaut, nri_statsd calcule les éléments suivants pour les métriques du minuteur : écart type, moyenne, médiane, somme, limites inférieure et supérieure pour l'intervalle de vidage. Si vous souhaitez désactiver ces métriques, vous pouvez le faire en ajoutant une section de configuration disabled-sub-metrics et en définissant true pour celles que vous souhaitez désactiver. Voici un exemple :

# disabled-sub-metrics configuration section allows disabling timer sub-metrics
[disabled-sub-metrics]
# Regular metrics
count=false
count-per-second=false
mean=false
median=false
lower=false
upper=false
stddev=false
sum=false
sum-squares=false

# Percentile metrics
count-pct=false
mean-pct=false
sum-pct=false
sum-squares-pct=false
lower-pct=false
upper-pct=false

Pour écraser la configuration nri-statsd par défaut lors de l'exécution dans un conteneur, vous pouvez monter un fichier de configuration à l'intérieur du conteneur.

Vous pouvez adopter le modèle suivant selon vos besoins en fonction de votre situation.

Exemple:

backends='newrelic'
flush-interval='10s'

[newrelic]
# flush types supported: metrics,  insights, infra
flush-type = 'metrics'
transport = 'default'
address-metrics = 'https://metric-api.newrelic.com/metric/v1'
api-key = 'NEW_RELIC_LICENSE_KEY'

Pour exécuter le conteneur avec le fichier monté dans le chemin approprié :

bash

$docker run \
>  ...
>  -v ${PWD}/nri-statsd.toml:/etc/opt/newrelic/nri-statsd.toml \
>  ...
$  newrelic/nri-statsd:latest

La meilleure approche pour configurer nri-statsd exécuté dans Kubernetes est d'utiliser un configMap et de monter le configMap dans le conteneur. (Il s’agit d’un processus similaire au montage du fichier de configuration dans Docker.)

Exemple:

apiVersion: v1
kind: ConfigMap
metadata:
  name: nri-statsd-config
  namespace: default
data:
  nri-statsd.toml: |
    backends='newrelic'
    flush-interval='10s'

    [newrelic]
    # flush types supported: metrics,  insights, infra
    flush-type = 'metrics'
    transport = 'default'
    address = 'https://metric-api.newrelic.com/metric/v1'
    api-key = '$NEW_RELIC_LICENSE_KEY'

Pour utiliser configMap, déclarez un volume sur votre modèle de spécification de déploiement, puis déclarez un volumeMount sur votre spécification de conteneur.

Exemple:

apiVersion: apps/v1
kind: Deployment
spec:
  template:
    spec:
    containers:
      # ....
      volumeMounts:
        - mountPath: /etc/opt/newrelic/
          name: nri-statsd-config
    volumes:
      - name: nri-statsd-config
        configMap:
          name: nri-statsd-config

Format métrique

L'intégration reçoit des métriques à l'aide du protocole StatsD. En option, le taux d'échantillonnage peut être configuré et une balise peut être ajoutée.

Voici le format de données métriques que nous utilisons :

<metric name>:<value>|<type>|@<sample rate>|#<tags>

Voici les explications de ces champs :

Nom du champ	Description
`<metric name>` chaîne	Required. Nom de la métrique.
`<value>` chaîne	Required. Le type métrique: `c` = compteur `g` = jauge `ms` = minuterie
`@<sample rate>` virgule flottante	Optional pour les compteurs simples ou les compteurs temporisés. Lorsque de nombreuses métriques doivent être envoyées, vous pouvez utiliser l'échantillonnage pour réduire le trafic réseau. L’inconvénient est une réduction de la résolution des données. Un exemple de la manière dont cela fonctionnerait pour des fréquences d'échantillonnage inférieures à `1`: si vous définissez cette valeur sur `0.1`, le compteur enverra une mesure une fois sur 10.
`#<tags>` chaîne	Optional. Les balises attachées à vos métriques sont converties en attribut (paires valeur clé). Pour en savoir plus sur les options de balises, voir balise.

Nom du champ

Description

<metric name>

chaîne

Required. Nom de la métrique.

<value>

chaîne

Required. Le type métrique:

c = compteur
g = jauge
ms = minuterie

@<sample rate>

virgule flottante

Optional pour les compteurs simples ou les compteurs temporisés. Lorsque de nombreuses métriques doivent être envoyées, vous pouvez utiliser l'échantillonnage pour réduire le trafic réseau. L’inconvénient est une réduction de la résolution des données.

Un exemple de la manière dont cela fonctionnerait pour des fréquences d'échantillonnage inférieures à 1: si vous définissez cette valeur sur 0.1, le compteur enverra une mesure une fois sur 10.

#<tags>

chaîne

Optional. Les balises attachées à vos métriques sont converties en attribut (paires valeur clé). Pour en savoir plus sur les options de balises, voir balise.

types métriques

Voici les types de métriques et comment les formater :

Un compteur mesure le nombre d'occurrences d'un événement. Les exemples incluent le taux d'accès au cache par intervalle de rapport et le nombre de threads créés par intervalle de rapport.

Un compteur peut être incrémenté ou décrémenté pendant le même intervalle de vidage en ajoutant un signe à la valeur. Dans l'exemple suivant, la valeur du compteur sera 2:

counter:4|c
counter:-2|c

À chaque rinçage, le compte actuel est envoyé et réinitialisé à 0. Si le compte n'est pas mis à jour, lors du prochain vidage, il enverra la valeur 0. Vous pouvez choisir de désactiver ce comportement en définissant expiry-interval sur 1ms.

Voici un exemple d'un compteur qui est échantillonné 1 fois sur 10 :

counter:4|c@0.1

Une jauge représente une valeur qui peut augmenter ou diminuer avec le temps. Les exemples de jauges incluent la température, l'utilisation du processeur et la mémoire. Voici un exemple :

temperature:40|g

Si la jauge n'est pas mise à jour, lors du prochain rinçage, elle enverra la valeur précédente. Vous pouvez choisir de désactiver ce comportement en définissant expiry-interval sur 1ms.

Le type de métrique du minuteur mesure les données de synchronisation.

<metric_base_name>.std_dev 
<metric_base_name>.median
<metric_base_name>.summary
<metric_base_name>.sum_squares
<metric_base_name>.mean
<metric_base_name>.per_second

Le centile configuré générera les métriques suivantes. La valeur du seuil percentile sera jointe sous forme de tag.

<metric_base_name>.sum_squares.percentiles
<metric_base_name>.sum.percentiles
<metric_base_name>.count.percentiles
<metric_base_name>.upper.percentiles
<metric_base_name>.mean.percentiles

Le seuil percentile peut être modifié avec l'option de configuration percent-threshold . Ceux-ci peuvent être contrôlés via la section de configurationdisabled-sub-metrics .

Ajouter une balise (attributs)

Vous pouvez ajouter des balises à vos données, que nous enregistrons comme attributs (paires de valeur clé). Il existe deux options pour ajouter une balise :

Ajouter une balise par défaut qui s’applique à toutes les métriques : Celles-ci s’appliquent à toutes les métriques. Ils sont fixes et ne changent pas avec le temps.
Ajouter une balise de niveau métrique : elle s'applique à des métriques spécifiques et permet de modifier la valeur entre deux soumissions.

Ajoutez une balise aux métriques et à l'événement en définissant une variable d'environnement dans la commande de démarrage.

Voici un exemple qui créerait deux balises :

bash

$-e TAGS="environment:production region:us"

Voici la variable d'environnement utilisée dans la commande de démarrage:

bash

$docker run \
>  -d --restart unless-stopped \
>  --name newrelic-statsd \
>  -h $(hostname) \
>  -e NR_ACCOUNT_ID=YOUR_ACCOUNT_ID \
>  -e NR_API_KEY=NEW_RELIC_LICENSE_KEY \
>  -e TAGS="environment:production region:us" \ 
>  -p 8125:8125/udp \
>  newrelic/nri-statsd:latest

Lors de la définition du format métrique, vous pouvez ajouter une balise utilisant ce format :

<bucket name>:<value>|<type>|#<tags>

Dans cet exemple, <tags> est une liste de balises séparées par des virgules. le format de la balise est : simple ou key:value.

Voici un exemple de requête NRQL qui inclut une tag personnalisée :

SELECT count(*) FROM Metric WHERE environment = 'production'

Créer des alertes

Vous pouvez alerter sur les données StatsD en utilisant la condition d'alerte NRQL .

Cette procédure vous guide dans l’envoi d’exemples de données, puis dans la création d’une condition d’alerte à l’aide de ces données.

Tout d’abord, envoyez ces données au conteneur StatsD de New Relic :

bash

$echo "prod.test.num:32|g" | nc -v -w 1 -u localhost 8125

Ensuite, créez une condition d’alerte NRQL à l’aide de cette requête :

SELECT latest(prod.test.num) FROM Metric WHERE metricName = 'prod.test.num'

Voici une image montrant la création de cette condition d’alerte NRQL. Notez que les exemples de données envoyés sont représentés par le point bleu en haut à droite du graphique.

Nous pouvons maintenant créer la condition d’alerte avec ces paramètres :

StatsD NRQL alert condition creation example

Lorsque vous créez la condition d’alerte NRQL, assurez-vous de définir Condition name.

Si une métrique avec une valeur supérieure à 50 est envoyée, un incident est créé et notifié. L'incident est fermé automatiquement après 24 heures. Pour tester que l'alerte fonctionne, exécutez cette commande :

bash

$echo "prod.test.num:60|g" | nc -v -w 1 -u localhost 8125

Rechercher et utiliser des données

Pour interroger vos données, vous utiliserez n'importe quelle option de requête New Relic. Par exemple, vous pouvez exécuter une requête NRQL comme :

SELECT count(*) FROM Metric WHERE metricName = 'myMetric' and environment = 'production'

Pour en savoir plus sur la requête du type de données Metric , consultez requête métrique data.

Dépannage

Problème:

Vous avez suivi les étapes pour exécuter l'intégration StatsD, mais vous devez toujours voir les métriques attendues dans New Relic.

Solutions:

Suivez les étapes ci-dessous pour résoudre votre problème de configuration :

Assurez-vous que contient votre clé de licence à 40 caractères hexadécimaux et qu'il s'agit d'une licence valide pour l'ID de compte New Relic sélectionné.
Assurez-vous que le bon data center, États-Unis ou UE, a été sélectionné pour votre compte New Relic. Astuce : si la clé de licence commence par « eu », vous devez utiliser l'indicateur NR_EU_REGION=true .
Assurez-vous qu'il n'y a pas de NrIntegrationError lié à l'intégration StatsD.
Le log détaillé peut être activé à l'aide de la variable d'environnement NR_STATSD_VERBOSE, modifiez la commande docker run en ajoutant la variable suivante : -e NR_STATSD_VERBOSE=true.
Une métrique de test peut être envoyée pour confirmer que l'intégration envoie les métriques attendues. Exemple utilisant l'utilitaire NetCat nc :
- echo "example.gauge:123|g" | nc -u -w0 127.0.0.1 8125 (mise à jour 127.0.0.1 avec l'adresse IP/l'adresse du conteneur en cours d'exécution).

Vérifiez le code source

Cette intégration est un logiciel open source. Cela signifie que vous pouvez parcourir son code source et envoyer des améliorations, ou créer votre propre fork et le construire.

Cette traduction automatique est fournie pour votre commodité.

Exigences

Installation

Installation pour Kubernetes

Exemples de manifeste Kubernetes

Diagramme Helm de Kubernetes

Ce document vous a-t-il aidé lors de votre installation ?

Configure

Conseil

Exemple de configuration personnalisée

Docker : écraser la configuration par défaut

Kubernetes : écraser la configuration par défaut

Format métrique

types métriques

Comptoir

Jauge

Minuteur

Ajouter une balise (attributs)

Ajouter une balise par défaut qui s'applique à toutes les métriques

Ajouter une balise de niveau métrique

Créer des alertes

Exemple d'alerte

Rechercher et utiliser des données

Dépannage

Vérifiez le code source

Cette traduction automatique est fournie pour votre commodité.

Intégration monitoring StatsD

Exigences.css-21sua1{background:none;border:none;width:0;padding:0;}

Installation

Installation pour Kubernetes

Diagramme Helm de Kubernetes

Ce document vous a-t-il aidé lors de votre installation ?

Configure

Conseil

Exemple de configuration personnalisée

Docker : écraser la configuration par défaut

Kubernetes : écraser la configuration par défaut

Format métrique

types métriques

Comptoir

Jauge

Minuteur

Ajouter une balise (attributs)

Ajouter une balise par défaut qui s'applique à toutes les métriques

Ajouter une balise de niveau métrique

Créer des alertes

Exemple d'alerte

Rechercher et utiliser des données

Dépannage

Vérifiez le code source

Exigences