Créer une métrique custom

Il est possible d'ajouter des données custom dans les métriques Okapi.

Ces données custom peuvent être alimentée soit via des entêtes de requêtes provenant du client qui consomme l'API, soit via des entêtes de réponses qui proviennent de l'API elle-même.

Exemple d'entête de requête custom : X-Contact-Id: moncontactid

Dans la configuration du raccordement de l'API, il faut déclarer l'entête :

extra:
  kpiheaders:
    'x-contact-id': contactId

• En clé : spécifier le nom de l'entête à interpréter
• En valeur : spécifier le nom de l'attribut à ajouter dans les KPI.

Remarque : un nom d'entête est toujours insensible à la casse, mais par convention le format capitalize est souvent utilisé. Pour des raisons pratiques, dans la configuration du raccordement de l'API, déclarer les attributs custom en utilisant systématiquement les minuscules.

Avec cette configuration, un champs contactId sera injecté dans les métriques Okapi indexées par Elasticsearch, avec comme valeur celle de l'entête de requête (soit, dans l'exemple, moncontactid).

En résumé :

• Le pré-requis est d'avoir correctement configuré l'API pour supporter l'entête custom
• ajouter l'entête custom dans la requête qui consomme l'API
• la métrique custom est systématiquement alimentée avec le reste des événements pour chaque requête
• les données custom sont consultables dans les mêmes conditions que le reste des KPI