Zum Hauptinhalt springen
Bitte folgen Sie zuerst dem Installationsleitfaden, wenn Sie eine neue Anwendung zu AppSignal hinzufügen.

​
Voraussetzungen

Bevor Sie das AppSignal-Paket kompilieren können, stellen Sie sicher, dass die Build-/Kompilierungs-Tools für Ihr System installiert sind. Bitte prüfen Sie die Seite Unterstützte Betriebssysteme für alle möglicherweise erforderlichen Systemabhängigkeiten.

​
Installation

Die Installation des AppSignal-Pakets in Ihrer Elixir-Anwendung erfordert einige manuelle Schritte. Derzeit unterstützt AppSignal Phoenix, Plug und reine Elixir-Anwendungen. Wenn AppSignal Ihren Anwendungsfall nicht unterstützt oder wenn Sie ein Problem mit der Dokumentation finden, zögern Sie nicht, uns zu kontaktieren. Sie können auch einen Pull-Request in unserem öffentlichen Elixir-Repository erstellen.

​
Installation des Pakets

📖 Hinweis: Wenn Sie eine Umbrella-Anwendung betreiben, lesen Sie auch unseren Installationsleitfaden für Umbrella-Anwendungen.
Hinweis: Wenn Sie das Phoenix-Framework oder Plug verwenden, fahren Sie mit den Anleitungen AppSignal in Phoenix integrieren oder AppSignal in Plug integrieren fort.
  1. Fügen Sie zunächst appsignal zu Ihrer Abhängigkeitsliste in mix.exs hinzu.
# mix.exs
def deps do
  [
    {:appsignal, "~> 2.8"}
  ]
end
  1. Führen Sie dann mix deps.get aus.
  2. Führen Sie anschließend mix appsignal.install YOUR_PUSH_API_KEY aus oder folgen Sie der Anleitung zur manuellen Konfiguration.
Nach Abschluss der Installation starten Sie Ihre Anwendung. Wenn die AppSignal-OTP-Anwendung startet, sucht sie nach einer gültigen Konfiguration (z. B. einem AppSignal-Push-API-Key) und startet den AppSignal-Agenten. Wenn keine gültige Konfiguration gefunden wird, wird eine Warnung protokolliert. Siehe den Abschnitt Konfiguration, um zu erfahren, wie der AppSignal-Agent vollständig konfiguriert wird.

​
Konfiguration

Bevor das AppSignal-Paket funktioniert, müssen Sie es konfigurieren. Um Daten an AppSignal senden zu können, müssen Sie zunächst ein Konto auf AppSignal.com erstellen. Oder, wenn Sie bereits ein Konto haben, klicken Sie auf “add app” auf AppSignal.com/accounts. Während des Installationsprozesses können Sie den Befehl mix appsignal.install mit dem hexadezimalen Push-API-Key ausführen oder AppSignal manuell mithilfe der untenstehenden Anleitung konfigurieren. Weitere Informationen zur Konfiguration des AppSignal-Pakets für Elixir finden Sie in unserer Konfigurationsdokumentation.

​
Manuelle Konfiguration

Wenn Sie AppSignal manuell konfigurieren möchten, müssen Sie den AppSignal-Push-API-Key, den Sie im Installationsprozess erhalten, in die Konfigurationsdatei config/config.exs Ihrer Anwendung einfügen. Mit der AppSignal-Konfiguration können Sie auch einen Anwendungsnamen, eine Umgebung und mehr konfigurieren. 
# 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
Alternativ können Sie AppSignal mit OS-Umgebungsvariablen konfigurieren. 
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"
Weitere Informationen zur Konfiguration des AppSignal-Pakets für Elixir finden Sie auf unserer Seite Konfigurationsoptionen.

​
Starten Sie Ihre Anwendung!

Sobald Sie diese Anleitung abgeschlossen haben, ist Ihre Anwendung bereit, von AppSignal überwacht zu werden! Starten Sie Ihre Anwendung und führen Sie einige Anfragen darauf aus. Indem Sie einen oder zwei Fehler auslösen, testen Sie auch die Fehlerberichterstattung. Kontaktieren Sie uns, wenn Sie Fragen zur Installation haben oder während der Installation Probleme aufgetreten sind.

​
Optional: Phoenix-Instrumentierung hinzufügen

Lesen Sie mehr darüber, wie Sie mehr Instrumentierung in Ihre Phoenix-Anwendung integrieren können, in unserer Anleitung Phoenix integrieren.

​
Optional: Plug-Instrumentierung hinzufügen

Lesen Sie mehr darüber, wie Sie mehr Instrumentierung in Ihre Plug-Anwendung integrieren können, in unserer Anleitung Plug integrieren.

​
Optional: Benutzerdefinierte Instrumentierung hinzufügen

Fügen Sie Ihrer Anwendung benutzerdefinierte Instrumentierung hinzu, um einen tieferen Einblick in das zu erhalten, was in Ihrer Anwendung passiert. Lesen Sie mehr über benutzerdefinierte Instrumentierung in unserer Instrumentierungs-Dokumentation.
📖 Fahren Sie mit unserem Installationsleitfaden fort.

​
Deinstallation

Deinstallieren Sie AppSignal aus Ihrer App, indem Sie den folgenden Schritten folgen. Wenn diese Schritte abgeschlossen sind, sendet Ihre App keine Daten mehr an die AppSignal-Server.
  1. Löschen Sie in der mix.exs Ihrer App die Zeile {:appsignal, "~> 2.0"}.
  2. Führen Sie mix deps.get aus, um Ihre mix.lock mit dem Zustand der entfernten Pakete zu aktualisieren.
  3. Entfernen Sie alle AppSignal-Konfigurationsdateien aus Ihrer App.
    • Speicherort der Konfigurationsdatei: config/appsignal.exs
    • Und alle Verweise darauf in anderen Dateien in config/*.exs
  4. Entfernen Sie alle System-Umgebungsvariablen von Ihren Entwicklungs-, Staging-, Produktions- usw. Hosts.
    • Umgebungsvariablen mit dem Präfix APPSIGNAL_
    • Umgebungsvariable APP_REVISION
  5. Committen, deployen und starten Sie Ihre App neu.
    • Damit stellen Sie sicher, dass die AppSignal-Server keine Daten mehr von Ihrer App empfangen.
  6. Optional: Stellen Sie sicher, dass keine appsignal-agent-Prozesse im Hintergrund laufen.
    • Prüfen Sie die Ausgabe von ps aux | grep appsignal-agent und beenden Sie die noch laufenden Prozesse.
  7. Schließlich entfernen Sie die App auf AppSignal.com.
📖 Fahren Sie mit unserem Deinstallationsleitfaden fort.