Adaptez votre système d'alertes : regroupez et partagez les alertes intelligentes d' Instana

Modifier en ligne

Les alertes intelligentes peuvent être regroupées pour permettre une observabilité évolutive et collaborative, à l'instar du regroupement des définitions d'événements et des tableaux de bord personnalisés. Cette approche transforme l'observabilité, qui relevait auparavant d'une initiative individuelle, en bonnes pratiques réutilisables à l'échelle de l'écosystème.

Les alertes intelligentes sont des alertes basées sur des indicateurs qui proposent automatiquement des seuils et offrent des fonctionnalités avancées, telles que les alertes de prévision, pour une surveillance proactive. Grâce à l'interface CLI d' Instana, qui permet de gérer les paquets d'intégration, vous pouvez définir, exporter et regrouper des définitions d'alertes intelligentes, tout comme vous le feriez pour les définitions d'événements et les tableaux de bord personnalisés.

L'intégration des Smart Alerts dans vos workflows d'intégration garantit la cohérence et la réutilisabilité d'un système d'alertes sophistiqué, basé sur des indicateurs, au sein de toutes les équipes et dans tous les environnements. Cette flexibilité permet aux organisations de créer des ressources d'observabilité modulaires et partageables, capables de s'adapter à l'évolution de leurs besoins.

Prérequis

Avant de commencer, assurez-vous que l'interface CLI d' Instana pour la gestion des paquets d'intégration (stanctl-integration) est installée. Pour obtenir les instructions d'installation, consultez la page stanctl-integration – Interface CLI d' Instana pour la gestion des paquets d'intégration.

Créer un package d'intégration (Producteur)

En tant que créateur de packages, vous devez définir des configurations d'alertes intelligentes pouvant être partagées et réutilisées entre les équipes et les environnements :

  1. Initialisez votre package d'intégration. Pour initialiser le package, exécutez stanctl-integration init et sélectionnez les types d'intégration que vous souhaitez inclure. La structure des répertoires est générée en fonction de votre sélection. Par exemple, si vous sélectionnez les alertes intelligentes et les tableaux de bord, la structure suivante est créée :
    packages
└── @instana-integration
   └── packagename
       ├── dashboards
       ├── smart-alerts
       ├── README.md
       └── package.json
    Pour plus de détails sur la configuration initiale, consultez la section « Rendre vos tableaux de bord d' Instana s accessibles au public ».
  2. Configurez votre alerte intelligente dans l' Instana Une fois la structure de votre package prête, créez vos définitions d'alertes intelligentes dans l'interface utilisateur d' Instana. Pour créer des alertes intelligentes adaptées à différents contextes, rendez-vous dans la section correspondante et cliquez sur l'onglet « Alertes intelligentes ». Par exemple :
    • Pour les alertes intelligentes d'infrastructure, accédez à l'onglet Infrastructure > Alertes intelligentes, puis cliquez sur Créer une alerte intelligente.
    • Pour les alertes intelligentes des applications mobiles, accédez à l'onglet « Sites Web et applications mobiles » > « Applications mobiles », cliquez sur le nom de votre application mobile, puis cliquez sur « Ajouter une alerte intelligente ».
    Pour plus d'informations sur la création d'alertes intelligentes dans l'interface utilisateur, consultez :
  3. Exportez vos définitions d'alertes intelligentes. Une fois vos définitions d'alertes intelligentes terminées, utilisez l'interface de ligne de commande (CLI) pour les exporter vers des fichiers réutilisables au format « JSON » :
    # Export Smart Alerts by name
$ stanctl-integration export \
  --server $INSTANA_SERVER \
  --token $API_TOKEN \
  --include type=smart-alert name="High CPU" \
  --location ./my-package# Export a Smart Alert by ID
$ stanctl-integration export \
  --server $INSTANA_SERVER \
  --token $API_TOKEN \
  --include type=smart-alert id=alert12345 \
  --location ./my-package# Export multiple Smart Alerts with different filters
$ stanctl-integration export \
  --server $INSTANA_SERVER \
  --token $API_TOKEN \
  --include type=smart-alert name="CPU" \
  --include type=smart-alert id=alert1234 \
  --location ./my-package
    L'interface de ligne de commande (CLI) interroge automatiquement les points de terminaison Smart Alert et enregistre chaque alerte dans un fichier. JSON. distinct, situé dans le dossier smart-alerts, prêt à être intégré à un package d'intégration.
  4. Vérifiez vos définitions Smart Alert. Avant de publier votre paquet, vous pouvez utiliser la lint commande pour valider vos définitions d'alertes intelligentes :
    # Navigate to the folder of the package you want to lint
$ stanctl-integration lint# Linting with a specific package path
$ stanctl-integration lint --path /path/to/package# Linting with debug mode enabled
$ stanctl-integration lint --debug
    La commande lint vérifie que chaque fichier d' JSON s Smart Alert contient les champs obligatoires (name, granularity, timeThreshold, et soit rule + threshold SOIT rules[]) et affiche des messages détaillés indiquant si l'opération a abouti ou a échoué pour chaque fichier.
  5. Publiez votre paquet. Une fois vos définitions d'alertes intelligentes prêtes, publiez le package afin de le mettre à la disposition des autres utilisateurs. Vous disposez de deux options :
    • Publier dans un registre auto-hébergé. Pour effectuer une publication dans un registre, exécutez la commande suivante en utilisant vos identifiants de registre :
      $ stanctl-integration publish --package @instana-integration/packagename \
  --registry-username <your_username> --registry-email <your_email>
      Si c'est la première fois que vous publiez, le système vous invite à vous authentifier auprès du registre.
    • Contribuez au dépôt hébergé sur IBM. Pour publier via le dépôt officiel hébergé sur IBM :
      • Faites un fork du dépôt « observability-as-code » sur GitHub.
      • Ajoutez votre package d'intégration.
      • Envoyez une pull request pour révision.
      Une fois approuvé et intégré, le paquet est publié dans le registre central hébergé sur IBM. Le paquet est désormais disponible pour l'ensemble de la communauté Instana.

Utiliser un package d'intégration (Consumer)

Si vous utilisez des paquets plutôt que de les créer, il vous suffit de télécharger le paquet et de l'installer dans votre environnement Instana.

  1. Téléchargez le package. Les paquets contenant des définitions Smart Alert peuvent être téléchargés depuis le registre central avant d'être importés dans votre environnement Instana.
    # Download a package from the central registry
$ stanctl-integration download --package @instana-integration/packagename
  2. Importez les définitions des alertes intelligentes. Une fois le téléchargement terminé, vous pouvez importer les définitions des alertes intelligentes dans votre environnement Instana.
    # Import all Smart Alerts from the package
$ stanctl-integration import \
  --package @instana-integration/packagename \
  --server $INSTANA_SERVER \
  --include "smart-alerts/**/*.json" \
  --token $API_TOKEN# Import a single Smart Alert from the package
$ stanctl-integration import \
  --package @instana-integration/packagename \
  --server $INSTANA_SERVER \
  --include "smart-alerts/**/smartAlertTitle.json" \
  --token $API_TOKEN
    Une fois l'importation terminée, les définitions des alertes intelligentes sont actives et prêtes à fournir des alertes intelligentes basées sur des indicateurs, avec des suggestions automatiques de seuils et des fonctionnalités de prévision.