Naar hoofdinhoud gaan
Volg eerst de installatiehandleiding wanneer u een nieuwe applicatie aan AppSignal toevoegt.

Vereisten

Voordat u het AppSignal-pakket kunt compileren, moet u ervoor zorgen dat de build-/compilatietools voor uw systeem zijn geïnstalleerd. Bekijk de pagina Ondersteunde besturingssystemen voor eventueel vereiste systeemafhankelijkheden.

Installatie

Het installeren van het AppSignal-pakket in uw Elixir-applicatie vereist enkele handmatige stappen. AppSignal ondersteunt op dit moment Phoenix, Plug en pure Elixir-apps. Als AppSignal uw use-case niet ondersteunt of als u een probleem in de documentatie vindt, aarzel dan niet om contact met ons op te nemen. U kunt ook een pull-request maken in onze publieke Elixir-repository.

Het pakket installeren

📖 Opmerking: Als u een umbrella-applicatie draait, zie dan ook onze installatiehandleiding voor umbrella.
Opmerking: Als u het Phoenix-framework of Plug gebruikt, ga dan verder met de handleidingen AppSignal integreren in Phoenix of AppSignal integreren in Plug.
  1. Begin met het toevoegen van appsignal aan uw lijst met afhankelijkheden in mix.exs.
# mix.exs
def deps do
  [
    {:appsignal, "~> 2.8"}
  ]
end
  1. Voer vervolgens mix deps.get uit.
  2. Voer vervolgens mix appsignal.install YOUR_PUSH_API_KEY uit of volg de handmatige configuratiehandleiding.
Nadat de installatie is voltooid, start u uw applicatie. Wanneer de AppSignal OTP-applicatie start, zoekt deze naar een geldige configuratie (bijv. een AppSignal Push API-sleutel) en start de AppSignal-agent. Als er geen geldige configuratie wordt gevonden, wordt er een waarschuwing gelogd. Zie de sectie Configuratie over hoe u de AppSignal-agent volledig kunt configureren.

Configuratie

Voordat het AppSignal-pakket werkt, moet u het configureren. Om data naar AppSignal te kunnen sturen, moet u eerst een account aanmaken op AppSignal.com. Of, als u al een account heeft, klik op de knop “add app” op AppSignal.com/accounts. Tijdens het installatieproces kunt u het commando mix appsignal.install uitvoeren met de hexadecimale Push API-sleutel of AppSignal handmatig configureren met behulp van de onderstaande handleiding. Voor meer informatie over het configureren van het AppSignal-pakket voor Elixir, lees onze configuratiedocumentatie.

Handmatige configuratie

Als u AppSignal handmatig wilt configureren, moet u de AppSignal Push API-sleutel die u in het installatieproces ontvangt in het configuratiebestand config/config.exs van uw applicatie plaatsen. Met behulp van de AppSignal-configuratie kunt u ook een applicatienaam, omgeving en meer instellen.
# config/config.exs
config :appsignal, :config,
  otp_app: :appsignal_phoenix_example,
  name: "AppsignalPhoenixExample",
  push_api_key: "your-push-api-key",
  env: Mix.env,
  active: true
Alternatief kunt u AppSignal configureren met OS-omgevingsvariabelen.
export APPSIGNAL_OTP_APP="appsignal_phoenix_example"
export APPSIGNAL_PUSH_API_KEY="your-push-api-key"
export APPSIGNAL_APP_NAME="AppsignalPhoenixExample"
export APPSIGNAL_APP_ENV="prod"
Voor meer informatie over het configureren van het AppSignal-pakket voor Elixir, lees onze pagina met configuratieopties.

Start uw applicatie!

Zodra u deze handleiding heeft voltooid, is uw applicatie klaar om te worden gemonitord door AppSignal! Start uw applicatie op en voer enkele requests erop uit. Door een fout of twee te activeren, test u ook de foutrapportage. Neem contact met ons op als u vragen heeft over de installatie of problemen tegenkomt tijdens de installatie.

Optioneel: Phoenix-instrumentatie toevoegen

Lees meer over hoe u meer instrumentatie kunt integreren in uw Phoenix-applicatie in onze Phoenix-integratiehandleiding.

Optioneel: Plug-instrumentatie toevoegen

Lees meer over hoe u meer instrumentatie kunt integreren in uw Plug-applicatie in onze Plug-integratiehandleiding.

Optioneel: Aangepaste instrumentatie toevoegen

Voeg aangepaste instrumentatie toe aan uw applicatie om een grondiger beeld te krijgen van wat er in uw applicatie gebeurt. Lees meer over aangepaste instrumentatie in onze instrumentatiedocumentatie.
📖 Ga verder met onze installatiehandleiding.

Verwijderen

Verwijder AppSignal uit uw app door de onderstaande stappen te volgen. Wanneer deze stappen zijn voltooid, zal uw app geen data meer naar de AppSignal-servers sturen.
  1. Verwijder in de mix.exs van uw app de regel {:appsignal, "~> 2.0"}.
  2. Voer mix deps.get uit om uw mix.lock bij te werken met de status van de verwijderde pakketten.
  3. Verwijder alle AppSignal-configuratiebestanden uit uw app.
    • Locatie van het configuratiebestand: config/appsignal.exs
    • En de verwijzingen ernaar in andere bestanden in config/*.exs
  4. Verwijder alle systeemomgevingsvariabelen van uw development-, staging-, productie-, enz. hosts.
    • Omgevingsvariabelen met het prefix APPSIGNAL_
    • Omgevingsvariabele APP_REVISION
  5. Commit, deploy en herstart uw app.
    • Dit zorgt ervoor dat de AppSignal-servers geen data meer van uw app blijven ontvangen.
  6. Optioneel: zorg ervoor dat er geen appsignal-agent-processen op de achtergrond draaien.
    • Controleer de uitvoer van ps aux | grep appsignal-agent en beëindig de processen die nog draaien.
  7. Tot slot: verwijder de app op AppSignal.com.
📖 Ga verder met onze verwijderingshandleiding.