dashboards listent, créent et mettent à jour les tableaux de bord d’une application, et affichent, ajoutent et mettent à jour les graphiques qui s’y trouvent.
Chaque commande cible une application, par nom et environnement (--app "MyApp" --environment production) ou par ID (--app-id <APP_ID>, le long ID hexadécimal de l’application provenant de appsignal-cli apps list). L’option --environment n’est nécessaire que lorsque plusieurs applications partagent un nom. Chaque commande utilise votre organisation par défaut sauf si vous passez --org. Voir Applications et organisations pour savoir comment les applications sont identifiées.
Lister les tableaux de bord
Shell
Afficher un tableau de bord
Pour voir les détails d’un tableau de bord et ses graphiques, passez le--id du tableau de bord :
Shell
--output json, les graphiques se trouvent dans dashboard.visuals, chacun avec son id, son type dans __typename et ses paramètres. add-visual et update-visual renvoient la même structure.
Créer un tableau de bord
Un nouveau tableau de bord a besoin d’un titre et d’une description :Shell
Mettre à jour un tableau de bord
Passez le--id du tableau de bord (depuis dashboards list) avec le nouveau titre :
Shell
--title est requis même lorsque vous ne modifiez que la description.
Ajouter un graphique
Vous décrivez un graphique dans un fichier JSON, puis l’ajoutez avecadd-visual. Supposons que vous gériez une boutique en ligne. Votre tableau de bord Checkout health doit répondre à deux questions : le checkout est-il lent, et échoue-t-il ?
Pour voir à quel point le checkout est lent pour vos clients les plus lents, représentez son temps de réponse au 95e percentile dans le temps. C’est un graphique timeseries. Enregistrez-le sous checkout-speed.json :
checkout-speed.json
Shell
number, qui prend une seule metric. Le nom de la métrique et ses tags ne peuvent pas contenir de caractère générique (*), car le graphique affiche une seule série. Enregistrez-le sous checkout-errors.json :
checkout-errors.json
Shell
CheckoutsController#create par l’action qui gère le checkout dans votre application. Chaque nouveau graphique a besoin d’un title et d’une description non vides. Pour lire le JSON depuis l’entrée standard plutôt que depuis un fichier, passez --file -.
La CLI ne retente pas la création d’un graphique en cas d’échec. Si
add-visual échoue avec une erreur réseau, vérifiez le tableau de bord avec dashboards show avant de réessayer. Vous évitez ainsi d’ajouter le graphique deux fois.Mettre à jour un graphique
Pour modifier un graphique, passez uniquement les paramètres que vous voulez changer. Tout le reste reste inchangé. Par exemple, pour afficher le temps de réponse du checkout sous forme de graphique en aire, récupérez l’ID du graphique depuisdashboards show et exécutez :
Shell
update-visual prend les mêmes options d’application que add-visual, plus :
Certains paramètres demandent plus d’attention :
- Les listes et objets sont remplacés intégralement. Pour représenter aussi l’étape de paiement, passez
metricsavec à la fois la métrique du checkout et la nouvelle. Pour déplacer un graphique, passez les quatre valeurs delayout. - Pour effacer un paramètre, définissez-le sur
null. Cela fonctionne pourdescription,formatInput,layout,lineLabel,minYAxis, et lemetricd’un graphiquenumber.formatne peut pas être effacé ; définissez-le plutôt sur un autre format. - Pour supprimer toutes les métriques d’un graphique
timeseries, passez"metrics": []. - Changer
formatpour une valeur autre quesizeefface aussiformatInput.
timeseries en graphique number. Une mise à jour sans paramètres est rejetée.
Paramètres du graphique
Le JSON du graphique utilise des clés en camelCase et ne contient que des paramètres. L’ID du tableau de bord, l’ID du graphique et le type de graphique sont indiqués dans les options de la commande. Les clés inconnues, les valeurs invalides et les paramètres destinés à l’autre type de graphique renvoient une erreur.
Ces paramètres acceptent un ensemble fixe de valeurs :