Minimaal benodigde configuratie
Om applicaties data naar AppSignal te laten rapporteren is de volgende configuratie vereist. Alle andere configuratie is optioneel.- Applicatienaam - name-optie
- Applicatieomgeving - environment (automatisch gedetecteerd of ingesteld met een omgevingsvariabele)
- Push API key van de applicatie - push_api_key-optie
- AppSignal moet actief zijn - active-optie
Configuratiemethoden
Er zijn verschillende configuratiemethoden beschikbaar in onze Ruby gem. Om te zien in welke volgorde ze worden geladen en welke configuratiemethode waarden uit andere bronnen overschrijft, raadpleegt u onze pagina over de laadvolgorde van configuratie.Ruby configuratiebestand
De AppSignal Ruby gem kan worden geconfigureerd met behulp van een Ruby configuratiebestand. Als hiervoor gekozen wordt, maakt de installer automatisch eenconfig/appsignal.rb-bestand aan. Dit bestand bevat standaardconfiguratie-instellingen die kunnen worden aangepast om aan de specifieke behoeften van uw applicatie te voldoen.
Dit configuratiebestand wordt gelezen wanneer Appsignal.start wordt aangeroepen, wat automatisch gebeurt voor de meeste van onze integraties. Lees de instructies voor het integreren van AppSignal als Appsignal.start niet automatisch wordt aangeroepen.
Het configuratiebestand configureert onze Ruby gem met behulp van de Appsignal.configure helper. Lees de sectie de Appsignal.configure helper voor meer details over hoe u deze gebruikt.
Het YAML-configuratiebestand wordt niet gelezen wanneer dit bestand aanwezig is.
Appsignal.configure helper
De Appsignal.configure helper kan worden gebruikt om AppSignal met Ruby-code te configureren. Het Ruby configuratiebestand gebruikt deze helper en deze kan ook direct in uw applicatie worden gebruikt.
Als uw app Appsignal.configure gebruikt buiten het config/appsignal.rb-bestand, zoals in een Rails-initializer, lees dan deze sectie over verschillen in gedrag.
Stel configuratieopties in binnen het Appsignal.configure-blok door de writer-methoden op het config-object aan te roepen. Configuratieopties kunnen worden ingesteld met de “Config file key” die wordt vermeld bij de configuratieopties. Bijvoorbeeld de send_params-optie kan worden ingesteld met: config.send_params = false.
Appsignal.configure helper werkt en welke andere helpers deze heeft.
String-configuratieopties
Configuratieopties van het type String kunnen zowel met Strings als met Symbols worden ingesteld. Wanneer ingesteld, converteren we Symbols naar Strings.Array-configuratieopties
Configuratieopties van het type Array kunnen worden gewijzigd als een normale array:- Gebruik een toewijzing om de standaardwaarden en eerder ingelezen waarden uit omgevingsvariabelen te overschrijven.
- Bijvoorbeeld:
config.array_option = ["value 1", "value 2"] - Optiewaarde:
["value 1", "value 2"]
- Bijvoorbeeld:
- Gebruik de additieve toewijzingsoperator
+=om een nieuwe array van waarden samen te voegen met de standaardwaarden en eerder ingelezen waarden uit omgevingsvariabelen.- Bijvoorbeeld:
config.array_option += ["value 1", "value 2"] - Optiewaarde:
["DUMMY default value", "value 1", "value 2"]
- Bijvoorbeeld:
- Gebruik de append-operator
<<om een enkele waarde toe te voegen aan de lijst van standaardwaarden en eerder ingelezen waarden uit omgevingsvariabelen.- Bijvoorbeeld:
config.array_option << "value 1" - Optiewaarde:
["DUMMY default value", "value 1"]
- Bijvoorbeeld:
Automatische omgevingsdetectie
De AppSignal Ruby gem detecteert automatisch de omgeving van de applicatie. We integreren met gems zoals Rails, Sinatra, Rack en anderen om te detecteren in welke omgeving de applicatie is gestart. Daarom zou het niet nodig moeten zijn om de omgeving handmatig te configureren. Als u de applicatieomgeving toch handmatig wilt configureren, geef dan de naam van de omgeving als eerste argument aan deAppsignal.configure helper. Dit argument overschrijft de waarde van de APPSIGNAL_APP_ENV omgevingsvariabele en de automatische omgevingsdetectie.
activate_if_environment helper
De Appsignal.configure helper heeft een helper om te configureren welke omgevingen actief moeten zijn en data naar AppSignal.com moeten rapporteren.
Roep activate_if_environment aan met een lijst van omgevingen (Strings en/of Symbols).
AppSignal detecteert de omgeving wanneer de Appsignal.configure helper wordt aangeroepen zonder omgevingsargument. Vervolgens controleert het of de omgeving overeenkomt met een van de gegeven waarden, en zo ja, dan wordt de active-configuratieoptie op true gezet.
activate_if_environment helper is een handige helper om te voorkomen dat applicaties hun eigen controles moeten toevoegen wanneer AppSignal actief moet zijn, zoals:
env? helper
De Appsignal.configure helper heeft een helper om te controleren welke omgeving AppSignal heeft gedetecteerd. Gebruik deze helper om te controleren welke omgeving actief is en zo de configuratieopties in te stellen die alleen op deze omgeving van toepassing zijn.
Roep de env? helper aan met een omgevingsnaam (String of Symbol), en deze retourneert true als de naam van de omgeving overeenkomt met de momenteel actieve omgeving.
De Appsignal.configure helper in uw applicatie gebruiken
We raden aan om de AppSignal Ruby gem te configureren met het Ruby configuratiebestand op config/appsignal.rb. Als een Rails-initializer of inline-configuratie de voorkeur heeft, lees dan deze sectie voor de veranderingen in gedrag die dit met zich meebrengt.
Als de Appsignal.configure helper wordt aangeroepen voordat het config/appsignal.rb Ruby-configuratiebestand wordt gelezen wanneer Appsignal.start wordt aangeroepen, zal het Ruby-configuratiebestand niet worden gelezen.
In Rails-apps, zorg ervoor dat u de AppSignal gem zo configureert dat hij start nadat Rails is geïnitialiseerd, anders wordt de configuratie ingesteld met Appsignal.configure genegeerd wanneer deze in een Rails-initializer zoals config/initializers/appsignal.rb wordt aangeroepen.
Voorbeeld van een Rails-initializer:
Systeem-omgevingsvariabelen
AppSignal kan ook worden geconfigureerd met behulp van systeem-omgevingsvariabelen op de host waarop de applicatie die AppSignal monitort, draait. Dit is gebruikelijk op platforms zoals Heroku. Zorg ervoor dat deze omgevingsvariabelen geconfigureerd zijn op een manier die compatibel is met uw besturingssysteem en dat de waarden worden geladen voordat uw app met AppSignal wordt gestart.YAML-configuratiebestand
De AppSignal Ruby gem kan worden geconfigureerd met een YAML-configuratiebestand. Tijdens de installatie maakt de Ruby gem, indien geselecteerd, eenconfig/appsignal.yml-bestand aan. In dit bestand wordt enige standaardconfiguratie aangeleverd die kan worden aangepast aan de behoeften van uw applicatie. Dit config/appsignal.yml-bestand ondersteunt ERB-tags zodat systeem-omgevingsvariabelen ook in dit bestand geladen kunnen worden.
De config/appsignal.yml-configuratievoorbeelden die voor configuratieopties getoond worden, gebruiken het default YAML-anker. De AppSignal-installer maakt standaard een config/appsignal.yml-bestand met dit anker aan. Als dit niet aanwezig is, zorg er dan voor dat u de configuratieoptie aan de juiste omgeving toevoegt.
Meerdere app-omgevingen
Meerdere app-omgevingen kunnen in dit bestand worden geconfigureerd via root-level sleutels.defaults-anker te configureren en dat automatisch op alle omgevingen toe te passen. Elke omgeving moet in het YAML-bestand worden geconfigureerd met een root-level sleutel en dit defaults-anker uitbreiden.
Voorbeeld van YAML-configuratiebestand
Hier is een voorbeeld van eenappsignal.yml-configuratiebestand. Het wordt aanbevolen
dat u alleen de configuratie die u nodig heeft aan uw configuratiebestand toevoegt.
Voor de volledige lijst met opties, zie de pagina met configuratie-
opties.