stanctl-integration – Interface de ligne de commande (CLI) d' Instana pour la gestion des paquets d'intégration

Modifier en ligne

La stanctl-integration CLI est un outil en ligne de commande puissant conçu pour rationaliser la gestion des packages d'intégration d' Instana. Il permet aux ingénieurs de plate-forme, aux développeurs et aux équipes d' DevOps s de télécharger, d'importer, d'exporter, de linter, d'initialiser et de publier efficacement des paquets d'intégration qui définissent des éléments personnalisés dans Instana.

Présentation

Modifier en ligne

Le stanctl-integration CLI sert de solution complète pour gérer le cycle de vie complet des packages d'intégration d' Instana. Il offre une approche cohérente et automatisée pour gérer les tableaux de bord personnalisés et les définitions d'événements à l'aide de packages d'intégration.

Fonctions principales

Modifier en ligne

Gestion des paquets : téléchargez, initialisez, vérifiez et publiez facilement des paquets d'intégration.
Validation par le processus lint : s'assurer que les paquets respectent les normes de qualité et de formatage avant leur publication.

Avantages

Modifier en ligne

Efficacité : automatisez les tâches répétitives qui nécessiteraient autrement des interactions manuelles avec l'interface utilisateur ou des scripts d' API s personnalisés.
Cohérence : maintenir des configurations uniformes dans les environnements de développement, de test et de production.
Réduction des erreurs : minimisez les erreurs humaines grâce à la validation standardisée des paquets et au déploiement automatisé.

Référentiel officiel de configuration

Modifier en ligne

Pour des exemples concrets, des paquets fournis par la communauté et une assistance technique, consultez le référentiel officiel Observability as Code Repository d' GitHub.

Ce référentiel est géré par l'équipe IBM Instana de l' et sert de source centrale pour :

Instana officielle Packages d'intégration : packages précompilés et validés par la communauté pour diverses technologies.
Guide de configuration du package : découvrez comment définir des tableaux de bord et des définitions d'événements à l'aide de l'interface stanctl-integration CLI.
Outil CLI : téléchargez les binaires précompilés ou compilez l'interface CLI à partir du code source en suivant les instructions fournies.
Workflow de contribution : soumettez de nouveaux paquets ou des améliorations via des pull requests structurées.

Cet outil CLI aide les équipes à gérer et à normaliser efficacement les configurations d' Instana s à l'aide de packages d'intégration. En adoptant des configurations d' Instana s en tant que code, les équipes peuvent appliquer les mêmes pratiques rigoureuses de contrôle de version, de test et de déploiement qu'elles utilisent pour le code des applications.

Syntaxe

Modifier en ligne

Utilisez la syntaxe suivante pour exécuter stanctl-integration des commandes depuis votre fenêtre de terminal :

$ stanctl-integration [command] [options]

Où les commandes et options disponibles sont :

commande : Spécifie l'opération que vous souhaitez effectuer, telle que download, import, export init,, lint, ou publish.
options : fournit des paramètres ou des indicateurs supplémentaires pour modifier le comportement de la commande, tels que --package, --server, --token, --location.

Commandes

Modifier en ligne

Le tableau suivant répertorie toutes les commandes stanctl-integration disponibles avec leurs descriptions :


Commande	Description
télécharger	Téléchargez un package d'intégration depuis le registre vers un répertoire local.
Importer	Importe un package d'intégration dans un environnement d' Instana s spécifié.
exporter	Exportez les éléments d'intégration depuis un environnement d' Instana vers des fichiers locaux.
initialiser	Lancez une configuration interactive pour initialiser un nouveau package d'intégration.
LINT	Valider un package d'intégration pour la structure, le formatage et les champs obligatoires.
publier	Publiez un package d'intégration local dans le registre partagé.
{: caption="Tableau 1. `stanctl-integration` commandes » caption-side=« top »}

Référence des commandes et exemples d'utilisation

Modifier en ligne

Cette section fournit la syntaxe détaillée, les options disponibles et des exemples concrets pour chaque stanctl-integration commande.

télécharger

Modifier en ligne

Télécharge un package d'intégration depuis le registre vers votre ordinateur local.

$ stanctl-integration download [options]


Option	Description
`--package, -p`	(obligatoire) : nom du paquet.
`--location, -l`	(facultatif) : emplacement où stocker les paquets d'intégration (par défaut : répertoire de travail actuel).

Exemple :

$ stanctl-integration download --package @instana-integration/nodejs --location ./my-packages

Importer

Modifier en ligne

Importe un package d'intégration dans un environnement d' Instana.

$ stanctl-integration import [options]


Option	Description
`--package, -p`	(obligatoire) : nom ou chemin d'accès au paquet.
`--server, -S`	(obligatoire) : Adresse d'un environnement d' Instana.
`--token, -t`	(obligatoire) : jeton API pour importer le package d'intégration.
`--location, -L`	(facultatif) : emplacement où stocker les paquets d'intégration (par défaut : répertoire de travail actuel).
`--include, -i`	(facultatif) : dossier ou modèle à associer aux fichiers d'éléments d'intégration à inclure.
`--set, -s`	(facultatif) : valeurs des paramètres au format clé=valeur.
`--debug, -d`	(facultatif) : Active le mode débogage (valeur par défaut : false).

Exemple :

$ stanctl-integration import --package @instana-integration/nodejs --server example.instana.io --token YOUR_API_TOKEN --include "dashboards/**/test-*.json" --set key1=value1 --set key2=value2

exporter

Modifier en ligne

Exporte les éléments d'intégration depuis un environnement Instana.

$ stanctl-integration export [options]


Option	Description
`--server, -S`	(obligatoire) : Adresse d'un environnement d' Instana.
`--token, -t`	(obligatoire) : jeton API pour exporter les éléments d'intégration.
`--location, -L`	(facultatif) : emplacement où stocker les éléments d'intégration (par défaut : répertoire de travail actuel).
`--include, -F`	(facultatif) : Modèle permettant de faire correspondre différents aspects, par exemple le titre, pour les éléments d'intégration à exporter.
`--debug, -d`	(facultatif) : Active le mode débogage (valeur par défaut : false).

Exemple :

$ stanctl-integration export --server example.instana.io --token YOUR_API_TOKEN --include title="foo.*" --location ./my-package

initialiser

Modifier en ligne

Initialise un nouveau package d'intégration avec une configuration interactive guidée.

$ stanctl-integration init

Cette commande vous invite à :

Nom du package
Version du package
Description du package
Des mots clés
Auteur
Licence
Types d'éléments d'intégration à inclure

Exemple :

$ stanctl-integration init

publier

Modifier en ligne

Publie le package d'intégration locale dans le registre.

$ stanctl-integration publish [options]


Option	Description
`--package, -p`	(obligatoire) : nom ou chemin d'accès au paquet.
`--registry-username, -U`	(obligatoire) : nom d'utilisateur pour accéder au registre des packages d'intégration.
`--registry-email, -E`	(obligatoire) : Email pour accéder au registre des packages d'intégration.

Exemple :

$ stanctl-integration publish --package @instana-integration/nodejs --registry-username your-username --registry-email your-email@example.com

Remarque : la publication directe via l'interface CLI avec nom d'utilisateur et adresse e-mail n'est applicable que pour les registres auto-hébergés ou privés dont vous contrôlez l'accès. Pour contribuer au registre central officiel hébergé par IBM, les paquets doivent être soumis via le référentiel Observability-as-Code GitHub sous forme de pull request. IBM Les responsables de la maintenance examineront et publieront les paquets approuvés afin d'en garantir la qualité et la cohérence.

LINT

Modifier en ligne

Fournit un linting pour un package d'intégration afin de garantir qu'il respecte les meilleures pratiques.

$ stanctl-integration lint [options]


Option	Description
`--path, -p`	(facultatif) : Chemin d'accès au paquet.
`--strict-mode, -s`	(facultatif) : limite les validations.
`--debug, -d`	(facultatif) : Active le mode débogage (valeur par défaut : false).

Exemple :

$ stanctl-integration lint --path ./my-package --strict-mode --debug

Traitement des incidents

Modifier en ligne

Problème courant

Modifier en ligne

Échecs d'authentification
- Assurez-vous que votre jeton d' API e dispose des autorisations nécessaires.
- Vérifiez que vous utilisez la bonne adresse de serveur.
- Vérifiez que votre jeton n'est pas expiré.
Package introuvable
- Vérifiez que le nom du paquet est correct.
- Vérifiez si le paquet existe dans le registre.
- Assurez-vous que vous disposez d'une connexion réseau au registre.
Échecs d'importation/exportation
- Activez le mode débogage avec --debug pour obtenir des informations plus détaillées sur les erreurs.
- Vérifiez que vos fichiers JSON sont correctement formatés.
- Vérifiez que l'adresse du serveur est correcte et accessible.
SSL / Problèmes liés à TLS
- L'interface CLI utilise un agent d' HTTPS personnalisé qui ignore les erreurs de certificat auto-signé.
- Si vous utilisez un proxy d'entreprise, assurez-vous que vos paramètres proxy sont correctement configurés.

Mode débogage

Modifier en ligne

La plupart des commandes prennent en charge un --debug indicateur qui fournit des informations de journalisation plus détaillées. Utilisez cet indicateur pour résoudre les problèmes :

$ stanctl-integration import --package my-package --server example.com --token YOUR_TOKEN --debug

Codes d'exit

Modifier en ligne

Le CLI utilise les codes de sortie suivants :

0: Commande exécutée avec succès.
1: Erreur générale lors de l'exécution de la commande.
-1: L'analyse syntaxique a échoué en raison d'erreurs.