Het AppSignal voor Elixir-pakket integreert met Phoenix. Om de integratie op
te zetten, volg onze installatiehandleiding.
Deze pagina beschrijft verdere manieren om AppSignal te configureren voor het Phoenix-
framework. Lees de Elixir-
instrumentatie-documentatie om meer aangepaste
instrumentatie toe te voegen aan uw Phoenix-applicatie.
Meer informatie vindt u in de AppSignal Hex-pakketdocumentatie.
Installatie
- De AppSignal-instrumentatie voor Phoenix is onderdeel van een
apart pakket, dat afhankelijk is van het primaire
appsignal-pakket. Voeg het pakket appsignal_phoenix toe aan uw mix.exs-bestand.
- Voer vervolgens
mix deps.get uit.
- Voer vervolgens
mix appsignal.install YOUR_PUSH_API_KEY uit.
Na installeren en configureren begint het AppSignal voor Phoenix-pakket automatisch met het instrumenteren van HTTP-requests, wat betekent dat er geen verdere setup nodig is.
Om diepere inzichten te krijgen, kan AppSignal worden ingesteld om channels en live views te instrumenteren.
Channels
Channel-instrumentatie met een channel’s handle
Inkomende channel-requests kunnen worden geïnstrumenteerd door de code in uw
handle_in/3-functies te wikkelen met Appsignal.Phoenix.Channel.instrument/5:
Alternatief kunt u function decorators gebruiken om channels te instrumenteren. Hoewel
minder flexibel dan de instrumentatiefunctie, minimaliseren decorators de hoeveelheid
code die u aan de channels van uw applicatie hoeft toe te voegen.
Channel-events worden weergegeven onder het tabblad “Background jobs” en tonen de
channel-module en het action-argument dat u heeft ingevoerd.
LiveView
Er zijn twee verschillende manieren om live views te instrumenteren. U kunt onze
automatische telemetry-handlers gebruiken, of u kunt uw live view-handlers
handmatig instrumenteren met onze hulpfuncties.
Automatische telemetry-handlers
Opmerking: De LiveView Telemetry-integratie is beschikbaar vanaf AppSignal voor
Phoenix-versie 2.1.0.
AppSignal’s LiveView Telemetry-integratie instrumenteert live view-events automatisch.
Om dit op te zetten, roept u Appsignal.Phoenix.LiveView.attach/0 aan om de LiveView Telemetry-handlers te koppelen.
We raden aan om deze functie aan te roepen vanuit application.ex van uw app:
AppSignal instrumenteert nu automatisch alle mount-, handle_event- en handle_param-events onder de namespace live_view, wat betekent dat u zowel performance- als foutinzichten in uw live views ontvangt.
Handmatige hulpfuncties
Als u de automatische telemetry-instrumentatie hierboven al heeft geconfigureerd,
hoeft u uw live view-handlers niet handmatig te instrumenteren.
Opmerking: De LiveView-hulpfuncties zijn beschikbaar vanaf AppSignal voor
Elixir-versie 1.13.0.
Een LiveView-action kan ook handmatig worden geïnstrumenteerd door de inhoud ervan in een
Appsignal.Phoenix.LiveView.instrument/4-blok te wikkelen.
Gegeven een live view die zijn eigen status elke seconde bijwerkt, kunnen we
AppSignal-instrumentatie toevoegen door zowel de mount/2- als de handle_info/2-
functies te wikkelen met een aanroep naar Appsignal.Phoenix.LiveView.instrument/4:
Het aanroepen van een van deze functies in uw app maakt nu automatisch een
sample aan die naar AppSignal wordt gestuurd. Deze worden weergegeven onder de namespace
:live_view.
Instrumentatie voor opgenomen Plugs
Uitzonderingen in opgenomen Plugs worden automatisch opgevangen door AppSignal, maar
performance samples moeten handmatig worden opgezet met behulp van de aangepaste instrumentatie-
helpers of decorators. Zie de
Plug-
documentatie voor meer informatie.
Aangepaste instrumentatie
Voeg aangepaste instrumentatie toe om
complexere code bij te houden en completere uitsplitsingen te krijgen van trage
requests.