Naar hoofdinhoud gaan
De AppSignal Ruby gem kan op verschillende manieren worden geconfigureerd. Via een initializer, met een configuratiebestand of via omgevingsvariabelen.
In Ruby gem versie 2.0 is de laadvolgorde gewijzigd! Stap 4 en 5 zijn omgewisseld, zodat omgevingsvariabelen worden geladen na het appsignal.yml-configuratiebestand. Lees er meer over in de Pull Request op GitHub.
De configuratie wordt geladen in een proces met vijf stappen. Beginnend met de standaardwaarden van de gem en eindigend met het lezen van omgevingsvariabelen. De configuratie- opties kunnen worden gecombineerd zonder configuratie van een andere optie te verliezen. Een initializer, een configuratiebestand en omgevingsvariabelen samen gebruiken werkt prima.

Configuratiebronnen

1. Gem-standaardwaarden

De AppSignal gem begint met het laden van de standaardconfiguratie, het instellen van paden en het inschakelen van bepaalde functies. De agent-standaardwaarden zijn te vinden in de gem-broncode als Appsignal::Config::DEFAULT_CONFIG. Deze bron staat vermeld als default in de uitvoer van diagnose.

2. Door het systeem gedetecteerde instellingen

De gem detecteert op wat voor systeem hij draait en configureert zichzelf dienovereenkomstig. Bijvoorbeeld, wanneer hij draait in een op containers gebaseerd systeem (zoals Docker en Heroku) zet hij de configuratieoptie :running_in_container op true. Deze bron staat vermeld als system in de uitvoer van diagnose.

3. Initiële configuratie meegegeven aan de Config-initializer

Deze configuratiemethode is verouderd sinds Ruby gem 3.12 en verwijderd in Ruby gem 4.0.0 ten gunste van Appsignal.configure.
Bij het handmatig aanmaken van een Appsignal::Config-klasse kunt u de initiële configuratie meegeven die u wilt toepassen. Dit is een hash van een van de hieronder beschreven opties.
Appsignal.config = Appsignal::Config.new(Dir.pwd, "production", {
  active: true,
  name: "My app!",
  push_api_key: "e55f8e96-62df-4817-b672-d10c8d924065"
})
Deze stap overschrijft alle opgegeven opties uit de standaardwaarden of door het systeem gedetecteerde configuratie. Deze bron staat vermeld als initial in de uitvoer van diagnose.

4. appsignal.yml config-bestand

Deze configuratiemethode wordt verwijderd in de volgende major-versie van de Ruby gem. We raden aan in plaats daarvan het appsignal.rb config-bestand te gebruiken.
Een manier om uw applicatie te configureren is met behulp van het appsignal.yml-bestand. Wanneer u het appsignal install-commando gebruikt, maakt de gem er een voor u aan. Het pad van dit configuratiebestand is {project_root}/config/appsignal.yml. Deze stap overschrijft alle opgegeven opties uit de standaardwaarden, door het systeem gedetecteerde en initializer-configuratie. Lees de documentatie over het appsignal.yml config-bestand voor meer informatie over hoe deze configuratiemethode werkt. Deze bron staat vermeld als file in de uitvoer van diagnose.

5. Omgevingsvariabelen

AppSignal zoekt zijn configuratie in omgevingsvariabelen. Wanneer deze gevonden worden, overschrijven ze alle opgegeven configuratieopties uit eerdere stappen.
export APPSIGNAL_APP_NAME="my custom app name"
# start your app here
Lees de documentatie over systeem-omgevingsvariabelen voor meer informatie over hoe deze configuratiemethode werkt. Deze bron staat vermeld als env in de uitvoer van diagnose.

6. appsignal.rb config-bestand

Een manier om uw applicatie te configureren is met behulp van het appsignal.rb-bestand. Het pad van dit configuratiebestand is {project_root}/config/appsignal.rb. Dit laadpad kan niet worden aangepast. Deze stap overschrijft alle opgegeven opties uit de standaardwaarden, door het systeem gedetecteerde en omgevingsvariabelen. Als zowel een appsignal.yml config-bestand als een appsignal.rb config-bestand aanwezig zijn, wordt alleen het appsignal.rb config-bestand geladen. Lees de documentatie over het appsignal.rb config-bestand voor meer informatie over hoe deze configuratiemethode werkt. Deze bron staat vermeld als dsl in de uitvoer van diagnose.

7. Appsignal.configure helper

In versies 3 en 4 van de Ruby gem laadt het aanroepen van de Appsignal.configure helper ook het appsignal.yml-bestand, indien aanwezig. Dit gedrag wordt verwijderd in de volgende major-versie van de Ruby gem. Gebruik alleen het appsignal.rb config-bestand of de Appsignal.configure helper.
Tot slot kan de Ruby gem worden geconfigureerd met de Appsignal.configure helper in de applicatie. Wanneer aangeroepen, overschrijven alle configuratieopties die met deze helper zijn geconfigureerd alle opgegeven configuratieopties uit eerdere bronnen. Als er ook een config/appsignal.rb config-bestand in het project aanwezig is, wordt het niet geladen als de Appsignal.configure helper eerst in uw applicatie wordt aangeroepen. Lees de documentatie over de Appsignal.configure helper voor meer informatie over hoe deze configuratiemethode werkt. Deze bron staat vermeld als dsl in de uitvoer van diagnose.