Point de terminaison public - Métriques JSON

Ce point de terminaison d’API est fourni pour ajouter des métriques supplémentaires à AppSignal, lorsqu’une intégration existante ne peut pas être utilisée ou que le langage utilisé n’est pas (encore) pris en charge. Ce point de terminaison est destiné aux intégrations qui envoient des métriques agrégées sur une courte période. Il est préférable d’envoyer une requête toutes les 5 secondes contenant 100 métriques plutôt que 100 requêtes toutes les 5 minutes avec une métrique chacune.

Point de terminaison

Méthode de requête : POST

Point de terminaison	Description
https://appsignal-endpoint.net/metrics/json	Accepte les données formatées JSON

Paramètres d’URL

Paramètre	Type	Description
api_key	String	Clé d’API Front-end, peut être trouvée dans les paramètres de l’application.

Shell

https://appsignal-endpoint.net/metrics/json?api_key=<api_key>

Paramètres du corps

Le corps de la requête POST doit contenir des métriques formatées JSON séparées par un saut de ligne, ou un corps JSON complet.

Paramètre	Type	Description
name	String	Nom de la métrique, ne doit pas contenir d’espaces ni de caractères spéciaux, par exemple uniquement (`[a-zA-Z0-9-_]`)
metricType	String	Type de métrique, peut être l’un de `[gauge, counter, timing, histogram]`
value	Float	Valeur (Float)
tags	`Object<String, String>`	Objet contenant les tags. La clé et la valeur doivent être des chaînes, par exemple : `{ "hostname": "frontend1" }`

Exemple de corps JSON

[
  {
    "name": "traffic_gauge",
    "metricType": "gauge",
    "value": 19.8,
    "tags": { "hostname": "frontend1" }
  },
  {
    "name": "error_counter",
    "metricType": "counter",
    "value": 10,
    "tags": { "hostname": "frontend1", "disk": "vda" }
  },
  {
    "name": "duration_timing",
    "metricType": "timing",
    "value": 19,
    "tags": { "lambda": "login" }
  },
  {
    "name": "duration_timing",
    "metricType": "histogram",
    "value": 5,
    "tags": { "lambda": "login" }
  }
]

Exemple de corps séparé par des sauts de ligne :

JSON

{"name": "traffic_gauge", "metricType": "gauge", "value": 19.8, "tags": {"hostname": "frontend1"}}\n
{"name": "error_counter", "metricType": "counter", "value": 10, "tags": {"hostname": "frontend1", "disk": "vda"}}\n
{"name": "duration_timing", "metricType": "timing", "value": 19, "tags": {"lambda": "login"}}\n
{"name": "duration_timing", "metricType": "histogram", "value": 5, "tags": {"lambda": "login"}}\n

Note : Cet endpoint est optimisé pour de grands volumes de trafic et ne valide pas la clé API ni la charge utile. Une réponse 200 (OK) est renvoyée lorsque la taille du corps est dans la limite de 200k. Cela ne signifie pas que la requête est acceptée lors de sa réception.