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 des AppSignal Standalone Agents mit einer Konfigurationsdatei oder Umgebungsvariablen finden Sie in unserem Abschnitt Konfiguration.

Verfügbare Optionen

app_name

FeldWert
Konfigurationsdatei-Schlüsselapp_name
Systemumgebungs-SchlüsselAPPSIGNAL_APP_NAME
Erforderlichja
TypString
Standardwertnil (Standardmäßig nicht gesetzt)

Beschreibung

Der Name Ihrer Anwendung, wie er auf AppSignal.com angezeigt werden soll.
Hinweis: Das Ändern des Namens oder der Umgebung einer bestehenden App erstellt eine neue App auf AppSignal.com.

environment

FeldWert
Konfigurationsdatei-Schlüsselenvironment
Systemumgebungs-SchlüsselAPPSIGNAL_APP_ENV
Erforderlichja
TypString
Standardwertnil (Standardmäßig nicht gesetzt)

Beschreibung

Die Umgebung der App, die an AppSignal gemeldet werden soll.
Hinweis: Das Ändern des Namens oder der Umgebung einer bestehenden App erstellt eine neue App auf AppSignal.com.

push_api_key

FeldWert
Konfigurationsdatei-Schlüsselpush_api_key
Systemumgebungs-SchlüsselAPPSIGNAL_PUSH_API_KEY
Erforderlichja
TypString
Standardwertnil (Standardmäßig nicht gesetzt)

Beschreibung

Der Authentifizierungsschlüssel auf Organisationsebene zur Authentifizierung bei unserer Push-API. Lesen Sie mehr über den AppSignal Push-API-Schlüssel.

bind_address

FeldWert
Konfigurationsdatei-Schlüsselbind_address
Systemumgebungs-SchlüsselAPPSIGNAL_BIND_ADDRESS
Erforderlichnein
TypString
Standardwert127.0.0.1
Verfügbar ab Version0.0.24

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 auf Anfragen lauschen soll, die an diese Adresse gerichtet sind. Setzen Sie diese Option auf 0.0.0.0, um Anfragen von Hosts mit beliebiger IP-Adresse zu empfangen. Standardmäßig lauscht er nur auf Anfragen, die auf demselben Host gemacht werden. Diese Option wird auf alle Agent-Server angewendet (StatsD, OpenTelemetry und NGINX).

ca_file_path

FeldWert
Konfigurationsdatei-Schlüsselca_file_path
Systemumgebungs-SchlüsselAPPSIGNAL_CA_FILE_PATH
Erforderlichnein
TypString
StandardwertStandardmäßig die System-CAs.

Beschreibung

  • Konfiguriert den Pfad der SSL-Zertifikatsdatei.
Verwenden Sie diese Option, um auf eine andere Zertifikatsdatei zu verweisen, falls es Probleme beim Verbinden mit unserer API gibt.
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.

cpu_count

FeldWert
Konfigurationsdatei-Schlüsselcpu_count
Systemumgebungs-SchlüsselAPPSIGNAL_CPU_COUNT
Erforderlichnein
TypFloat
Standardwertundefined
Verfügbar ab Version0.34.1

Beschreibung

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

dns_servers

FeldWert
Konfigurationsdatei-Schlüsseldns_servers
Systemumgebungs-SchlüsselAPPSIGNAL_DNS_SERVERS
Erforderlichnein
TypString
Standardwertnil (Standardmäßig nicht gesetzt)

Beschreibung

Konfigurieren Sie DNS-Server, die vom AppSignal-Agenten verwendet werden sollen.
YAML
# /etc/appsignal-agent.conf
dns_servers = "8.8.8.8,8.8.4.4"
Wenn 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 erreicht werden kann, 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_host_metrics

FeldWert
Konfigurationsdatei-Schlüsselenable_host_metrics
Systemumgebungs-SchlüsselAPPSIGNAL_ENABLE_HOST_METRICS
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue / vom System erkannt
Verfügbar ab Version0.0.1
  • 0.0.26: Im Docker-Image appsignal/agent standardmäßig deaktiviert.

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 liegt daran, dass diese Systeme aus den Containern heraus ungenaue Metriken melden. Die Erfassung von Host-Metriken kann auf diesen Systemen nicht aktiviert werden. Verwenden Sie für Heroku stattdessen den Heroku-Log-Drain.

enable_http

FeldWert
Konfigurationsdatei-Schlüsselenable_http
Erforderlichnein
TypBoolean (true / false)
Standardwertfalse
Verfügbar ab Version0.0.23

Beschreibung

Setzen Sie diese Option auf true, um den OpenTelemetry-HTTP-Server zu aktivieren. Wenn aktiviert, lauscht der AppSignal-Agent auf einem an localhost gebundenen Server auf Port 8099. Wenn Sie mehrere mit AppSignal instrumentierte Anwendungen auf demselben Server ausführen, kann diese Konfigurationsoption nur in einer von ihnen aktiviert werden. Dies ist für Apps erforderlich, die den OpenTelemetry-HTTP-Exporter verwenden, um Daten an AppSignal zu melden.

enable_nginx_metrics

FeldWert
Konfigurationsdatei-Schlüsselenable_nginx_metrics
Systemumgebungs-SchlüsselAPPSIGNAL_ENABLE_NGINX_METRICS
Erforderlichnein
TypBoolean (true / false)
Standardwertfalse
Verfügbar ab Version0.0.24
  • 0.0.26: Im Docker-Image appsignal/agent standardmäßig aktiviert.

Beschreibung

Auf true setzen, um den NGINX-Metrik-Server zu aktivieren. Siehe die NGINX-Metrik-Dokumentation für Details. Wenn aktiviert, lauscht 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 von ihnen aktiviert werden.

enable_opentelemetry_http

FeldWert
Konfigurationsdatei-Schlüsselenable_opentelemetry_http
Systemumgebungs-SchlüsselAPPSIGNAL_ENABLE_OPENTELEMETRY_HTTP
Erforderlichnein
TypBoolean (true / false)
Standardwertfalse / vom System erkannt
Verfügbar ab Version0.0.25
  • 0.0.26: Im Docker-Image appsignal/agent standardmäßig aktiviert.

Beschreibung

Setzen Sie diese Option auf true, um den OpenTelemetry-HTTP-Server zu aktivieren. Wenn aktiviert, lauscht der AppSignal-Agent auf einem an localhost gebundenen Server auf Port 8099. Wenn Sie mehrere mit AppSignal instrumentierte Anwendungen auf demselben Server ausführen, kann diese Konfigurationsoption nur in einer von ihnen aktiviert werden. Dies ist für Apps erforderlich, die den OpenTelemetry-HTTP-Exporter verwenden, um Daten an AppSignal zu melden.

enable_statsd

FeldWert
Konfigurationsdatei-Schlüsselenable_statsd
Systemumgebungs-SchlüsselAPPSIGNAL_ENABLE_STATSD
Erforderlichnein
TypBoolean (true / false)
Standardwerttrue
Verfügbar ab Version0.0.24

Beschreibung

Aktiviert den StatsD-Server im AppSignal-Agenten. Wenn aktiviert, lauscht 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 von ihnen aktiviert werden.

filter_parameters

FeldWert
Konfigurationsdatei-Schlüsselfilter_parameters
Systemumgebungs-SchlüsselAPPSIGNAL_FILTER_PARAMETERS
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar ab Version0.0.23

Beschreibung

Liste von Parameter-Schlüsseln, die mit der AppSignal-Filterung ignoriert werden sollen. Ihre Werte werden beim Senden an AppSignal durch [FILTERED] ersetzt.
TOML
# appsignal.conf
filter_parameters = ["password", "confirm_password", "secret"]
Lesen Sie mehr über Parameter-Filterung.

filter_session_data

FeldWert
Konfigurationsdatei-Schlüsselfilter_session_data
Systemumgebungs-SchlüsselAPPSIGNAL_FILTER_SESSION_DATA
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar ab Version0.0.23

Beschreibung

Liste von Session-Daten-Schlüsseln, die mit der AppSignal-Filterung ignoriert werden sollen. Ihre Werte werden beim Senden an AppSignal durch [FILTERED] ersetzt.
TOML
# appsignal.conf
filter_session_data = ["secret_token_one", "secret_token_two"]
Lesen Sie mehr über Session-Daten-Filterung.

host_role

FeldWert
Konfigurationsdatei-Schlüsselhost_role
Systemumgebungs-SchlüsselAPPSIGNAL_HOST_ROLE
Erforderlichnein
TypString
Standardwertnil (Standardmäßig nicht gesetzt)
Verfügbar ab Version0.0.28

Beschreibung

Gruppieren Sie Hosts nach Rolle und generieren Sie Metriken auf Basis dieser Rolle. Eine solche Metrik ist die Zählermetrik reporting_hosts. Eine gute Rolle gibt an, welche Hauptfunktion der Server hat, wie etwa “webserver”, “processor”, “api”, “database”, “loadbalancer” usw.

hostname

FeldWert
Konfigurationsdatei-Schlüsselhostname
Systemumgebungs-SchlüsselAPPSIGNAL_HOSTNAME
Erforderlichnein
TypString
Standardwertvom System erkannt

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
Konfigurationsdatei-Schlüsselhttp_proxy
Systemumgebungs-SchlüsselAPPSIGNAL_HTTP_PROXY
Erforderlichnein
TypString
Standardwertnil (Standardmäßig nicht gesetzt)

Beschreibung

Wenn der Agent über einen Proxy mit dem Internet verbunden werden muss, geben Sie die vollständige Proxy-URL in diesem Konfigurationsschlüssel an.

ignore_actions

FeldWert
Konfigurationsdatei-Schlüsselignore_actions
Systemumgebungs-SchlüsselAPPSIGNAL_IGNORE_ACTIONS
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar ab Version0.0.26

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-Endpoints oder andere Aktionen zu ignorieren, die Sie nicht überwachen möchten. Lesen Sie mehr über das Ignorieren von Aktionen.

ignore_errors

FeldWert
Konfigurationsdatei-Schlüsselignore_errors
Systemumgebungs-SchlüsselAPPSIGNAL_IGNORE_ERRORS
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar ab Version0.0.26

Beschreibung

Liste von Fehlerklassen, die ignoriert werden. Alle mit dieser Fehlerklasse ausgelösten Exceptions werden nicht an AppSignal übertragen. Lesen Sie mehr über das Ignorieren von Fehlern.

ignore_namespaces

FeldWert
Konfigurationsdatei-Schlüsselignore_namespaces
Systemumgebungs-SchlüsselAPPSIGNAL_IGNORE_NAMESPACES
Erforderlichnein
TypArray<String>
Standardwert[]
Verfügbar ab Version0.0.26

Beschreibung

Liste von Namespaces, die ignoriert werden. Jeder Fehler oder jeder langsame Request, der in diesem Namespace auftritt, wird nicht an AppSignal gesendet. Lesen Sie mehr über Namespaces.

log_level

FeldWert
Konfigurationsdatei-Schlüssellog_level
Systemumgebungs-SchlüsselAPPSIGNAL_LOG_LEVEL
Erforderlichnein
TypString
Standardwertinfo

Beschreibung

Diese Option legt den Schweregrad des internen Loggers von AppSignal fest und hat keinen Einfluss auf die Logging-Funktion.
Legt den Schweregrad des internen Loggers von AppSignal fest. Wenn er auf “info” konfiguriert ist, werden alle Error-, Warning- und Info-Meldungen protokolliert, aber keine Debug-Meldungen. Das Setzen auf die Stufen “debug” oder “trace” ist normalerweise nur auf Anfrage des Supports erforderlich. Das Setzen der Stufe auf “debug”/“trace” könnte leichte Auswirkungen auf die Festplattennutzung und I/O haben, insbesondere bei stark frequentierten Sites. Der CPU-Overhead ist mit aktivierter Debug-Option minimal. Akzeptierte Werte:
  • error
  • warning
  • info
  • debug
  • trace

nginx_port

FeldWert
Konfigurationsdatei-Schlüsselnginx_port
Systemumgebungs-SchlüsselAPPSIGNAL_NGINX_PORT
Erforderlichnein
TypInteger
Standardwert27649
Verfügbar ab Version0.36.6

Beschreibung

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

opentelemetry_port

FeldWert
Konfigurationsdatei-Schlüsselopentelemetry_port
Systemumgebungs-SchlüsselAPPSIGNAL_OPENTELEMETRY_PORT
Erforderlichnein
TypInteger
Standardwert8099
Verfügbar ab Version0.0.28

Beschreibung

Setzen Sie diese Option, um den OpenTelemetry-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.

push_api_endpoint

FeldWert
Konfigurationsdatei-Schlüsselpush_api_endpoint
Systemumgebungs-SchlüsselAPPSIGNAL_PUSH_API_ENDPOINT
Erforderlichnein
TypString
Standardwerthttps://push.appsignal.com

Beschreibung

Konfigurieren Sie den Endpunkt zum Senden von Daten an AppSignal. Diese Einstellung muss nicht geändert werden.

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 Version0.0.27

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

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.0.24

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 Version0.0.24

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.

statsd_port

FeldWert
Konfigurationsdatei-Schlüsselstatsd_port
Systemumgebungs-SchlüsselAPPSIGNAL_STATSD_PORT
Erforderlichnein
TypInteger
Standardwert8125
Verfügbar ab Version0.0.28

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.

working_dir_path

FeldWert
Konfigurationsdatei-Schlüsselworking_dir_path
Systemumgebungs-SchlüsselAPPSIGNAL_WORKING_DIRECTORY_PATH
Erforderlichnein
TypString
Standardwert/var/lib/appsignal-agent

Beschreibung

Überschreibt den Ort, an dem der Standalone-AppSignal-Agent 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.
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.