Configuration minimale requise
Pour que les applications signalent des données à AppSignal, la configuration suivante est requise. Toute autre configuration est facultative.- Nom de l’application - option name
- Environnement de l’application - environment (détecté automatiquement ou défini avec une variable d’environnement)
- Clé push API de l’application - option push_api_key
- AppSignal doit être actif - option active
Méthodes de configuration
Plusieurs méthodes de configuration différentes sont disponibles dans notre gem Ruby. Pour voir dans quel ordre elles sont chargées et quelle méthode de configuration remplace les valeurs des autres sources, consultez notre page ordre de chargement de la configuration.Fichier de configuration Ruby
La gem Ruby AppSignal peut être configurée à l’aide d’un fichier de configuration Ruby. Lorsqu’elle est sélectionnée, l’installateur crée automatiquement un fichierconfig/appsignal.rb. Ce fichier inclut les paramètres de configuration par défaut qui peuvent être personnalisés pour répondre aux besoins spécifiques de votre application.
Ce fichier de configuration est lu lorsque Appsignal.start est appelé, ce qui est fait automatiquement pour la plupart de nos intégrations. Veuillez lire les instructions d’intégration d’AppSignal si Appsignal.start n’est pas appelé automatiquement.
Le fichier de configuration configure notre gem Ruby à l’aide de l’assistant Appsignal.configure. Veuillez lire la section l’assistant Appsignal.configure pour plus de détails sur la façon de l’utiliser.
Le fichier de configuration YAML ne sera pas lu lorsque ce fichier est présent.
Assistant Appsignal.configure
L’assistant Appsignal.configure peut être utilisé pour configurer AppSignal à l’aide de code Ruby. Le fichier de configuration Ruby utilise cet assistant et il peut également être utilisé directement dans votre application.
Si votre application utilise Appsignal.configure en dehors du fichier config/appsignal.rb, comme un initializer Rails, veuillez lire cette section sur les différences de comportement que cela implique.
Définissez les options de configuration à l’intérieur du bloc Appsignal.configure en appelant les méthodes d’écriture sur l’objet config. Les options de configuration peuvent être définies à l’aide de la « Config file key » indiquée pour les options de configuration. Par exemple, l’option send_params peut être définie avec : config.send_params = false.
Appsignal.configure et sur les autres assistants dont il dispose.
Options de configuration de type String
Les options de configuration de type String peuvent être définies à l’aide de String et de Symbol. Lorsqu’ils sont définis, nous convertirons les Symbols en Strings.Options de configuration de type Array
Les options de configuration de type Array peuvent être modifiées comme un tableau normal :- Utilisez une affectation pour remplacer les valeurs par défaut et les valeurs précédemment lues depuis les variables d’environnement.
- Par exemple :
config.array_option = ["value 1", "value 2"] - Valeur de l’option :
["value 1", "value 2"]
- Par exemple :
- Utilisez l’opérateur d’affectation d’addition
+=pour fusionner un nouveau tableau de valeurs avec les valeurs par défaut et les valeurs précédemment lues depuis les variables d’environnement.- Par exemple :
config.array_option += ["value 1", "value 2"] - Valeur de l’option :
["DUMMY default value", "value 1", "value 2"]
- Par exemple :
- Utilisez l’opérateur d’ajout
<<pour ajouter une seule valeur à la liste des valeurs par défaut et des valeurs précédemment lues depuis les variables d’environnement.- Par exemple :
config.array_option << "value 1" - Valeur de l’option :
["DUMMY default value", "value 1"]
- Par exemple :
Détection automatique de l’environnement
La gem Ruby AppSignal détecte automatiquement l’environnement de l’application. Nous nous intégrons avec des gems telles que Rails, Sinatra, Rack, et d’autres pour détecter dans quel environnement l’application a démarré. Pour cette raison, il ne devrait pas être nécessaire de configurer l’environnement manuellement. Si vous devez configurer manuellement l’environnement de l’application, passez le nom de l’environnement comme premier argument à l’assistantAppsignal.configure. Cet argument remplacera la valeur de la variable d’environnement APPSIGNAL_APP_ENV et la détection automatique de l’environnement.
Assistant activate_if_environment
L’assistant Appsignal.configure dispose d’un assistant pour configurer quels environnements doivent être actifs et signaler des données à AppSignal.com.
Appelez activate_if_environment avec une liste d’environnements (Strings et/ou Symbols).
AppSignal détecte l’environnement lorsque l’assistant Appsignal.configure est appelé sans argument d’environnement. Il vérifie ensuite si l’environnement correspond à l’une des valeurs données, et si c’est le cas, définit l’option de configuration active sur true.
activate_if_environment est un assistant pratique pour éviter aux applications d’ajouter leurs propres vérifications sur les conditions d’activation d’AppSignal, comme :
Assistant env?
L’assistant Appsignal.configure dispose d’un assistant pour vérifier quel environnement AppSignal a détecté. Utilisez cet assistant pour vérifier quel environnement est actif afin de définir les options de configuration qui ne doivent s’appliquer qu’à cet environnement.
Appelez l’assistant env? avec un nom d’environnement (String ou Symbol), et il renverra true si le nom de l’environnement correspond à l’environnement actuellement actif.
Utilisation de l’assistant Appsignal.configure dans votre application
Nous recommandons de configurer la gem Ruby AppSignal à l’aide du fichier de configuration Ruby situé dans config/appsignal.rb. Si vous préférez un initializer Rails ou une configuration inline, veuillez lire cette section pour les changements de comportement que cela implique.
Si l’assistant Appsignal.configure est appelé avant que le fichier de configuration Ruby config/appsignal.rb ne soit lu lorsque Appsignal.start est appelé, il ne lira pas le fichier de configuration Ruby.
Dans les applications Rails, assurez-vous de configurer la gem AppSignal pour qu’elle démarre après l’initialisation de Rails, sinon la configuration définie avec Appsignal.configure est ignorée lorsqu’elle est appelée dans un initializer Rails comme config/initializers/appsignal.rb.
Exemple d’initializer Rails :
Variables d’environnement système
AppSignal peut également être configuré à l’aide des variables d’environnement système sur l’hôte de l’application surveillée par AppSignal. C’est courant sur des plateformes telles que Heroku. Assurez-vous que ces variables d’environnement sont configurées de manière compatible avec votre système d’exploitation et que les valeurs sont chargées avant le démarrage de votre application avec AppSignal.Fichier de configuration YAML
La gem Ruby AppSignal peut être configurée avec un fichier de configuration YAML. Lors de l’installation, la gem Ruby créera un fichierconfig/appsignal.yml, si vous le sélectionnez. Dans ce fichier, une configuration par défaut est fournie et peut être modifiée pour répondre aux besoins de votre application. Ce fichier config/appsignal.yml prend en charge les balises ERB afin que les variables d’environnement système puissent également être chargées dans ce fichier.
Les exemples de configuration config/appsignal.yml présentés pour les options de configuration utiliseront l’ancre YAML default. L’installateur AppSignal créera un fichier config/appsignal.yml avec cette ancre par défaut. Si elle n’est pas présente, assurez-vous d’ajouter l’option de configuration à l’environnement approprié.
Plusieurs environnements d’application
Plusieurs environnements d’application peuvent être configurés dans ce fichier à l’aide de clés au niveau racine.defaults et de la faire s’appliquer automatiquement à tous les environnements. Chaque environnement doit être configuré dans le fichier YAML avec une clé au niveau racine et étendre cette ancre defaults.
Exemple de fichier de configuration YAML
Voici un exemple de fichier de configurationappsignal.yml. Nous vous recommandons
de n’ajouter à votre fichier de configuration que la configuration dont vous avez besoin.
Pour la liste complète des options, veuillez consulter la page options de
configuration.