Capistrano - AppSignal Documentation

Die Capistrano-Integration stellt sicher, dass bei jedem Deploy ein AppSignal-Deploy-Marker erstellt wird. Mehr über Deploy-Marker erfahren Sie hier. Eventuell ist manuelle Konfiguration erforderlich.

Installation

Stellen Sie sicher, dass Sie die Datei appsignal/capistrano im Capfile von Capistrano laden. Dies sollte während der Installation automatisch erfolgen, wenn Sie den Befehl appsignal install ausführen.

# Capfile
require 'capistrano'
# Other Capistrano requires.
require 'appsignal/capistrano'

Konfiguration

appsignal_config

# deploy.rb
set :appsignal_config, name: 'My app'

appsignal_config ermöglicht es Ihnen, jede aus der Konfigurationsdatei geladene Konfiguration zu überschreiben.

appsignal_env (seit Gem-Version 1.3)

# deploy.rb
set :stage, :alpha
set :appsignal_env, :staging

appsignal_env ermöglicht es Ihnen, eine andere AppSignal-Umgebung zu laden, wenn ein Stage-Name nicht mit der AppSignal-Umgebung übereinstimmt, wie sie in der AppSignal- Konfigurationsdatei oder Umgebungsvariable benannt ist.

appsignal_revision (seit Gem-Version 0.8.8)

Diese Methode zum Melden von Deploy-Markern ist veraltet und kann in Zukunft jederzeit entfernt werden. Das Melden von Deploy-Markern mit dieser Methode ist nur für kleine Anwendungen sinnvoll, die eine einzige Anwendungsinstanz verwenden. Sie erstellt zu einem bestimmten Zeitpunkt einen neuen Deploy-Marker, unabhängig davon, welche Version die Anwendung tatsächlich ausführt. Das bedeutet auch, dass es fehleranfälliger ist, da Daten, die nicht zum Deployment gehören sollten, diesem zugeordnet werden können. Wir erkennen Deployments automatisch, indem wir die REVISION-Datei lesen, die Capistrano seit Ruby-Gem 4.5.18 zum Release-Verzeichnis hinzufügt.

In Capistrano 2 kann AppSignal die Revision aus der Capistrano-Konfiguration abrufen. In Capistrano 3 ist dies jedoch nicht mehr verfügbar, und das Setzen der Revision wird empfohlen.

# deploy.rb
set :appsignal_revision, "my_revision"

Die Revision kann manuell gesetzt oder lokal aus dem Git-Repository abgerufen werden.

# Sets the current branch's git commit SHA as the revision
set :appsignal_revision, `git rev-parse --short HEAD`.strip

Wenn Sie die Branch-Konfigurationseinstellung von Capistrano verwenden, können Sie auch Git so einrichten, dass es die Commit-SHA aus dem ausgewählten Branch abruft.

set :branch, "main"
# Sets the selected branch's git commit SHA as the revision
set :appsignal_revision, `git rev-parse --short #{fetch(:branch)}`.strip

appsignal_user (seit Gem-Version 2.4.0)

In Kombination mit appsignal_revision (falls erforderlich) ist es möglich, einen Deploy-Benutzer für Capistrano-Deploys anzupassen. Standardmäßig wird der lokale Benutzername des Systems verwendet, der aus der Umgebungsvariable USER oder USERNAME gelesen wird, sodass keine Konfiguration nötig ist, wenn diese Variablen auf dem System verfügbar sind. Wenn Sie den Deploy-Benutzer anpassen möchten, setzen Sie die Konfigurationsoption :appsignal_user in Ihrer Capistrano-Konfiguration.

# deploy.rb
set :appsignal_user, "Jane" # Custom deploy user name

Beispielanwendungen

Wir haben zwei Beispielanwendungen in unserem Beispiel-Repository auf GitHub. Die Beispiele zeigen, wie AppSignal in kleinen Capistrano-Anwendungen eingerichtet wird, während Konfigurationswerte mit Gems wie dotenv und Figaro aus der Umgebung geladen werden.