Konfigurationsoptionen des Ruby-Gems - AppSignal Documentation

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.

active

Feld	Wert
Konfigurationsdatei-Schlüssel	`active`
System-Umgebungsschlüssel	`APPSIGNAL_ACTIVE`
Erforderlich	ja
Typ	Boolean (`true` / `false`)
Standardwert	`false` / vom System erkannt
Verfügbar seit Version	`0.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

Feld	Wert
System-Umgebungsschlüssel	`APPSIGNAL_APP_ENV`
Erforderlich	ja
Typ	`String`
Standardwert	`""` / vom System erkannt
Verfügbar seit Version	`0.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`name`
Systemumgebungsvariable	`APPSIGNAL_APP_NAME`
Erforderlich	ja
Typ	`String`
Standardwert	nil (standardmäßig nicht gesetzt)
Verfügbar seit Version	`1.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`push_api_key`
Systemumgebungsvariable	`APPSIGNAL_PUSH_API_KEY`
Erforderlich	ja
Typ	`String`
Standardwert	nil (standardmäßig nicht gesetzt)
Verfügbar seit Version	`0.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

Feld	Wert
Konfigurationsdatei-Schlüssel	`activejob_report_errors`
System-Umgebungsschlüssel	`APPSIGNAL_ACTIVEJOB_REPORT_ERRORS`
Erforderlich	nein
Typ	`String`
Standardwert	`all`
Verfügbar seit Version	`3.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`bind_address`
Systemumgebungsvariable	`APPSIGNAL_BIND_ADDRESS`
Erforderlich	nein
Typ	`String`
Standardwert	`127.0.0.1`
Verfügbar seit Version	`3.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`ca_file_path`
Systemumgebungsvariable	`APPSIGNAL_CA_FILE_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	Mitgelieferter Pfad zur `cacert.pem`-Datei.
Verfügbar seit Version	`1.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`cpu_count`
Systemumgebungsvariable	`APPSIGNAL_CPU_COUNT`
Erforderlich	nein
Typ	`Float`
Standardwert	`undefined`
Verfügbar seit Version	`3.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`debug`
Systemumgebungsvariable	`APPSIGNAL_DEBUG`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar seit Version	`1.0.0`
	Veraltet seit Version 3.0.16 zugunsten der `log_level`-Konfigurationsoption.

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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`default_tags`
Systemumgebungsvariable	`APPSIGNAL_DEFAULT_TAGS`
Erforderlich	nein
Typ	`Hash[String, (String \| Symbol \| Integer \| Boolean)]`
Standardwert	undefined
Verfügbar seit Version	`4.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

default: &defaults
  default_tags:
    region: europe
    shard: shard-1

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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`dns_servers`
Systemumgebungsvariable	`APPSIGNAL_DNS_SERVERS`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`
Verfügbar seit Version	`2.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

default: &defaults
  dns_servers:
    - 8.8.8.8
    - 8.8.4.4

# In der Host-Umgebung
export APPSIGNAL_DNS_SERVERS="8.8.8.8,8.8.4.4"

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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_active_support_event_log_reporter`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_ACTIVE_SUPPORT_EVENT_LOG_REPORTER`
Erforderlich	nein
Typ	`Boolean`
Standardwert	`true`
Verfügbar seit Version	`4.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_allocation_tracking`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_ALLOCATION_TRACKING`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`1.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_at_exit_hook`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_AT_EXIT_HOOK`
Erforderlich	nein
Typ	`String`
Standardwert	’on_error’ / ‘always’ auf Containern
Verfügbar seit Version	`4.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_at_exit_reporter`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_AT_EXIT_REPORTER`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_frontend_error_catching`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar seit Version	`1.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_gvl_global_timer`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_GVL_GLOBAL_TIMER`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`3.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_gvl_waiting_threads`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_GVL_WAITING_THREADS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`3.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_host_metrics`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_HOST_METRICS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	“true `/ vom System erkannt`
Verfügbar seit Version	`1.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_job_enqueue_instrumentation

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_job_enqueue_instrumentation`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_JOB_ENQUEUE_INSTRUMENTATION`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.9.0`

Beschreibung

Aktiviert oder deaktiviert das Aufzeichnen eines events, wenn ein background job eingereiht wird. Wenn aktiviert, wird beim Einreihen eines Jobs innerhalb einer aktiven transaction ein enqueue-event in der event-timeline dieser transaction aufgezeichnet. Dies gilt für die enqueue-instrumentation jeder background-job-integration:

Wenn Sie dies auf false setzen, werden diese enqueue-events nicht mehr aufgezeichnet, ohne die instrumentation der Jobs selbst zu beeinflussen. Standardmäßig aktiviert.

enable_minutely_probes

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_minutely_probes`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_MINUTELY_PROBES`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`1.3.0`
	`2.9.0`: Der Standardwert wurde auf `true` geändert.

Beschreibung

Aktiviert das System der minütlichen Probes.

enable_nginx_metrics

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_nginx_metrics`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_NGINX_METRICS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar seit Version	`3.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_rails_error_reporter`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_RAILS_ERROR_REPORTER`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`3.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_rake_performance_instrumentation`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_RAKE_PERFORMANCE_INSTRUMENTATION`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar seit Version	`3.10.0`

Beschreibung

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

enable_statsd

Feld	Wert
Schlüssel in der Konfigurationsdatei	`enable_statsd`
Systemumgebungsvariable	`APPSIGNAL_ENABLE_STATSD`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`3.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`endpoint`
Systemumgebungsvariable	`APPSIGNAL_PUSH_API_ENDPOINT`
Erforderlich	nein
Typ	`String`
Standardwert	`https://push.appsignal.com`
Verfügbar seit Version	`0.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`files_world_accessible`
Systemumgebungsvariable	`APPSIGNAL_FILES_WORLD_ACCESSIBLE`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`2.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`filter_metadata`
Systemumgebungsvariable	`APPSIGNAL_FILTER_METADATA`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`
Verfügbar seit Version	`3.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

default: &defaults
  filter_metadata:
    - path
    - request_id

filter_parameters

Feld	Wert
Schlüssel in der Konfigurationsdatei	`filter_parameters`
Systemumgebungsvariable	`APPSIGNAL_FILTER_PARAMETERS`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`
Verfügbar seit Version	`1.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

# config/appsignal.yml
default: &defaults
  filter_parameters:
    - password
    - email
    - api_token
    - token

Lesen Sie mehr über Parameter-Filterung.

filter_session_data

Feld	Wert
Schlüssel in der Konfigurationsdatei	`filter_session_data`
Systemumgebungsvariable	`APPSIGNAL_FILTER_SESSION_DATA`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`
Verfügbar seit Version	`2.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

# config/appsignal.yml
default: &defaults
  filter_session_data:
    - name
    - email
    - api_token
    - token

Lesen Sie mehr über Sessiondaten-Filterung.

host_role

Feld	Wert
Schlüssel in der Konfigurationsdatei	`host_role`
Systemumgebungsvariable	`APPSIGNAL_HOST_ROLE`
Erforderlich	nein
Typ	`String`
Standardwert	nil (standardmäßig nicht gesetzt)
Verfügbar seit Version	`3.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`hostname`
Systemumgebungsvariable	`APPSIGNAL_HOSTNAME`
Erforderlich	nein
Typ	`String`
Standardwert	vom System erkannt
Verfügbar seit Version	`1.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`http_proxy`
Systemumgebungsvariable	`APPSIGNAL_HTTP_PROXY`
Erforderlich	nein
Typ	`String`
Standardwert	nil (standardmäßig nicht gesetzt)
Verfügbar seit Version	`0.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`ignore_actions`
Systemumgebungsvariable	`APPSIGNAL_IGNORE_ACTIONS`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`
Verfügbar seit Version	`0.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`ignore_errors`
Systemumgebungsvariable	`APPSIGNAL_IGNORE_ERRORS`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`
Verfügbar seit Version	`0.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`ignore_logs`
Systemumgebungsvariable	`APPSIGNAL_IGNORE_LOGS`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`
Verfügbar seit Version	`3.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`ignore_namespaces`
Systemumgebungsvariable	`APPSIGNAL_IGNORE_NAMESPACES`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`
Verfügbar seit Version	`2.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_active_job

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_active_job`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_ACTIVE_JOB`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.9.0`

Beschreibung

Aktiviert oder deaktiviert die instrumentation für Active Job. Wenn Sie dies auf false setzen, wird die integration vollständig deaktiviert, einschließlich sowohl der Job-instrumentation als auch der enqueue-instrumentation. Standardmäßig aktiviert.

instrument_code_ownership

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_code_ownership`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_CODE_OWNERSHIP`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.7.1`

Beschreibung

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

instrument_delayed_job

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_delayed_job`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_DELAYED_JOB`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.9.0`

Beschreibung

Aktiviert oder deaktiviert die instrumentation für Delayed::Job. Wenn Sie dies auf false setzen, wird die integration vollständig deaktiviert, einschließlich sowohl der Job-instrumentation als auch der enqueue-instrumentation. Standardmäßig aktiviert.

instrument_excon

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_excon`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_EXCON`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.9.0`

Beschreibung

Aktiviert oder deaktiviert die instrumentation für Excon. Wenn Sie dies auf false setzen, wird die integration vollständig deaktiviert. Standardmäßig aktiviert.

instrument_faraday

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_faraday`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_FARADAY`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.9.0`

Beschreibung

Aktiviert oder deaktiviert die instrumentation für das Faraday-gem. Wenn Sie dies auf false setzen, wird die integration vollständig deaktiviert. Standardmäßig aktiviert.

instrument_http_rb

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_http_rb`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_HTTP_RB`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`3.2.0`

Beschreibung

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

instrument_mongo

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_mongo`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_MONGO`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.9.0`

Beschreibung

Aktiviert oder deaktiviert die MongoDB-instrumentation, die den Mongo Ruby Driver und Mongoid abdeckt. Wenn Sie dies auf false setzen, wird die integration vollständig deaktiviert. Standardmäßig aktiviert.

instrument_net_http

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_net_http`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_NET_HTTP`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`0.9.0`

Beschreibung

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

instrument_ownership

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_ownership`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_OWNERSHIP`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.3.3`

Beschreibung

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

instrument_que

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_que`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_QUE`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.9.0`

Beschreibung

Aktiviert oder deaktiviert die instrumentation für Que. Wenn Sie dies auf false setzen, wird die integration vollständig deaktiviert, einschließlich sowohl der Job-instrumentation als auch der enqueue-instrumentation. Standardmäßig aktiviert.

instrument_redis

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_redis`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_REDIS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`1.0.0`

Beschreibung

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

instrument_resque

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_resque`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_RESQUE`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.9.0`

Beschreibung

Aktiviert oder deaktiviert die instrumentation für Resque. Wenn Sie dies auf false setzen, wird die integration vollständig deaktiviert, einschließlich sowohl der Job-instrumentation als auch der enqueue-instrumentation. Standardmäßig aktiviert.

instrument_sequel

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_sequel`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_SEQUEL`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`1.0.0`

Beschreibung

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

instrument_shoryuken

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_shoryuken`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_SHORYUKEN`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.9.0`

Beschreibung

Aktiviert oder deaktiviert die instrumentation für Shoryuken. Wenn Sie dies auf false setzen, wird die integration vollständig deaktiviert, einschließlich sowohl der Job-instrumentation als auch der enqueue-instrumentation. Standardmäßig aktiviert.

instrument_sidekiq

Feld	Wert
Schlüssel in der Konfigurationsdatei	`instrument_sidekiq`
Systemumgebungsvariable	`APPSIGNAL_INSTRUMENT_SIDEKIQ`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`4.9.0`

Beschreibung

Aktiviert oder deaktiviert die instrumentation für Sidekiq. Wenn Sie dies auf false setzen, wird die integration vollständig deaktiviert, einschließlich sowohl der Job-instrumentation als auch der enqueue-instrumentation. Standardmäßig aktiviert.

log

Feld	Wert
Schlüssel in der Konfigurationsdatei	`log`
Systemumgebungsvariable	`APPSIGNAL_LOG`
Erforderlich	nein
Typ	`String`
Standardwert	`file`
Verfügbar seit Version	`2.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`log_level`
Systemumgebungsvariable	`APPSIGNAL_LOG_LEVEL`
Erforderlich	nein
Typ	`String`
Standardwert	`info`
Verfügbar seit Version	`3.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`log_path`
Systemumgebungsvariable	`APPSIGNAL_LOG_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	`./log`
Verfügbar seit Version	`1.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`nginx_port`
Systemumgebungsvariable	`APPSIGNAL_NGINX_PORT`
Erforderlich	nein
Typ	`Integer`
Standardwert	`27649`
Verfügbar seit Version	`4.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

Feld	Wert
Schlüssel in der Konfigurationsdatei	`ownership_set_namespace`
Systemumgebungsvariable	`APPSIGNAL_OWNERSHIP_SET_NAMESPACE`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar seit Version	`4.3.3`

Beschreibung

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

request_headers

Feld	Wert
Konfigurationsdatei-Schlüssel	`request_headers`
Systemumgebungs-Schlüssel	`APPSIGNAL_REQUEST_HEADERS`
Erforderlich	nein
Typ	`Array<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 Version	`2.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

# To add an additional request header it's necessary to list all default headers too
default: &defaults
  request_headers:
    - 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

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

default: &defaults
  request_headers: []

revision

Feld	Wert
Konfigurationsdatei-Schlüssel	`revision`
Systemumgebungs-Schlüssel	`APP_REVISION`
Erforderlich	nein
Typ	`String`
Standardwert	nil (Standardmäßig nicht gesetzt)
Verfügbar ab Version	`2.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

Feld	Wert
Konfigurationsdatei-Schlüssel	`running_in_container`
Systemumgebungs-Schlüssel	`APPSIGNAL_RUNNING_IN_CONTAINER`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	vom Agent erkannt
Verfügbar ab Version	`1.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

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_environment_metadata`
Systemumgebungs-Schlüssel	`APPSIGNAL_SEND_ENVIRONMENT_METADATA`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar ab Version	`2.11.0`

Beschreibung

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

send_params

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_params`
Systemumgebungs-Schlüssel	`APPSIGNAL_SEND_PARAMS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar ab Version	`0.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

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_session_data`
Systemumgebungs-Schlüssel	`APPSIGNAL_SEND_SESSION_DATA`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar ab Version	`3.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

Feld	Wert
Konfigurationsdatei-Schlüssel	`sidekiq_report_errors`
Systemumgebungs-Schlüssel	`APPSIGNAL_SIDEKIQ_REPORT_ERRORS`
Erforderlich	nein
Typ	`String`
Standardwert	`all`
Verfügbar ab Version	`3.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

Feld	Wert
Konfigurationsdatei-Schlüssel	`skip_session_data`
Systemumgebungs-Schlüssel	`APPSIGNAL_SKIP_SESSION_DATA`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar ab Version	`0.11.0`
	`3.0.20`: Veraltet zugunsten von `send_session_data`.

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

Feld	Wert
Konfigurationsdatei-Schlüssel	`statsd_port`
Systemumgebungs-Schlüssel	`APPSIGNAL_STATSD_PORT`
Erforderlich	nein
Typ	`Integer`
Standardwert	`8125`
Verfügbar ab Version	`3.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

Feld	Wert
Konfigurationsdatei-Schlüssel	`transaction_debug_mode`
Systemumgebungs-Schlüssel	`APPSIGNAL_TRANSACTION_DEBUG_MODE`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar ab Version	`2.9.18`
	Veraltet seit Version 3.0.16 zugunsten der Konfigurationsoption `log_level`.

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

Feld	Wert
Konfigurationsdatei-Schlüssel	`working_dir_path`
Systemumgebungs-Schlüssel	`APPSIGNAL_WORKING_DIR_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	vom 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

Feld	Wert
Konfigurationsdatei-Schlüssel	`working_directory_path`
Systemumgebungs-Schlüssel	`APPSIGNAL_WORKING_DIRECTORY_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	vom Agent erkannt
Verfügbar ab Version	`2.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

default: &defaults
  working_directory_path: "/tmp/project_1/"

AppSignal Ruby-Konfiguration

Zurück

AppSignal für Ruby: Ladereihenfolge

Weiter

⌘I

​Verfügbare Optionen

​active

​Beschreibung

​APPSIGNAL_APP_ENV

​Beschreibung

​Benutzerdefinierte Umgebungen in der Konfigurationsdatei

​name

​Beschreibung

​push_api_key

​Beschreibung

​activejob_report_errors

​Beschreibung

​bind_address

​Beschreibung

​ca_file_path

​Beschreibung

​cpu_count

​Beschreibung

​debug

​Beschreibung

​default_tags

​Beschreibung

​dns_servers

​Beschreibung

​enable_active_support_event_log_reporter

​Beschreibung

​enable_allocation_tracking

​Beschreibung

​enable_at_exit_hook

​Beschreibung

​enable_at_exit_reporter

​Beschreibung

​enable_frontend_error_catching

​Beschreibung

​enable_gvl_global_timer

​Beschreibung

​enable_gvl_waiting_threads

​Beschreibung

​enable_host_metrics

​Beschreibung

​enable_job_enqueue_instrumentation

​Beschreibung

​enable_minutely_probes

​Beschreibung

​enable_nginx_metrics

​Beschreibung

​enable_rails_error_reporter

​Beschreibung

​enable_rake_performance_instrumentation

​Beschreibung

​enable_statsd

​Beschreibung

​endpoint

​Beschreibung

​files_world_accessible

​Beschreibung

​filter_metadata

​Beschreibung

​filter_parameters

​Beschreibung

​filter_session_data

​Beschreibung

​host_role

​Beschreibung

​hostname

​Beschreibung

​http_proxy

​Beschreibung

​ignore_actions

​Beschreibung

​ignore_errors

​Beschreibung

​ignore_logs

​Beschreibung

​ignore_namespaces

​Beschreibung

​instrument_active_job

​Beschreibung

​instrument_code_ownership

​Beschreibung

Verfügbare Optionen

active

Beschreibung

APPSIGNAL_APP_ENV

Beschreibung

Benutzerdefinierte Umgebungen in der Konfigurationsdatei

name

Beschreibung

push_api_key

Beschreibung

activejob_report_errors

Beschreibung

bind_address

Beschreibung

ca_file_path

Beschreibung

cpu_count

Beschreibung

debug

Beschreibung

default_tags

Beschreibung

dns_servers

Beschreibung

enable_active_support_event_log_reporter

Beschreibung

enable_allocation_tracking

Beschreibung

enable_at_exit_hook

Beschreibung

enable_at_exit_reporter

Beschreibung

enable_frontend_error_catching

Beschreibung

enable_gvl_global_timer

Beschreibung

enable_gvl_waiting_threads

Beschreibung

enable_host_metrics

Beschreibung

enable_job_enqueue_instrumentation

Beschreibung

enable_minutely_probes

Beschreibung

enable_nginx_metrics

Beschreibung

enable_rails_error_reporter

Beschreibung

enable_rake_performance_instrumentation

Beschreibung

enable_statsd

Beschreibung

endpoint

Beschreibung

files_world_accessible

Beschreibung

filter_metadata

Beschreibung

filter_parameters

Beschreibung

filter_session_data

Beschreibung

host_role

Beschreibung

hostname

Beschreibung

http_proxy

Beschreibung

ignore_actions

Beschreibung

ignore_errors

Beschreibung

ignore_logs

Beschreibung

ignore_namespaces

Beschreibung

instrument_active_job

Beschreibung

instrument_code_ownership

Beschreibung