Zum Hauptinhalt springen
Die folgende Liste enthält alle Konfigurationsoptionen mit dem Namen der Umgebungsvariable und dem Namen des Schlüssels in der Konfigurationsdatei. Weitere Informationen zur Konfiguration von AppSignal mit einer Konfigurationsdatei oder System-Umgebungsvariablen finden Sie in unserem Thema Konfiguration.

Verfügbare Optionen

active

FeldWert
Konfigurationsdatei-Schlüsselactive
System-UmgebungsschlüsselAPPSIGNAL_ACTIVE
Erforderlichja
TypBoolean (true / false)
Standardwertfalse / vom System erkannt
Verfügbar seit Version0.3.0
  • 0.11.6: Unterstützung für die Umgebungsvariablen-Option hinzugefügt.

Beschreibung

Hinweis: Wenn die Umgebungsvariable APPSIGNAL_PUSH_API_KEY gesetzt ist, ist der Standardwert true. Dies kann überschrieben werden, indem die System-Umgebungsvariable APPSIGNAL_ACTIVE auf false gesetzt wird: APPSIGNAL_ACTIVE=false.
Konfigurieren Sie, ob AppSignal für eine bestimmte Umgebung aktiv sein soll oder nicht. Am häufigsten verwendet in der Dateikonfiguration pro Umgebung.

APPSIGNAL_APP_ENV

FeldWert
System-UmgebungsschlüsselAPPSIGNAL_APP_ENV
Erforderlichja
TypString
Standardwert"" / vom System erkannt
Verfügbar seit Version0.11.8
  • 1.3.0: Unterstützung für Padrino hinzugefügt.
  • 1.3.6: Unterstützung für Sinatra hinzugefügt.
  • 2.0.4: Standardisiert das Verhalten für die gesamte Konfiguration.

Beschreibung

Die Umgebung der App, die an AppSignal gemeldet werden soll. Diese Konfigurationsoption wird in Rails-Apps automatisch erkannt. Bei Rails-Apps wird die Variable RAILS_ENV zur Erkennung der Umgebung verwendet. Bei Apps, die andere Frameworks oder gar keines verwenden, wird die Umgebungsvariable RACK_ENV verwendet. Um diese automatische Erkennung zu überschreiben, setzen Sie die Umgebungsvariable APPSIGNAL_APP_ENV.
Shell
export APPSIGNAL_APP_ENV=staging
rackup
Diese Option wird verwendet, um die Konfiguration aus den Konfigurationsdateien zu laden, in denen die AppSignal-Konfiguration gespeichert ist. Die Umgebungsvariablen-Option wird häufig auf Plattformen verwendet, auf denen Apps standardmäßig in der production-Umgebung laufen, wie z. B. Heroku. Diese Einstellung ermöglicht es, die Umgebung beispielsweise auf staging zu setzen.
Shell
heroku config:set APPSIGNAL_APP_ENV=staging
Wenn die Umgebung über den Appsignal.configure-Helfer gesetzt wird, überschreibt dies die Umgebungsvariable APPSIGNAL_APP_ENV.
Hinweis: Wenn Sie den Namen oder die Umgebung einer bestehenden App ändern, wird auf AppSignal.com eine neue App erstellt.
Hinweis: Diese Konfigurationsoption hat keinen Entsprechung als Konfigurationsdatei-Schlüssel. Um die Umgebung bei der AppSignal-Initialisierung zu setzen, müssen Sie die Konfiguration manuell initialisieren.

Benutzerdefinierte Umgebungen in der Konfigurationsdatei

In der Datei config/appsignal.yml ist kein Schlüssel env verfügbar. Wenn Sie den Umgebungsnamen für eine App dynamisch in der Konfigurationsdatei festlegen möchten, können Sie Ihre Konfigurationsdatei so anpassen, dass die Umgebung verwendet wird, um eine Umgebung zu erstellen.
YAML
# config/appsignal.yml
<%= ENV["APPSIGNAL_APP_ENV"] %>:
  active: true
Wenn Sie eine andere Umgebungsvariable als APPSIGNAL_APP_ENV verwenden, stellen Sie sicher, dass der Wert mit einem der automatisch erkannten Umgebungsvariablennamen (RAILS_ENV und RACK_ENV) übereinstimmt oder mit dem an Appsignal.configure übergebenen Wert.
Hinweis: Wenn Sie den Namen oder die Umgebung einer bestehenden App ändern, wird auf AppSignal.com eine neue App erstellt.

name

FeldWert
Schlüssel in der Konfigurationsdateiname
SystemumgebungsvariableAPPSIGNAL_APP_NAME
Erforderlichja
TypString
Standardwertnil (standardmäßig nicht gesetzt)
Verfügbar seit Version1.0.0

Beschreibung

Name Ihrer Anwendung, wie er auf AppSignal.com angezeigt werden soll. Wenn Sie Ruby on Rails verwenden, erkennt das Gem den Namen automatisch und Sie können dies leer lassen. Für andere Frameworks ist das Setzen dieses Werts zwingend erforderlich.
Hinweis: Das Ändern des Namens oder der Umgebung einer bestehenden App erstellt eine neue App auf AppSignal.com.

push_api_key

FeldWert
Schlüssel in der Konfigurationsdateipush_api_key
SystemumgebungsvariableAPPSIGNAL_PUSH_API_KEY
Erforderlichja
TypString
Standardwertnil (standardmäßig nicht gesetzt)
Verfügbar seit Version0.1.0

Beschreibung

Der Authentifizierungsschlüssel auf Organisationsebene zur Authentifizierung gegenüber unserer Push-API. Lesen Sie mehr über den AppSignal Push-API-Schlüssel.
Hinweis: Wenn die Systemumgebungsvariable APPSIGNAL_PUSH_API_KEY gesetzt ist, wird die Option active standardmäßig auf true statt auf false gesetzt. Das bedeutet, AppSignal wird für die geladene Umgebung als aktiv betrachtet, auch wenn active in der Konfigurationsdatei auf false gesetzt ist. Weitere Informationen finden Sie unter der Option active.

activejob_report_errors

FeldWert
Konfigurationsdatei-Schlüsselactivejob_report_errors
System-UmgebungsschlüsselAPPSIGNAL_ACTIVEJOB_REPORT_ERRORS
Erforderlichnein
TypString
Standardwertall
Verfügbar seit Version3.6.1
  • Der Wert discard wurde in Ruby gem 3.7.3 hinzugefügt.
  • Die Umgebungsvariable APPSIGNAL_ACTIVEJOB_REPORT_ERRORS wurde in Ruby gem 3.9.0 hinzugefügt.

Beschreibung

Konfigurieren Sie das Melden von Fehlern, die in Active Job-Jobs auftreten. Diese Option ermöglicht es, die Fehlermeldung für Active Job-Jobs zu deaktivieren, um eine benutzerdefinierte Fehlermeldung hinzuzufügen. Akzeptierte Werte:
  • all: Alle Fehler bei jeder Ausführung von Jobs melden, einschließlich Wiederholungen.
  • discard: Fehler melden, wenn der Job aufgrund des Fehlers verworfen wird. Verwenden Sie diese Option, um Fehler nur dann zu melden, wenn alle Job-Wiederholungen erschöpft sind.
  • none: Keine Fehler für Jobs melden, einschließlich Wiederholungen.
Hinweis: Die Option discard funktioniert nur mit Active Job 7.1 und neuer. Auf niedrigeren Versionen wird discard als all gelesen.

bind_address

FeldWert
Schlüssel in der Konfigurationsdateibind_address
SystemumgebungsvariableAPPSIGNAL_BIND_ADDRESS
Erforderlichnein
TypString
Standardwert127.0.0.1
Verfügbar seit Version3.4.8

Beschreibung

Eine gültige IPv4-Adresse, die der AppSignal-Agent als Bindung für seine TCP- und UDP-Server verwendet. Verwenden Sie eine bestimmte Adresse, wenn der Agent nur Anfragen an diese Adresse abhören soll. Setzen Sie diese Option auf 0.0.0.0, um Anfragen von Hosts unter jeder beliebigen IP-Adresse zuzulassen. Standardmäßig hört er nur auf Anfragen, die auf demselben Host gestellt werden. Diese Option wird auf alle Agent-Server angewendet (StatsD, OpenTelemetry und NGINX).

ca_file_path

FeldWert
Schlüssel in der Konfigurationsdateica_file_path
SystemumgebungsvariableAPPSIGNAL_CA_FILE_PATH
Erforderlichnein
TypString
StandardwertMitgelieferter Pfad zur cacert.pem-Datei.
Verfügbar seit Version1.3.5

Beschreibung

Konfigurieren Sie den Pfad der SSL-Zertifikatsdatei. Standardmäßig zeigt dies auf die von AppSignal mitgelieferte cacert.pem-Datei im Gem selbst. Verwenden Sie diese Option, um auf eine andere Zertifikatsdatei zu verweisen, falls es Probleme bei der Verbindung mit unserer API gibt.
Hinweis: Der angegebene Pfad darf keine betriebssystemspezifischen Dateisystem-Abstraktionen enthalten, wie zum Beispiel das Homedir-Symbol ~ auf *NIX-Systemen. Dies wird als fehlerhafter Pfad gewertet.

cpu_count

FeldWert
Schlüssel in der Konfigurationsdateicpu_count
SystemumgebungsvariableAPPSIGNAL_CPU_COUNT
Erforderlichnein
TypFloat
Standardwertundefined
Verfügbar seit Version3.6.3

Beschreibung

Die verfügbare CPU-Kapazität des Hosts, ausgedrückt als Anzahl der CPUs. Dies wird verwendet, um den CPU-Auslastungsprozentsatz in den Host-Metriken zu berechnen. Wenn nicht gesetzt, versucht der Agent, dies automatisch aus cgroups zu erkennen. Die Anzahl der CPUs kann ein Bruchwert sein, z. B. 0.5.

debug

FeldWert
Schlüssel in der Konfigurationsdateidebug
SystemumgebungsvariableAPPSIGNAL_DEBUG
Erforderlichnein
TypBoolean (true / false)
Standardwertfalse
Verfügbar seit Version1.0.0

Beschreibung

Warnung: Diese Konfigurationsoption ist im Ruby-Gem 3.0.16 veraltet. Bitte verwenden Sie stattdessen die Option log_level für das Ruby-Gem 3.0.16 und neuer.
Aktiviert das Debug-Logging. Dies wird in der Regel nur auf Anfrage des Supports benötigt. Mit dieser aktivierten Option protokolliert AppSignal deutlich mehr Informationen über Entscheidungen, die während der Metrikerfassung getroffen werden, sowie über das Senden von Daten an die AppSignal.com-Server. Das Aktivieren des Debug-Loggings kann sich leicht auf die Festplattennutzung und das IO auswirken, besonders auf stark frequentierten Seiten. Der CPU-Overhead ist mit aktivierter Debug-Option minimal.
Diese Option legt die Schweregradstufe des internen Loggers von AppSignal fest. Diese Konfigurationsoption hat keinen Einfluss auf die Logging-Funktion.

default_tags

FeldWert
Schlüssel in der Konfigurationsdateidefault_tags
SystemumgebungsvariableAPPSIGNAL_DEFAULT_TAGS
Erforderlichnein
TypHash[String, (String | Symbol | Integer | Boolean)]
Standardwertundefined
Verfügbar seit Version4.8.3

Beschreibung

Standard-Tags, die allen Transaktionen hinzugefügt werden. Transaktionsspezifische Tags, die mit Appsignal.add_tags gesetzt werden, überschreiben Standard-Tags mit demselben Schlüssel.
Appsignal.configure do |config|
  config.default_tags = {
    "region" => "europe",
    "shard" => "shard-1"
  }
end
Wenn Sie die Umgebungsvariable verwenden, geben Sie eine durch Kommas getrennte Liste von Schlüssel-Wert-Paaren an.
Shell
export APPSIGNAL_DEFAULT_TAGS="region=europe,shard=shard-1"
Tag-Werte müssen ein String, Symbol, Integer oder Boolean sein. Tags mit anderen Werttypen werden ignoriert. Lesen Sie mehr über Tagging.

dns_servers

FeldWert
Schlüssel in der Konfigurationsdateidns_servers
SystemumgebungsvariableAPPSIGNAL_DNS_SERVERS
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar seit Version2.2.0.beta.1
  • 2.11.0: Unterstützung für die Systemumgebungs-Option hinzugefügt.

Beschreibung

Konfigurieren Sie DNS-Server, die der AppSignal-Agent verwenden soll.
Appsignal.configure do |config|
  config.dns_servers = ["8.8.8.8", "8.8.4.4"]
end
Falls Sie von unseren DNS-Timeouts betroffen sind, versuchen Sie, mit dieser Option manuell einen DNS-Server festzulegen, der nicht mehr als 4 Punkte im Servernamen verwendet.
  • Akzeptable Werte: 8.8.8.8, my.custom.local.server.
  • Nicht akzeptable Werte: foo, my.awesome.custom.local.dns.server.
Wenn der DNS-Server nicht erreichbar ist, greift der Agent auf die DNS-Konfiguration des Hosts zurück und gibt eine Meldung in der Datei appsignal.log aus: A problem occurred while setting DNS servers.

enable_active_support_event_log_reporter

FeldWert
Schlüssel in der Konfigurationsdateienable_active_support_event_log_reporter
SystemumgebungsvariableAPPSIGNAL_ENABLE_ACTIVE_SUPPORT_EVENT_LOG_REPORTER
Erforderlichnein
TypBoolean
Standardwerttrue
Verfügbar seit Version4.8.0

Beschreibung

Aktiviert die Integration für strukturiertes Event-Reporting von ActiveSupport::EventReporter. Wenn aktiviert, abonniert die AppSignal-Integration die von ActiveSupport::EventReporter ausgegebenen Events und meldet sie als Logs.

enable_allocation_tracking

FeldWert
Schlüssel in der Konfigurationsdateienable_allocation_tracking
SystemumgebungsvariableAPPSIGNAL_ENABLE_ALLOCATION_TRACKING
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version1.0.0

Beschreibung

Setzen Sie diese Option auf false, um die Verfolgung der Anzahl der allokierten Objekte in Ruby zu deaktivieren.

enable_at_exit_hook

FeldWert
Schlüssel in der Konfigurationsdateienable_at_exit_hook
SystemumgebungsvariableAPPSIGNAL_ENABLE_AT_EXIT_HOOK
Erforderlichnein
TypString
Standardwert’on_error’ / ‘always’ auf Containern
Verfügbar seit Version4.5.8

Beschreibung

Konfigurieren Sie, wie AppSignal heruntergefahren wird, wenn die Anwendung beendet wird. Dies bestimmt, ob Appsignal.stop automatisch aufgerufen wird, wodurch die Daten an die Extension und den Agent geflusht werden. Diese Option hat drei mögliche Werte:
  • always: Ruft Appsignal.stop immer auf, wenn das Programm beendet wird. Auf (Docker-)Containern wird dieser Wert automatisch gesetzt.
  • never: Ruft Appsignal.stop niemals auf, wenn das Programm beendet wird. Der Standardwert, wenn das Programm nicht in einem (Docker-)Container ausgeführt wird.
  • on_error: Ruft Appsignal.stop auf, wenn das Programm mit einem Fehler beendet wird.
Weitere Informationen finden Sie auf unserer Seite zur Instrumentierung für Skripte und Hintergrund-Jobs.

enable_at_exit_reporter

FeldWert
Schlüssel in der Konfigurationsdateienable_at_exit_reporter
SystemumgebungsvariableAPPSIGNAL_ENABLE_AT_EXIT_REPORTER
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version4.0.0

Beschreibung

Auf true setzen, um den letzten Fehler zu melden, der das Beenden des Prozesses verursacht hat. Der gemeldete Fehler ist in der Regel der Fehler, der den Prozess abstürzen lässt. Wenn das Ruby-Gem den Fehler bereits gemeldet hat, wird er nicht erneut gemeldet. Über diesen Mechanismus gemeldete Fehler werden dem Namespace „unhandled“ hinzugefügt. Fügen Sie diesen Code am Anfang der Anwendung in kurzlebigen Containern und serverlosen Funktionen ein, um sicherzustellen, dass der Fehler geflusht wird, bevor das System heruntergefahren wird.
Ruby
at_exit { sleep 5 }

enable_frontend_error_catching

FeldWert
Schlüssel in der Konfigurationsdateienable_frontend_error_catching
SystemumgebungsvariableAPPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING
Erforderlichnein
TypBoolean (true / false)
Standardwertfalse
Verfügbar seit Version1.0.0
  • 3.0.0: Aus dem Gem entfernt. Weitere Informationen finden Sie in unserem Upgrade-Leitfaden.

Beschreibung

Aktiviert das experimentelle Frontend-Fehlerabfangsystem. Dadurch wird Ihrer App eine Route unter /appsignal_error_catcher hinzugefügt, mit der JavaScript-Fehler abgefangen und an AppSignal gesendet werden können. Sie können diese Route mit frontend_error_catching_path konfigurieren.

enable_gvl_global_timer

FeldWert
Schlüssel in der Konfigurationsdateienable_gvl_global_timer
SystemumgebungsvariableAPPSIGNAL_ENABLE_GVL_GLOBAL_TIMER
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version3.3.9

Beschreibung

Setzen Sie diese Option auf false, um die Instrumentierung des GVL Global Timers zu deaktivieren. Diese Konfigurationsoption hat keine Auswirkung, wenn GVLTools nicht installiert ist.

enable_gvl_waiting_threads

FeldWert
Schlüssel in der Konfigurationsdateienable_gvl_waiting_threads
SystemumgebungsvariableAPPSIGNAL_ENABLE_GVL_WAITING_THREADS
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version3.3.9

Beschreibung

Setzen Sie diese Option auf false, um die Instrumentierung der wartenden GVL-Threads zu deaktivieren. Diese Konfigurationsoption hat keine Auswirkung, wenn GVLTools nicht installiert ist.

enable_host_metrics

FeldWert
Schlüssel in der Konfigurationsdateienable_host_metrics
SystemumgebungsvariableAPPSIGNAL_ENABLE_HOST_METRICS
Erforderlichnein
TypBoolean (true / false)
Standardwert“true / vom System erkannt
Verfügbar seit Version1.2.0

Beschreibung

Setzen Sie diese Option auf false, um die Erfassung von Host-Metriken zu deaktivieren. Auf Heroku und Dokku sind Host-Metriken standardmäßig deaktiviert. Dies geschieht, weil diese Systeme ungenaue Metriken aus den Containern heraus melden. Die Erfassung von Host-Metriken auf diesen Systemen kann nicht aktiviert werden. Verwenden Sie für Heroku stattdessen den Heroku Log Drain.

enable_minutely_probes

FeldWert
Schlüssel in der Konfigurationsdateienable_minutely_probes
SystemumgebungsvariableAPPSIGNAL_ENABLE_MINUTELY_PROBES
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version1.3.0
  • 2.9.0: Der Standardwert wurde auf true geändert.

Beschreibung

Aktiviert das System der minütlichen Probes.

enable_nginx_metrics

FeldWert
Schlüssel in der Konfigurationsdateienable_nginx_metrics
SystemumgebungsvariableAPPSIGNAL_ENABLE_NGINX_METRICS
Erforderlichnein
TypBoolean (true / false)
Standardwertfalse
Verfügbar seit Version3.3.4

Beschreibung

Auf true setzen, um den NGINX-Metrik-Server zu aktivieren. Details finden Sie in der NGINX-Metrik-Dokumentation. Wenn aktiviert, hört der AppSignal-Agent auf einem an localhost gebundenen Server auf Port 27649. Wenn Sie mehrere mit AppSignal instrumentierte Anwendungen auf demselben Server ausführen, kann diese Konfigurationsoption nur in einer davon aktiviert werden.

enable_rails_error_reporter

FeldWert
Schlüssel in der Konfigurationsdateienable_rails_error_reporter
SystemumgebungsvariableAPPSIGNAL_ENABLE_RAILS_ERROR_REPORTER
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version3.4.1

Beschreibung

Auf false setzen, um den Subscriber des Rails Error Reporters zu deaktivieren. Details finden Sie in der Rails-Dokumentation.

enable_rake_performance_instrumentation

FeldWert
Schlüssel in der Konfigurationsdateienable_rake_performance_instrumentation
SystemumgebungsvariableAPPSIGNAL_ENABLE_RAKE_PERFORMANCE_INSTRUMENTATION
Erforderlichnein
TypBoolean (true / false)
Standardwertfalse
Verfügbar seit Version3.10.0

Beschreibung

Aktiviert die Performance-Instrumentierung für Rake-Tasks. Standardmäßig meldet die Rake-Instrumentierung nur Fehler.

enable_statsd

FeldWert
Schlüssel in der Konfigurationsdateienable_statsd
SystemumgebungsvariableAPPSIGNAL_ENABLE_STATSD
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version3.0.14

Beschreibung

Aktiviert den StatsD-Server im AppSignal-Agent. Wenn aktiviert, hört der AppSignal-Agent auf einem an localhost gebundenen Server auf Port 8125. Wenn Sie mehrere mit AppSignal instrumentierte Anwendungen auf demselben Server ausführen, kann diese Konfigurationsoption nur in einer davon aktiviert werden.

endpoint

FeldWert
Schlüssel in der Konfigurationsdateiendpoint
SystemumgebungsvariableAPPSIGNAL_PUSH_API_ENDPOINT
Erforderlichnein
TypString
Standardwerthttps://push.appsignal.com
Verfügbar seit Version0.1.0
  • 1.0.0: Unterstützung für Systemumgebungsvariable hinzugefügt.

Beschreibung

Konfigurieren Sie den Endpunkt, an den Daten an AppSignal gesendet werden. Diese Einstellung muss in der Regel nicht geändert werden.

files_world_accessible

FeldWert
Schlüssel in der Konfigurationsdateifiles_world_accessible
SystemumgebungsvariableAPPSIGNAL_FILES_WORLD_ACCESSIBLE
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version2.3.6

Beschreibung

Wenn dies auf true gesetzt ist, ist das erstellte AppSignal-Arbeitsverzeichnis für alle Benutzer zugänglich (Unix-Berechtigungen 0666). Dies ist oft notwendig, da Prozesse derselben App unter unterschiedlichen Benutzern laufen. Auf false setzen, um dieses Verhalten zu deaktivieren (Unix-Berechtigungen 0644).

filter_metadata

FeldWert
Schlüssel in der Konfigurationsdateifilter_metadata
SystemumgebungsvariableAPPSIGNAL_FILTER_METADATA
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar seit Version3.4.5

Beschreibung

Das AppSignal Ruby-Gem speichert standardmäßig Metadaten über Anfragen und Hintergrund-Jobs in Samples, wie z. B. Anfragepfad, Anfragemethode, Anfrage-ID, Hintergrund-Queue, Job-ID und Wiederholungsanzahl des Jobs. Diese Metadatenwerte werden in der Tag-Box angezeigt. Wenn einer dieser Metadatenwerte PII oder andere sensible Daten enthält, verwenden Sie diese Konfigurationsoption, um Metadaten nach Schlüssel herauszufiltern. Setzen Sie die Option filter_metadata auf eine Liste von Metadaten-Schlüsseln, die herausgefiltert werden sollen. Sie können dies mit einer Liste von Schlüsseln in der Konfigurationsdatei konfigurieren. Wenn gefiltert, werden die Metadaten in der AppSignal-UI nicht sichtbar sein.
Appsignal.configure do |config|
  config.filter_metadata += ["path", "request_id"]
end

filter_parameters

FeldWert
Schlüssel in der Konfigurationsdateifilter_parameters
SystemumgebungsvariableAPPSIGNAL_FILTER_PARAMETERS
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar seit Version1.3.0
  • 2.3.0: Diese Konfigurationsoption wird auch für die Argumentfilterung in Hintergrund-Job-Integrationen verwendet.

Beschreibung

Liste von Parameter-Schlüsseln, die mittels AppSignal-Filterung ignoriert werden sollen. Ihre Werte werden bei der Übertragung an AppSignal durch [FILTERED] ersetzt. Sie können dies mit einer Liste von Schlüsseln in der Konfigurationsdatei konfigurieren.
Appsignal.configure do |config|
  config.filter_parameters += ["password", "email", "api_token", "token"]
end
Lesen Sie mehr über Parameter-Filterung.

filter_session_data

FeldWert
Schlüssel in der Konfigurationsdateifilter_session_data
SystemumgebungsvariableAPPSIGNAL_FILTER_SESSION_DATA
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar seit Version2.6.0
  • Ein Upgrade auf Version 2.6.1 oder höher wird empfohlen.

Beschreibung

Liste von Sessiondaten-Schlüsseln, die mittels AppSignal-Filterung ignoriert werden sollen. Ihre Werte werden bei der Übertragung an AppSignal durch [FILTERED] ersetzt. Sie können dies mit einer Liste von Schlüsseln in der Konfigurationsdatei konfigurieren.
Appsignal.configure do |config|
  config.filter_session_data += ["name", "email", "api_token", "token"]
end
Lesen Sie mehr über Sessiondaten-Filterung.

host_role

FeldWert
Schlüssel in der Konfigurationsdateihost_role
SystemumgebungsvariableAPPSIGNAL_HOST_ROLE
Erforderlichnein
TypString
Standardwertnil (standardmäßig nicht gesetzt)
Verfügbar seit Version3.4.11

Beschreibung

Gruppieren Sie Hosts nach Rolle und generieren Sie auf Basis dieser Rolle Metriken. Eine solche Metrik ist die Counter-Metrik reporting_hosts. Eine gute Rolle gibt an, was die Hauptrolle des Servers ist, wie zum Beispiel „webserver“, „processor“, „api“, „database“, „loadbalancer“ usw.

hostname

FeldWert
Schlüssel in der Konfigurationsdateihostname
SystemumgebungsvariableAPPSIGNAL_HOSTNAME
Erforderlichnein
TypString
Standardwertvom System erkannt
Verfügbar seit Version1.3.6

Beschreibung

Dies überschreibt den Hostnamen des Servers. Nützlich, wenn Sie keinen benutzerdefinierten Hostnamen festlegen können oder wenn auf Hosting-Diensten eine nichtssagende ID für Sie generiert wird.

http_proxy

FeldWert
Schlüssel in der Konfigurationsdateihttp_proxy
SystemumgebungsvariableAPPSIGNAL_HTTP_PROXY
Erforderlichnein
TypString
Standardwertnil (standardmäßig nicht gesetzt)
Verfügbar seit Version0.11.13

Beschreibung

Wenn der Agent die Verbindung zum Internet über einen Proxy herstellen muss, geben Sie in diesem Konfigurationsschlüssel die vollständige Proxy-URL an.

ignore_actions

FeldWert
Schlüssel in der Konfigurationsdateiignore_actions
SystemumgebungsvariableAPPSIGNAL_IGNORE_ACTIONS
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar seit Version0.10.0

Beschreibung

Mit dieser Konfigurationsoption können Sie eine Liste von Aktionen angeben, die von AppSignal ignoriert werden. Alles, was passiert, einschließlich Exceptions, wird nicht an AppSignal übertragen. Dies kann nützlich sein, um Health-Check-Endpunkte oder andere Aktionen zu ignorieren, die Sie nicht überwachen möchten. Lesen Sie mehr über das Ignorieren von Aktionen.

ignore_errors

FeldWert
Schlüssel in der Konfigurationsdateiignore_errors
SystemumgebungsvariableAPPSIGNAL_IGNORE_ERRORS
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar seit Version0.1.0

Beschreibung

Liste von Fehlerklassen, die ignoriert werden. Jede mit dieser Fehlerklasse ausgelöste Exception wird nicht an AppSignal übertragen. Lesen Sie mehr über das Ignorieren von Fehlern.

ignore_logs

FeldWert
Schlüssel in der Konfigurationsdateiignore_logs
SystemumgebungsvariableAPPSIGNAL_IGNORE_LOGS
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar seit Version3.7.0

Beschreibung

Liste von Log-Nachrichten, die ignoriert werden. Jede Log-Nachricht, die eines der Elemente der Liste enthält, wird nicht an AppSignal übertragen. Eine kleine Teilmenge der Regex-Syntax wird unterstützt. Lesen Sie mehr dazu in unserem Leitfaden zum Ignorieren von Logs.

ignore_namespaces

FeldWert
Schlüssel in der Konfigurationsdateiignore_namespaces
SystemumgebungsvariableAPPSIGNAL_IGNORE_NAMESPACES
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar seit Version2.3.0

Beschreibung

Liste von Namespaces, die ignoriert werden. Jeder ausgelöste Fehler oder jede langsame Anfrage, die in diesem Namespace auftritt, wird nicht an AppSignal gesendet. Lesen Sie mehr über Namespaces.

instrument_code_ownership

FeldWert
Schlüssel in der Konfigurationsdateiinstrument_code_ownership
SystemumgebungsvariableAPPSIGNAL_INSTRUMENT_CODE_OWNERSHIP
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version4.7.1

Beschreibung

Ob das CodeOwnership-Gem automatisch instrumentiert werden soll, kann true oder false sein.

instrument_http_rb

FeldWert
Schlüssel in der Konfigurationsdateiinstrument_http_rb
SystemumgebungsvariableAPPSIGNAL_INSTRUMENT_HTTP_RB
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version3.2.0

Beschreibung

Aktiviert oder deaktiviert die Instrumentierung für das http.rb Ruby-Gem. Standardmäßig aktiviert.

instrument_net_http

FeldWert
Schlüssel in der Konfigurationsdateiinstrument_net_http
SystemumgebungsvariableAPPSIGNAL_INSTRUMENT_NET_HTTP
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version0.9.0

Beschreibung

Ob Instrumentierung für net/http-Aufrufe hinzugefügt werden soll, kann true oder false sein.

instrument_ownership

FeldWert
Schlüssel in der Konfigurationsdateiinstrument_ownership
SystemumgebungsvariableAPPSIGNAL_INSTRUMENT_OWNERSHIP
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version4.3.3

Beschreibung

Ob das Ownership-Gem automatisch instrumentiert werden soll, kann true oder false sein.

instrument_redis

FeldWert
Schlüssel in der Konfigurationsdateiinstrument_redis
SystemumgebungsvariableAPPSIGNAL_INSTRUMENT_REDIS
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version1.0.0

Beschreibung

Ob die Instrumentierung für Redis-Abfragen mit dem Redis-Gem aktiviert werden soll, kann true oder false sein.

instrument_sequel

FeldWert
Schlüssel in der Konfigurationsdateiinstrument_sequel
SystemumgebungsvariableAPPSIGNAL_INSTRUMENT_SEQUEL
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar seit Version1.0.0

Beschreibung

Ob Instrumentierung für sequel-Abfragen mithilfe der Sequel-Gem-Integration hinzugefügt werden soll, kann true oder false sein.

log

FeldWert
Schlüssel in der Konfigurationsdateilog
SystemumgebungsvariableAPPSIGNAL_LOG
Erforderlichnein
TypString
Standardwertfile
Verfügbar seit Version2.0.0

Beschreibung

Diese Option konfiguriert, welchen Logger die interne Logging-Funktionalität von AppSignal verwendet, und beeinflusst die Logging-Funktion nicht.Hinweis: Der AppSignal-Agent, der von der Integration verwendet wird, schreibt immer in die Datei „appsignal.log“.
Wählen Sie aus, welchen Logger die AppSignal-Integration verwendet. Akzeptierte Werte sind file und stdout. Siehe auch die Konfiguration log_path.
  • file (Standard)
    • Schreibt alle AppSignal-Logs in das Dateisystem.
  • stdout (Standard auf Heroku)
    • Gibt AppSignal-Logs in STDOUT des Elternprozesses anstatt in eine Datei aus. Nützlich bei Hosting-Lösungen wie Container-Systemen und Heroku.

log_level

FeldWert
Schlüssel in der Konfigurationsdateilog_level
SystemumgebungsvariableAPPSIGNAL_LOG_LEVEL
Erforderlichnein
TypString
Standardwertinfo
Verfügbar seit Version3.0.16

Beschreibung

Diese Option legt die Schweregradstufe des internen Loggers von AppSignal fest und beeinflusst die Logging-Funktion nicht.
Legt die Schweregradstufe des internen Loggers von AppSignal fest. Wenn er auf „info“ konfiguriert ist, protokolliert er alle Error-, Warning- und Info-Nachrichten, aber nicht die Debug-Nachrichten. Das Setzen der Stufen „debug“ oder „trace“ wird in der Regel nur auf Anfrage des Supports benötigt. Das Setzen der Stufe auf „debug“/„trace“ kann sich leicht auf die Festplattennutzung und das IO auswirken, besonders auf stark frequentierten Seiten. Der CPU-Overhead ist mit aktivierter Debug-Option minimal. Akzeptierte Werte:
  • error
  • warning
  • info
  • debug
  • trace

log_path

FeldWert
Schlüssel in der Konfigurationsdateilog_path
SystemumgebungsvariableAPPSIGNAL_LOG_PATH
Erforderlichnein
TypString
Standardwert./log
Verfügbar seit Version1.0.0

Beschreibung

Diese Option konfiguriert den Speicherort der internen Logging-Datei von AppSignal und beeinflusst die Logging-Funktion nicht.
Hinweis: Der angegebene Pfad darf keine betriebssystemspezifischen Dateisystem-Abstraktionen enthalten, wie zum Beispiel das Homedir-Symbol ~ auf *NIX-Systemen. Dies wird als fehlerhafter Pfad gewertet.
Überschreibt den Speicherort des Pfades (Verzeichnisses), in das die Datei appsignal.log geschrieben werden kann.

nginx_port

FeldWert
Schlüssel in der Konfigurationsdateinginx_port
SystemumgebungsvariableAPPSIGNAL_NGINX_PORT
Erforderlichnein
TypInteger
Standardwert27649
Verfügbar seit Version4.5.15

Beschreibung

Konfigurieren Sie den Port, auf dem der NGINX-Metrik-Server bereitgestellt wird. Wenn AppSignal NGINX-Metriken empfängt, hört es auf einem an localhost gebundenen Server, standardmäßig auf Port 27649. Wenn Sie mehrere mit AppSignal instrumentierte Anwendungen auf demselben Server mit aktivierten NGINX-Metriken ausführen, verwenden Sie diese Option, um jede Anwendung so zu konfigurieren, dass sie auf einem anderen Port hört.

ownership_set_namespace

FeldWert
Schlüssel in der Konfigurationsdateiownership_set_namespace
SystemumgebungsvariableAPPSIGNAL_OWNERSHIP_SET_NAMESPACE
Erforderlichnein
TypBoolean (true / false)
Standardwertfalse
Verfügbar seit Version4.3.3

Beschreibung

Ob die Ownership-Gem-Instrumentierung den Namespace eines Samples auf seinen Owner setzen soll, kann true oder false sein.

request_headers

FeldWert
Konfigurationsdatei-Schlüsselrequest_headers
Systemumgebungs-SchlüsselAPPSIGNAL_REQUEST_HEADERS
Erforderlichnein
TypArray<String>
Standardwert["HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET", "HTTP_ACCEPT_ENCODING", "HTTP_ACCEPT_LANGUAGE", "HTTP_CACHE_CONTROL", "HTTP_CONNECTION", "CONTENT_LENGTH", "PATH_INFO", "HTTP_RANGE", "REQUEST_METHOD", "REQUEST_PATH", "SERVER_NAME", "SERVER_PORT", "SERVER_PROTOCOL"]
Verfügbar ab Version2.6.0
  • Ein Upgrade auf 2.6.1 oder höher wird empfohlen.
  • Seit 3.5.6 ist REQUEST_URI nicht mehr standardmäßig enthalten. Stattdessen ist jetzt REQUEST_PATH enthalten.

Beschreibung

Die Konfigurationsoption request_headers enthält eine Liste von HTTP-Request-Headern, die vom AppSignal-Ruby-Gem gelesen und gespeichert werden. Diese Konfigurationsoption request_headers ist eine Allowlist, was bedeutet, dass nur die in dieser Konfigurationsoption angegebenen Header berücksichtigt werden. Wenn diese Konfigurationsoption nicht gesetzt ist, wird der AppSignal-Standard verwendet.
Appsignal.configure do |config|
  # Add a request header
  config.request_headers << "PATH_INFO"

  # Remove a request header
  config.request_headers.delete("PATH_INFO")
end
Beachten Sie, dass AppSignal die Header aus Ihrer Anwendung liest und diese möglicherweise nicht 1:1 mit dem übereinstimmen, was im Browser/Client gesendet wird. In Rack-Anwendungen (Rails, Sinatra usw.) werden alle benutzerdefinierten Header mit der Zeichenkette HTTP_ versehen, alle Headernamen werden großgeschrieben und Bindestriche (-) werden durch Unterstriche (_) ersetzt. Beispielsweise kann der Header X-Hub-Signature von Ihrer Anwendung und von AppSignal mit dem Namen HTTP_X_HUB_SIGNATURE aufgerufen werden. Um AppSignal so zu konfigurieren, dass keine HTTP-Request-Header in AppSignal-Transaktionen gespeichert werden, konfigurieren Sie die Option mit einem leeren Array.
Appsignal.configure do |config|
  config.request_headers = []
end

revision

FeldWert
Konfigurationsdatei-Schlüsselrevision
Systemumgebungs-SchlüsselAPP_REVISION
Erforderlichnein
TypString
Standardwertnil (Standardmäßig nicht gesetzt)
Verfügbar ab Version2.6.0
  • Bei Verwendung dieser Option wird ein Upgrade auf 2.6.1 oder höher empfohlen.
  • 2.9.13: Automatische Erkennung für Heroku-Deployments mit aktivierter Dyno-Metadata-Labs-Funktion.
  • 2.9.14: Verwenden Sie dieses Release nicht, wenn Sie auf die Heroku-Dyno-Metadata-Erkennung angewiesen sind.
  • 3.4.7: Automatische Erkennung für Render-Deployments.
  • 3.7.5: Automatische Erkennung für Kamal-Deployments.
  • 4.5.18: Automatische Erkennung für Capistrano-Deployments.
  • 4.5.18: Automatische Erkennung für Hatchbox.io-Deployments.

Beschreibung

Legen Sie die App-Revision fest, um die aktuell laufende Version Ihrer Anwendung zu melden. AppSignal erstellt einen Deploy-Marker, wenn sich dieser Wert ändert, und versieht alle eingehenden Daten mit der aktuellen Revision. Wenn Ihre Anwendung mit Kamal bereitgestellt wird, auf Render bereitgestellt wird oder auf Heroku bereitgestellt wird und die Funktion Heroku Labs: Dyno Metadata aktiviert ist, erkennt die AppSignal-Integration automatisch den Git-Commit der aktuellen Bereitstellung und verwendet diesen als Revision. Sie können die automatisch erkannten Revisionen in Heroku, Render oder Kamal überschreiben, indem Sie die Konfigurationsoption revision manuell auf einen benutzerdefinierten Wert setzen. Weitere Informationen zu Deploy-Markern finden Sie im Thema Deploy-Marker.

running_in_container

FeldWert
Konfigurationsdatei-Schlüsselrunning_in_container
Systemumgebungs-SchlüsselAPPSIGNAL_RUNNING_IN_CONTAINER
Erforderlichnein
TypBoolean (true / false)
Standardwertvom Agent erkannt
Verfügbar ab Version1.0.0
  • Automatisch erkannt seit Version 2.0

Beschreibung

AppSignal erwartet, dass es zwischen verschiedenen Deployments auf derselben Maschine läuft. Setzen Sie diesen Schlüssel auf true, wenn die Anwendung in einem Container ausgeführt wird, beispielsweise mit Docker. Neuere Versionen der AppSignal-Integration erkennen ihre Container-Umgebung automatisch, sodass keine manuelle Konfiguration erforderlich ist. Wenn Sie Probleme mit der automatischen Erkennung haben, kontaktieren Sie bitte den Support. Diese Option wird auf Heroku automatisch auf true gesetzt.

send_environment_metadata

FeldWert
Konfigurationsdatei-Schlüsselsend_environment_metadata
Systemumgebungs-SchlüsselAPPSIGNAL_SEND_ENVIRONMENT_METADATA
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar ab Version2.11.0

Beschreibung

Sendet Umgebungsmetadaten über die Anwendung. Weitere Informationen finden Sie unter Umgebungsmetadaten.

send_params

FeldWert
Konfigurationsdatei-Schlüsselsend_params
Systemumgebungs-SchlüsselAPPSIGNAL_SEND_PARAMS
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar ab Version0.9.0
  • 1.3.0: Unterstützung für die Systemumgebungsoption hinzugefügt.

Beschreibung

Legt fest, ob das Senden von Request-Parametern an AppSignal übersprungen werden soll. Weitere Informationen finden Sie unter send_params im Abschnitt zur Filterung von Request-Parametern.

send_session_data

FeldWert
Konfigurationsdatei-Schlüsselsend_session_data
Systemumgebungs-SchlüsselAPPSIGNAL_SEND_SESSION_DATA
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar ab Version3.0.20

Beschreibung

Setzen Sie diese Option auf false, um keine Session-Daten mit Exception-Traces und Performance-Issue-Samples zu senden. Weitere Informationen finden Sie unter Filterung von Request-Session-Daten.

sidekiq_report_errors

FeldWert
Konfigurationsdatei-Schlüsselsidekiq_report_errors
Systemumgebungs-SchlüsselAPPSIGNAL_SIDEKIQ_REPORT_ERRORS
Erforderlichnein
TypString
Standardwertall
Verfügbar ab Version3.9.0

Beschreibung

Konfigurieren Sie die Meldung von Fehlern, die in Sidekiq-Jobs auftreten. Akzeptierte Werte:
  • all: Alle Fehler bei jeder Job-Ausführung melden, einschließlich Wiederholungen.
  • discard: Fehler melden, wenn der Job aufgrund des Fehlers verworfen wird. Verwenden Sie diese Option, um nur dann Fehler zu melden, wenn alle Job-Wiederholungen ausgeschöpft sind.
  • none: Keine Fehler für Jobs melden, einschließlich Wiederholungen. Nützlich für benutzerdefinierte Fehlerberichterstattung.
Hinweis: Die Option discard funktioniert nur in Sidekiq 5.1 und neuer. In niedrigeren Versionen wird discard als all interpretiert.

skip_session_data

FeldWert
Konfigurationsdatei-Schlüsselskip_session_data
Systemumgebungs-SchlüsselAPPSIGNAL_SKIP_SESSION_DATA
Erforderlichnein
TypBoolean (true / false)
Standardwertfalse
Verfügbar ab Version0.11.0

Beschreibung

Warnung: Diese Konfigurationsoption ist im Ruby-Gem 3.0.20 veraltet. Bitte verwenden Sie für neuere Versionen des Ruby-Gems stattdessen die Option send_session_data.

statsd_port

FeldWert
Konfigurationsdatei-Schlüsselstatsd_port
Systemumgebungs-SchlüsselAPPSIGNAL_STATSD_PORT
Erforderlichnein
TypInteger
Standardwert8125
Verfügbar ab Version3.4.3

Beschreibung

Setzen Sie diese Option, um den StatsD-HTTP-Server-Port des AppSignal-Agent-Prozesses zu konfigurieren. Konfigurieren Sie diesen Port, wenn auf der Maschine bereits ein anderer Prozess läuft, der ebenfalls diesen Port verwendet, um Konflikte zu vermeiden.

transaction_debug_mode

FeldWert
Konfigurationsdatei-Schlüsseltransaction_debug_mode
Systemumgebungs-SchlüsselAPPSIGNAL_TRANSACTION_DEBUG_MODE
Erforderlichnein
TypBoolean (true / false)
Standardwertfalse
Verfügbar ab Version2.9.18

Beschreibung

Warnung: Diese Konfigurationsoption ist im Ruby-Gem 3.0.16 veraltet. Bitte verwenden Sie für Ruby-Gem 3.0.16 und neuer stattdessen die Option log_level.
Aktiviert den Transaktions-Debug-Modus. Dies aktiviert eine sehr detaillierte Protokollierung von Transaktionen und Ereignissen, was bei der Entwicklung von Integrationen oder wenn Ereignisse nicht wie erwartet erfasst werden, nützlich ist. Das Log wird nur geschrieben, wenn auch die allgemeine Option debug aktiviert ist.
Diese Option legt den Schweregrad des internen Loggers von AppSignal fest und hat keinen Einfluss auf die Logging-Funktion.

working_dir_path

FeldWert
Konfigurationsdatei-Schlüsselworking_dir_path
Systemumgebungs-SchlüsselAPPSIGNAL_WORKING_DIR_PATH
Erforderlichnein
TypString
Standardwertvom Agent erkannt

Beschreibung

Warnung: Diese Konfigurationsoption ist im Ruby-Gem 2.7.0 veraltet. Bitte verwenden Sie für Ruby-Gem 2.7.0 und neuer stattdessen die Option working_directory_path.
Überschreibt den Ort, an dem AppSignal für Ruby ein Arbeitsverzeichnis erstellt. Siehe working_directory_path für das anwendbare Verhalten. Diese Konfigurationsoption hängt /appsignal an den angegebenen Pfad an, während working_directory_path dies nicht tut.
Hinweis: Der angegebene Pfad darf keine betriebssystemspezifischen Dateisystem-Abstraktionen enthalten, wie etwa das Homedir-Symbol ~ für *NIX-Systeme. Dies wird als fehlerhafter Pfad interpretiert.

working_directory_path

FeldWert
Konfigurationsdatei-Schlüsselworking_directory_path
Systemumgebungs-SchlüsselAPPSIGNAL_WORKING_DIRECTORY_PATH
Erforderlichnein
TypString
Standardwertvom Agent erkannt
Verfügbar ab Version2.7.0
  • 2.10.12: Unterstützung für die Systemumgebungsoption hinzugefügt.
  • Bitte verwenden Sie die Option working_dir_path in Versionen älter als 2.7.0.

Beschreibung

Überschreibt den Ort, an dem AppSignal für Ruby temporäre Dateien speichern kann. Verwenden Sie diese Option, wenn der Standardort nicht geeignet ist. Weitere Informationen zum Zweck dieses Arbeitsverzeichnisses finden Sie auf unserer Seite Wie AppSignal funktioniert. Wenn Sie mehrere Anwendungen mit AppSignal auf demselben Server ausführen, verwenden Sie diese Konfigurationsoption, um für jede AppSignal-Instanz unterschiedliche Arbeitsverzeichnisse auszuwählen, da die beiden Instanzen sonst miteinander in Konflikt geraten könnten. Weitere Informationen zu diesem Szenario finden Sie in unserer Dokumentation Mehrere Anwendungen auf einem Host ausführen.
Appsignal.configure do |config|
  config.working_directory_path = "/tmp/project_1/"
end
Hinweis: Der angegebene Pfad darf keine betriebssystemspezifischen Dateisystem-Abstraktionen enthalten, wie etwa das Homedir-Symbol ~ für *NIX-Systeme. Dies wird als fehlerhafter Pfad interpretiert.