Passer au contenu principal
Cette documentation vous indique tout ce que vous devez savoir sur l’installation d’AppSignal via l’outil en ligne de commande.

Description

L’outil en ligne de commande aide à la mise en place de la configuration pour votre application. L’intégration avec les applications Python peut nécessiter des étapes supplémentaires, car l’installateur AppSignal ne connaît pas la façon dont votre application est configurée. Nous vous recommandons notre guide d’installation lors de l’ajout d’une nouvelle application à AppSignal et de suivre les étapes par framework dans notre documentation des intégrations. Une fois l’installation terminée, la commande de l’outil demo est exécutée automatiquement pour vérifier que l’installation s’est déroulée avec succès. La commande de l’outil demo envoie des données d’exemple depuis votre application vers les serveurs AppSignal, ce qui vous aide à vérifier que tout fonctionne correctement.

Méthodes de configuration

L’installateur en ligne de commande propose deux méthodes de configuration :
  1. Configuration via un fichier de configuration
  2. Configuration via des variables d’environnement.

1. Fichier de configuration

AppSignal peut être configuré via un fichier de configuration appelé __appsignal__.py, situé dans le répertoire racine de votre application. Lorsque vous choisissez cette option, notre installateur écrira votre configuration dans ce fichier. Lorsque vous configurez votre intégration AppSignal via le fichier de configuration, la clé Push API que vous fournissez à l’installateur sera écrite dans le fichier de configuration __appsignal__.py. Nous ne recommandons pas d’ajouter cette clé à des systèmes de contrôle de version tels que Git, SVN ou Mercurial. Utilisez plutôt la variable d’environnement APPSIGNAL_PUSH_API_KEY pour stocker votre clé API. Vous pouvez en savoir plus sur la configuration de votre application dans notre documentation sur la configuration.

2. Variables d’environnement

AppSignal peut être configuré via les variables d’environnement système. Si vous sélectionnez cette option, aucun fichier de configuration ne sera généré. Vous pouvez en savoir plus sur la configuration de votre application dans notre documentation sur la configuration.

Utilisation

Pour installer appsignal via la ligne de commande, accédez au répertoire de votre projet et exécutez la commande suivante :
python -m appsignal install --push-api-key <Push API key>
# For example
python -m appsignal install --push-api-key 1234-1234-1234-1234
La « Push API key » de votre application sera affichée dans l’assistant d’installation et est également disponible dans la section d’administration des paramètres de votre organisation, ou via ce lien.

Options disponibles

OptionUtilisationDescription
push-api-key--push-api-key=<Push API key>Définit la clé Push API utilisée pour authentifier l’application.
application--application=<application name>Définit le nom de l’application signalée.