Passer au contenu principal
Recherchez des lignes de journal avec l’API publique (V2). C’est la manière d’interroger les journaux de manière programmatique, y compris les données de journal structurées (JSON). L’API GraphQL n’expose pas les lignes de journal.
Si vous créez un agent ou un assistant IA, AppSignal MCP expose directement la recherche de journaux et d’autres données de surveillance aux agents, sans avoir besoin d’appeler cette API vous-même.

Trouver vos IDs de site et de source

Une recherche de journaux nécessite un site_id et un ou plusieurs source_ids. Les deux apparaissent dans l’URL d’une source de journal dans AppSignal. Ouvrez une source de journal et lisez-les à partir du chemin :

Rechercher des lignes de journal

Pour chaque champ de la requête et de la réponse, consultez la référence Rechercher des lignes de journal. La requête prend un site_id, les source_ids à rechercher, une query et un objet pagination. Incluez au moins un ID de source : une liste source_ids vide ne renvoie aucune ligne. Une query vide correspond à toutes les lignes. Voir langage de requête. Par défaut, from correspond au début de votre rétention des journaux, et to à l’heure actuelle. pagination prend per_page (nombre), order (ASC ou DESC), et un cursor avec un time et un id. Définissez les deux sur null pour la première page. Pour récupérer la page suivante, envoyez le timestamp et l’id de la dernière ligne reçue comme cursor.time et cursor.id. Sans l’id, les lignes qui partagent cet horodatage sont ignorées.

Exemple de requête

Le point de terminaison renvoie un tableau de lignes de journal. Les données structurées de chaque ligne se trouvent dans son champ json, sous forme de chaîne encodée en JSON. Pour plutôt compter des lignes ou calculer la moyenne d’un champ, interrogez les métriques de journal.
Les champs structurés tels que status_code, path ou detail se trouvent dans le champ json. Interrogez-les par leur clé exacte telle qu’elle apparaît dans le JSON de votre journal (par exemple, status_code=401 ou detail.message:"required").

Langage de requête

La chaîne query prend en charge la logique booléenne sur les champs des lignes de journal et le corps structuré json.

Opérateurs

Les opérateurs de chaîne (=, !=, :, !:) comparent les deux côtés comme des chaînes. Les opérateurs numériques (>, >=, <, <=) convertissent les deux côtés en nombres ; si une valeur ne peut pas être analysée comme un nombre, cette ligne de journal est ignorée.

Combiner des expressions

  • AND / OR : severity=error AND hostname:web, ou severity=info OR severity=warn.
  • AND implicite : un espace entre les expressions signifie AND. severity=error hostname:web est identique à severity=error AND hostname:web.
  • Imbrication avec des parenthèses : message:"API request" AND (severity=info OR severity=warn).
  • Précédence : AND a une priorité plus élevée que OR.
Tout opérateur peut être utilisé à l’intérieur d’un groupe OR, pas uniquement l’égalité — par exemple, message:"API request" AND (user.id>1000 OR user.email:"example.com").

Champs

Étant donné une ligne de journal avec ce corps JSON :
  • Champs de base : message, severity, hostname et group correspondent aux champs de premier niveau de la ligne de journal.
  • JSON imbriqué : utilisez la notation par point pour accéder au corps json, comme status_code=200 ou user.id=12345.
  • Tableaux JSON : indexez les éléments du tableau, comme user.roles.0=admin.
  • Points échappés : pour faire correspondre un point littéral dans un nom de clé, échappez-le. user.location\.country=US correspond à la clé location.country à l’intérieur de user, plutôt qu’à un objet country imbriqué.
  • Champ par défaut : un terme isolé sans champ correspond à message avec l’opérateur contains. timeout équivaut à message:timeout.
Référencez un champ directement par son nom dans le JSON de votre journal, sans suffixe de type. Voir syntaxe de requête héritée si vous avez des requêtes plus anciennes.

Mise entre guillemets des valeurs

Encadrez les valeurs contenant des espaces ou des parenthèses avec des guillemets doubles. Sinon, l’espace divise la valeur en expressions distinctes jointes par un AND implicite.
Seuls les guillemets doubles sont reconnus. À l’intérieur d’une valeur entre guillemets, échappez un guillemet avec \" et une barre oblique inverse avec \\. Par exemple, message:"value with \"quotes\"" correspond au texte value with "quotes".

Syntaxe de requête héritée

Les requêtes plus anciennes stockaient les attributs comme des champs typés, elles devaient donc préfixer attributes., ajouter un suffixe de type (_string, _int) et utiliser une liste [ ] pour plusieurs valeurs. Le langage de requête actuel supprime ces trois éléments — référencez les champs directement et utilisez OR au lieu d’une liste :
L’API ne lit plus la syntaxe héritée, et ne la rejette plus non plus. attributes. est désormais un chemin ordinaire dans le JSON de votre journal. Ainsi, attributes.user_id_int=12345 recherche une clé user_id_int à l’intérieur d’un objet attributes. Un filtre dans l’ancienne forme attributes. ne correspond à rien, au lieu de renvoyer une erreur. Si vos journaux contiennent un objet attributes, vous pouvez filtrer sur ses champs, par exemple attributes.user_id=12345.