Cette section spécifie le format brut des datagrammes pour les métriques, événements et checks de service acceptés par DogStatsD. Vous pouvez l’ignorer si vous utilisez l’une des bibliothèques client pour DogStatsD. Toutefois, si vous souhaitez rédiger votre propre bibliothèque ou utiliser l’interface système pour envoyer des métriques, lisez attentivement cette section.
<NOM_MÉTRIQUE>:<VALEUR>|<TYPE>|@<TAUX_ÉCHANTILLONNAGE>|#<CLÉ_TAG_1>:<VALEUR_TAG_1>,<TAG_2>
| Paramètre | Obligatoire | Description |
|---|---|---|
<NOM_MÉTRIQUE> | Oui | Chaîne contenant uniquement des caractères alphanumériques ASCII, des underscores et des points. Consultez les règles de nommage des métriques. |
<VALEUR> | Oui | Nombre entier ou valeur flottante. |
<TYPE> | Oui | c pour COUNT, g pour GAUGE, ms pour TIMER, h pour HISTOGRAM, s pour SET et d pour DISTRIBUTION. Consultez la documentation relative aux types de métriques. |
<TAUX_ÉCHANTILLONNAGE> | Non | Valeur flottante entre 0 et 1 (inclusif). Elle ne fonctionne qu’avec des métriques COUNT, HISTOGRAM et TIMER. Valeur par défaut : 1 (entraîne un échantillonnage 100 % du temps). |
<CLÉ_TAG_1>:<VALEUR_TAG_1>,<TAG_2> | Non | Une liste de chaînes séparées par des virgules. Utilisez deux-points « : » pour les tags clé/valeur, par exemple (env:prod). Consultez la documentation relative au tagging pour découvrir comment définir des tags. |
Voici quelques exemples de datagrammes :
page.views:1|c : incrémente la métrique COUNT page.views.fuel.level:0.5|g : indique que le réservoir est à moitié vide.song.length:240|h|@0.5 : échantillonne l’histogramme song.length une fois sur deux.users.uniques:1234|s : surveille les visiteurs uniques du site.users.online:1|c|#country:china : incrémente la métrique COUNT correspondant au nombre d’utilisateurs actifs et ajoute un tag avec le pays d’origine.users.online:1|c|@0.5|#country:china : surveille les utilisateurs chinois actifs et utilisez un taux d’échantillonnage._e{<TITRE>.length,<TEXTE>.length}:<TITRE>|<TEXTE>|d:<TIMESTAMP>|h:<HOSTNAME>|p:<PRIORITÉ>|t:<TYPE_ALERTE>|#<CLÉ_TAG_1>:<VALEUR_TAG_1>,<TAG_2>
| Paramètre | Obligatoire | Description |
|---|---|---|
_e | Oui | Le datagramme doit commencer par _e. |
<TITRE> | Oui | Titre de l’événement. |
<TEXTE> | Oui | Texte de l’événement. Ajoutez des sauts de ligne avec \\n. |
d:<TIMESTAMP> | Non | Ajoute un timestamp à l’événement. Valeur par défaut ; timestamp epoch Unix actuel. |
h:<HOSTNAME> | Non | Ajoute un hostname à l’événement. Pas de valeur par défaut. |
k:<CLÉ_AGGRÉGATION> | Non | Ajoute une clé d’agrégation afin de regrouper les événements qui possèdent la même clé. Pas de valeur par défaut. |
p:<PRIORITÉ> | Non | Défini sur normal ou low. Valeur par défaut : normal. |
s:<NOM_TYPE_SOURCE> | Non | Ajoute un type de source à l’événement. Pas de valeur par défaut. |
t:<TYPE_ALERTE> | Non | Défini sur error, warning, info ou success. Valeur par défaut : info. |
#<CLÉ_TAG_1>:<VALEUR_TAG_1>,<TAG_2> | Non | La virgule dans les tags fait partie de la chaîne de liste de tags et ne sert pas au parsing comme pour les autres paramètres. Pas de valeur par défaut. |
Voici quelques exemples de datagrammes :
## Envoyer une exception
_e{21,36}:An exception occurred|Cannot parse CSV file from 10.0.0.17|t:warning|#err_type:bad_file
## Envoyer un événement avec un saut de ligne dans le texte
_e{21,42}:An exception occurred|Cannot parse JSON request:\\n{"foo: "bar"}|p:low|#err_type:bad_request
_sc|<NOM>|<STATUT>|d:<TIMESTAMP>|h:<HOSTNAME>|#<CLÉ_TAG_1>:<VALEUR_TAG_1>,<TAG_2>|m:<MESSAGE_CHECK_SERVICE>
| Paramètre | Obligatoire | Description |
|---|---|---|
_sc | Oui | Le datagramme doit commencer par _sc. |
<NOM> | Oui | Nom du check de service. |
<STATUT> | Oui | Nombre entier correspondant à l’état du check (OK = 0, WARNING = 1, CRITICAL = 2, UNKNOWN = 3`). | |
d:<TIMESTAMP> | Non | Ajoute un timestamp au check. Valeur par défaut : timestamp epoch Unix actuel. |
h:<HOSTNAME> | Non | Ajoute un hostname à l’événement (pas de valeur par défaut). |
#<CLÉ_TAG_1>:<VALEUR_TAG_1>,<TAG_2> | Non | Définit les tags de l’événement. Liste de chaînes séparées par des virgules (pas de valeur par défaut). |
m:<MESSAGE_CHECK_SERVICE> | Non | Message décrivant l’état actuel du check de service. Ce champ DOIT être placé en dernier parmi les champs des métadonnées (pas de valeur par défaut). |
Voici un exemple de datagramme :
# Envoyer un statut CRITICAL pour une connexion à distance
_sc|Redis connection|2|#env:dev|m:La connexion à Redis a expiré après 10 s
Pour Linux et d’autres systèmes d’exploitation comme Unix, utilisez Bash. Pour Windows, utilisez Powershell et Powershell-statsd (une fonction Powershell simple qui gère des bits réseau).
DogStatsD crée un message qui contient des informations à propos de votre métrique, événement ou check de service et l’envoie à un Agent installé en local sous la forme d’un collecteur. L’adresse IP de destination est 127.0.0.1, et le port du collecteur via UDP est 8125. Consultez la documentation principale sur DogStatsD pour découvrir comment configurer l’Agent.
Voici le format d’envoi de métriques :
<NOM_MÉTRIQUE>:<VALEUR>|<TYPE>|@<TAUX_ÉCHANTILLONNAGE>|#<CLÉ_TAG_1>:<VALEUR_TAG_1>,<TAG_2>
Les exemples ci-dessous envoient des points de données pour une métrique gauge custom_metric avec le tag shell.
Sur Linux :
echo -n "custom_metric:60|g|#shell" >/dev/udp/localhost/8125
echo -n "custom_metric:60|g|#shell" | nc -4u -w0 127.0.0.1 8125
echo -n "custom.metric.name:1|c"|nc -4u -w1 localhost 8125
Sur Windows :
PS C:\> .\send-statsd.ps1 "custom_metric:123|g|#shell"
Depuis n’importe quelle plateforme avec Python (sur Windows, vous pouvez utiliser l’interpréteur Python intégré à l’Agent ; il se trouve à l’emplacement %PROGRAMFILES%\Datadog\Datadog Agent\embedded\python.exe pour les versions 6.11 ou antérieures de l’Agent et à l’emplacement %PROGRAMFILES%\Datadog\Datadog Agent\embedded<PYTHON_MAJOR_VERSION>\python.exe pour les versions ultérieures) :
import socket
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) # UDP
sock.sendto("custom_metric:60|g|#shell", ("localhost", 8125))
import socket
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) # UDP
sock.sendto(b"custom_metric:60|g|#shell", ("localhost", 8125))
Voici le format d’envoi d’événements :
_e{<TITRE>.length,<TEXTE>.length}:<TITRE>|<TEXTE>|d:<ÉVÉNEMENT_DATE>|h:<HOSTNAME>|p:<PRIORITÉ>|t:<TYPE_ALERTE>|#<CLÉ_TAG_1>:<VALEUR_TAG_1>,<TAG_2>.
Les exemples ci-dessous calculent la taille du titre et du corps de l’événement.
Sur Linux :
$ title="Événement depuis le shell"
$ text="Cet événement a été envoyé depuis Bash !"
$ echo "_e{${#title},${#text}}:$title|$text|#shell,bash" >/dev/udp/localhost/8125
Sur Windows :
PS C:> $title = "Événement depuis le shell"
PS C:> $text = "Cet événement a été envoyé depuis PowerShell !"
PS C:> .\send-statsd.ps1 "_e{$($title.length),$($text.Length)}:$title|$text|#shell,PowerShell"
Voici le format d’envoi des checks de service :
_sc|<NOM>|<STATUT>|d:<TIMESTAMP>|h:<HOSTNAME>|#<CLÉ_TAG_1>:<VALEUR_TAG_1>|m:<MESSAGE_CHECK_SERVICE>
Sur Linux :
echo -n "_sc|Connexion Redis|2|#env:dev|m:La connexion Redis a expiré après 10 s" >/dev/udp/localhost/8125
Sur Windows :
PS C:\> .\send-statsd.ps1 "_sc|Redis connection|2|#env:dev|m:La connexion à Redis a expiré après 10 s"
Pour envoyer des métriques, des événements ou des checks de service sur des environnements conteneurisés, consultez l’article relatif à l’utilisation de DogStatsD sur Kubernetes, conjointement avec les instructions de configuration de l’APM sur Kubernetes, en fonction de votre installation. La documentation sur l'APM Docker peut également vous venir en aide.
Documentation, liens et articles supplémentaires utiles:
