Konfigurationsoptionen des Elixir-Pakets

Die folgende Liste enthält alle Konfigurationsoptionen mit dem Namen der Umgebungsvariablen 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

Erforderliche Optionen
- active
- env
- name
- otp_app
- push_api_key
Optionen

active

Feld	Wert
Schlüssel in Konfigurationsdatei	`active`
Systemumgebungsschlüssel	`APPSIGNAL_ACTIVE`
Erforderlich	ja
Typ	Boolean (`true` / `false`)
Standardwert	`false` / vom System erkannt
Verfügbar seit Version	`0.1.0`

Beschreibung

Hinweis: Wenn die Umgebungsvariable APPSIGNAL_PUSH_API_KEY gesetzt ist, ist der Standardwert true. Dies kann überschrieben werden, indem die Systemumgebungsvariable APPSIGNAL_ACTIVE auf false gesetzt wird: APPSIGNAL_ACTIVE=false.

Konfigurieren Sie, ob AppSignal für eine bestimmte Umgebung aktiv ist oder nicht. Am häufigsten wird dies in der Datei-Konfiguration pro Umgebung verwendet.

env

Feld	Wert
Schlüssel in Konfigurationsdatei	`env`
Systemumgebungsschlüssel	`APPSIGNAL_APP_ENV`
Erforderlich	ja
Typ	`Atom`
Standardwert	`dev`
Verfügbar seit Version	`0.1.0`
	`0.9.2`: Der Name der Umgebungsvariablen für diese Konfigurationsoption wurde von `APPSIGNAL_ENVIRONMENT` in `APPSIGNAL_APP_ENV` umbenannt.

Beschreibung

Die Umgebung der Anwendung, die an AppSignal gemeldet werden soll. Diese Option wird standardmäßig von unserem Installer auf Mix.env gesetzt. Um sie zu überschreiben, ändern Sie den Wert in config/appsignal.exs (oder Ihrer bevorzugten Konfigurationsdatei).

Elixir

# config/appsignal.exs
# oder config/config.exs
config :appsignal, :config,
  env: Mix.env # Standardwert des Installers

# Eigenen Wert setzen
config :appsignal, :config,
  env: :staging

Um die Konfigurationsoption in der Systemumgebung zu überschreiben, verwenden Sie die Umgebungsvariable APPSIGNAL_APP_ENV.

Shell

# Die Methode zum Setzen von Umgebungsvariablen kann sich auf Ihrem System unterscheiden
export APPSIGNAL_APP_ENV=staging
mix run

Die Option über Umgebungsvariable wird häufig auf Plattformen wie Heroku verwendet, auf denen Apps standardmäßig in der production-Umgebung laufen. Diese Einstellung ermöglicht es, die Umgebung beispielsweise auf staging zu überschreiben.

Shell

heroku config:set APPSIGNAL_APP_ENV=staging

Hinweis: Wenn Sie den Namen oder die Umgebung einer bestehenden App ändern, wird auf AppSignal.com eine neue App erstellt.

name

Feld	Wert
Konfigurationsdatei-Schlüssel	`name`
Systemumgebungsschlüssel	`APPSIGNAL_APP_NAME`
Erforderlich	ja
Typ	`String`
Standardwert	nil (Standardmäßig nicht gesetzt)

Beschreibung

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.

otp_app

Feld	Wert
Konfigurationsdatei-Schlüssel	`otp_app`
Systemumgebungsschlüssel	`APPSIGNAL_OTP_APP`
Erforderlich	ja
Typ	`Atom`
Standardwert	nil (Standardmäßig nicht gesetzt)
Verfügbar seit Version	`2.0.0`

Beschreibung

Der OTP-App-Name Ihrer Anwendung, der für die automatische Konfiguration der Instrumentierung von Bibliotheken wie Ecto verwendet wird.

push_api_key

Feld	Wert
Konfigurationsdatei-Schlüssel	`push_api_key`
Systemumgebungsschlüssel	`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 bei unserer Push-API. Lesen Sie mehr über den AppSignal Push-API-Schlüssel.

Hinweis: Wenn die Systemumgebungsvariable APPSIGNAL_PUSH_API_KEY gesetzt ist, ist die Option active standardmäßig true statt false. Das bedeutet, dass AppSignal für die geladene Umgebung als aktiv betrachtet wird, selbst wenn active in der Konfigurationsdatei auf false gesetzt ist. Weitere Informationen finden Sie unter der Option active.

bind_address

Feld	Wert
Schlüssel in Konfigurationsdatei	`bind_address`
Systemumgebungsschlüssel	`APPSIGNAL_BIND_ADDRESS`
Erforderlich	nein
Typ	`String`
Standardwert	`127.0.0.1`
Verfügbar seit Version	`2.7.7`

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 beliebigen IP-Adressen zu empfangen. Standardmäßig lauscht 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 Konfigurationsdatei	`ca_file_path`
Systemumgebungsschlüssel	`APPSIGNAL_CA_FILE_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	Pfad zur gepackten `cacert.pem`-Datei.
Verfügbar seit Version	`0.12.0`

Beschreibung

Konfigurieren Sie den Pfad zur SSL-Zertifikatsdatei. Standardmäßig verweist dies auf die mit AppSignal mitgelieferte cacert.pem-Datei im Paket selbst. Verwenden Sie diese Option, um auf eine andere Zertifikatsdatei zu verweisen, falls Probleme bei der Verbindung mit unserer API auftreten.

Hinweis: Der angegebene Pfad darf keine betriebssystemspezifischen Dateisystem-Abstraktionen enthalten, z. B. das Homedir-Symbol ~ für *NIX-Systeme. Dies wird als ungültiger Pfad angesehen.

cpu_count

Feld	Wert
Schlüssel in Konfigurationsdatei	`cpu_count`
Systemumgebungsschlüssel	`APPSIGNAL_CPU_COUNT`
Erforderlich	nein
Typ	`Float`
Standardwert	`undefined`
Verfügbar seit Version	`2.9.1`

Beschreibung

Die verfügbare CPU-Kapazität des Hosts, in Anzahl von CPUs. Dies wird verwendet, um den prozentualen CPU-Verbrauch 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.

debug

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

Beschreibung

Warnung: Diese Konfigurationsoption ist im Elixir-Paket 2.2.8 veraltet. Verwenden Sie für das Elixir-Paket 2.2.8 und neuer bitte stattdessen die Option log_level.

Aktivieren Sie 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, und wenn Daten an die AppSignal.com-Server gesendet werden. Die Aktivierung des Debug-Loggings kann insbesondere auf Seiten mit hohem Traffic einen geringen Einfluss auf die Festplattennutzung und IO haben. Der CPU-Overhead ist bei aktivierter Debug-Option minimal.

Diese Option legt den Schweregrad des internen Loggers von AppSignal fest. Diese Konfigurationsoption hat keine Auswirkung auf das Logging-Feature.

dns_servers

Feld	Wert
Schlüssel in Konfigurationsdatei	`dns_servers`
Systemumgebungsschlüssel	`APPSIGNAL_DNS_SERVERS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`1.3.0.beta.2`

Beschreibung

Konfigurieren Sie die DNS-Server, die der AppSignal-Agent verwenden soll.

# config/config.exs
config :appsignal, :config,
  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"

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 erreichbar ist, greift der Agent auf die DNS-Konfiguration des Hosts zurück und gibt in der Datei appsignal.log eine Meldung aus: A problem occurred while setting DNS servers.

ecto_repos

Feld	Wert
Schlüssel in Konfigurationsdatei	`ecto_repos`
Systemumgebungsschlüssel	`APPSIGNAL_ECTO_REPOS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`nil`
Verfügbar seit Version	`2.0.0`

Beschreibung

Konfigurieren Sie, für welche Ecto-Repos Abfragen instrumentiert werden sollen. Wenn nicht gesetzt, findet AppSignal Ihre Repos automatisch über Ihre Anwendungskonfiguration.

# config/config.exs
config :appsignal, :config,
  ecto_repos: [AppsignalPhoenixExample.Repo, AppsignalPhoenixExample.AnotherRepo]

# In der Host-Umgebung
export APPSIGNAL_ECTO_REPOS="AppsignalPhoenixExample.Repo,AppsignalPhoenixExample.AnotherRepo"

enable_error_backend

Feld	Wert
Schlüssel in Konfigurationsdatei	`enable_error_backend`
Systemumgebungsschlüssel	`APPSIGNAL_ENABLE_ERROR_BACKEND`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`2.4.1`

Beschreibung

Aktiviert das Error-Backend in der Elixir-Integration.

enable_host_metrics

Feld	Wert
Schlüssel in Konfigurationsdatei	`enable_host_metrics`
Systemumgebungsschlüssel	`APPSIGNAL_ENABLE_HOST_METRICS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	“true `/ vom System erkannt`

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, da 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_minutely_probes

Feld	Wert
Schlüssel in Konfigurationsdatei	`enable_minutely_probes`
Systemumgebungsschlüssel	`APPSIGNAL_ENABLE_MINUTELY_PROBES`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`1.10.1`

Beschreibung

Aktiviert das System der minütlichen Probes.

enable_nginx_metrics

Feld	Wert
Schlüssel in Konfigurationsdatei	`enable_nginx_metrics`
Systemumgebungsschlüssel	`APPSIGNAL_ENABLE_NGINX_METRICS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar seit Version	`2.5.2`

Beschreibung

Auf true setzen, um den NGINX-Metrik-Server zu aktivieren. Weitere Einzelheiten finden Sie in der Dokumentation zu NGINX-Metriken. Wenn aktiviert, lauscht der AppSignal-Agent auf einem an localhost gebundenen Server auf Port 27649. Wenn Sie mehrere AppSignal-instrumentierte Anwendungen auf demselben Server betreiben, kann diese Konfigurationsoption nur in einer davon aktiviert werden.

enable_statsd

Feld	Wert
Schlüssel in Konfigurationsdatei	`enable_statsd`
Systemumgebungsschlüssel	`APPSIGNAL_ENABLE_STATSD`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar seit Version	`2.2.6`

Beschreibung

Aktiviert den StatsD-Server im AppSignal-Agent. Wenn aktiviert, lauscht der AppSignal-Agent auf einem an localhost gebundenen Server auf Port 8125. Wenn Sie mehrere AppSignal-instrumentierte Anwendungen auf demselben Server betreiben, kann diese Konfigurationsoption nur in einer davon aktiviert werden.

endpoint

Feld	Wert
Schlüssel in Konfigurationsdatei	`endpoint`
Systemumgebungsschlüssel	`APPSIGNAL_PUSH_API_ENDPOINT`
Erforderlich	nein
Typ	`String`
Standardwert	`https://push.appsignal.com`

Beschreibung

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

files_world_accessible

Feld	Wert
Schlüssel in Konfigurationsdatei	`files_world_accessible`
Systemumgebungsschlüssel	`APPSIGNAL_FILES_WORLD_ACCESSIBLE`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`1.3.4`

Beschreibung

Wenn dies auf true gesetzt ist, ist das erstellte AppSignal-Arbeitsverzeichnis für alle Benutzer zugänglich (Unix-Berechtigungen 0666). Dies ist häufig notwendig, da Prozesse für dieselbe Anwendung unter unterschiedlichen Benutzern laufen. Setzen Sie diesen Wert auf false, um dieses Verhalten zu deaktivieren (Unix-Berechtigungen 0644).

filter_parameters

Feld	Wert
Schlüssel in Konfigurationsdatei	`filter_parameters`
Systemumgebungsschlüssel	`APPSIGNAL_FILTER_PARAMETERS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

Liste der Parameterschlüssel, die mithilfe der 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.

Elixir

# config/appsignal.exs
config :appsignal, :config,
  filter_parameters: ["password", "secret"]

Lesen Sie mehr über die Parameter-Filterung.

filter_session_data

Feld	Wert
Schlüssel in Konfigurationsdatei	`filter_session_data`
Systemumgebungsschlüssel	`APPSIGNAL_FILTER_SESSION_DATA`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`1.6.0`
	Ein Upgrade auf Version `1.6.3` oder höher wird empfohlen.

Beschreibung

Liste der Session-Datenschlüssel, die mithilfe der 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.

Elixir

# config/appsignal.exs
config :appsignal, :config,
  filter_session_data: ["name", "email", "api_token", "token"]

Lesen Sie mehr über die Filterung von Session-Daten.

host_role

Feld	Wert
Schlüssel in Konfigurationsdatei	`host_role`
Systemumgebungsschlüssel	`APPSIGNAL_HOST_ROLE`
Erforderlich	nein
Typ	`String`
Standardwert	nil (Dies ist standardmäßig nicht gesetzt)
Verfügbar seit Version	`2.7.7`

Beschreibung

Gruppieren Sie Hosts nach Rolle und generieren Sie Metriken basierend auf dieser Rolle. Eine solche Metrik ist die Counter-Metrik reporting_hosts. Eine gute Rolle gibt an, was die Hauptaufgabe des Servers ist, z. B. “webserver”, “processor”, “api”, “database”, “loadbalancer” usw.

hostname

Feld	Wert
Schlüssel in Konfigurationsdatei	`hostname`
Systemumgebungsschlüssel	`APPSIGNAL_HOSTNAME`
Erforderlich	nein
Typ	`String`
Standardwert	vom System erkannt
Verfügbar seit Version	`0.12.0`

Beschreibung

Damit wird der Hostname des Servers überschrieben. Nützlich, wenn Sie keinen benutzerdefinierten Hostnamen festlegen können oder wenn Ihnen bei Hosting-Diensten eine nichtssagende ID generiert wird.

http_proxy

Feld	Wert
Schlüssel in Konfigurationsdatei	`http_proxy`
Systemumgebungsschlüssel	`APPSIGNAL_HTTP_PROXY`
Erforderlich	nein
Typ	`String`
Standardwert	nil (Dies ist standardmäßig nicht gesetzt)

Beschreibung

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

ignore_actions

Feld	Wert
Schlüssel in Konfigurationsdatei	`ignore_actions`
Systemumgebungsschlüssel	`APPSIGNAL_IGNORE_ACTIONS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

Mit dieser Konfigurationsoption können Sie eine Liste von Actions 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 Actions zu ignorieren, die Sie nicht überwachen möchten. Lesen Sie mehr über das Ignorieren von Actions.

ignore_errors

Feld	Wert
Schlüssel in Konfigurationsdatei	`ignore_errors`
Systemumgebungsschlüssel	`APPSIGNAL_IGNORE_ERRORS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

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

ignore_logs

Feld	Wert
Schlüssel in Konfigurationsdatei	`ignore_logs`
Systemumgebungsschlüssel	`APPSIGNAL_IGNORE_LOGS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`2.10.0`

Beschreibung

Liste der Log-Nachrichten, die ignoriert werden. Jede Log-Nachricht, die eines der Listenelemente enthält, wird nicht an AppSignal übertragen. Eine kleine Teilmenge der Regex-Syntax wird unterstützt; weitere Informationen finden Sie in unserer Anleitung Logs ignorieren.

ignore_namespaces

Feld	Wert
Schlüssel in Konfigurationsdatei	`ignore_namespaces`
Systemumgebungsschlüssel	`APPSIGNAL_IGNORE_NAMESPACES`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`1.3.0`

Beschreibung

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

instrument_absinthe

Feld	Wert
Schlüssel in Konfigurationsdatei	`instrument_absinthe`
Systemumgebungsschlüssel	`APPSIGNAL_INSTRUMENT_ABSINTHE`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`2.7.0`

Beschreibung

Ob Telemetry-Ereignisse für die Absinthe-Paket-Integration automatisch instrumentiert werden sollen; kann true oder false sein.

instrument_ecto

Feld	Wert
Schlüssel in Konfigurationsdatei	`instrument_ecto`
Systemumgebungsschlüssel	`APPSIGNAL_INSTRUMENT_ECTO`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`2.5.1`

Beschreibung

Ob Telemetry-Ereignisse für die Ecto-Paket-Integration automatisch instrumentiert werden sollen; kann true oder false sein.

instrument_finch

Feld	Wert
Schlüssel in Konfigurationsdatei	`instrument_finch`
Systemumgebungsschlüssel	`APPSIGNAL_INSTRUMENT_FINCH`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`2.5.1`

Beschreibung

Ob Telemetry-Ereignisse für die Finch-Paket-Integration automatisch instrumentiert werden sollen; kann true oder false sein.

instrument_oban

Feld	Wert
Schlüssel in Konfigurationsdatei	`instrument_oban`
Systemumgebungsschlüssel	`APPSIGNAL_INSTRUMENT_OBAN`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`2.5.1`

Beschreibung

Ob Telemetry-Ereignisse für die Oban-Paket-Integration automatisch instrumentiert werden sollen; kann true oder false sein.

instrument_tesla

Feld	Wert
Konfigurationsdatei-Schlüssel	`instrument_tesla`
Systemumgebungsschlüssel	`APPSIGNAL_INSTRUMENT_TESLA`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`2.7.3`

Beschreibung

Legt fest, ob Telemetry-Ereignisse für die Tesla-Paketintegration automatisch instrumentiert werden sollen. Kann true oder false sein.

log

Feld	Wert
Konfigurationsdatei-Schlüssel	`log`
Systemumgebungsschlüssel	`APPSIGNAL_LOG`
Erforderlich	nein
Typ	`Atom`
Standardwert	`:file`

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. Zulässige 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 im STDOUT des übergeordneten Prozesses aus, anstatt sie in eine Datei zu schreiben. Nützlich bei Hosting-Lösungen wie Containersystemen und Heroku.

log_level

Feld	Wert
Konfigurationsdatei-Schlüssel	`log_level`
Systemumgebungsschlüssel	`APPSIGNAL_LOG_LEVEL`
Erforderlich	nein
Typ	`String`
Standardwert	`info`
Verfügbar seit Version	`2.2.8`

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 Fehler-, Warn- und Info-Nachrichten, aber keine Debug-Nachrichten. Die Stufen „debug” oder „trace” werden normalerweise nur auf Anfrage des Supports benötigt. Die Einstellung auf „debug”/„trace” kann sich geringfügig auf den Speicherplatzverbrauch und die IO auswirken, insbesondere auf Websites mit hohem Traffic. Der CPU-Overhead ist mit aktivierter Debug-Option minimal. Zulässige Werte:

error
warning
info
debug
trace

log_path

Feld	Wert
Konfigurationsdatei-Schlüssel	`log_path`
Systemumgebungsschlüssel	`APPSIGNAL_LOG_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	`/tmp`
Verfügbar seit Version	`1.0.0`
	`1.9.0`: Der Standard-Logpfad wurde von `/tmp/appsignal/` auf `/tmp/` geändert.

Beschreibung

Diese Option konfiguriert den Speicherort der internen Logdatei von AppSignal und beeinflusst die Logging-Funktion nicht.
Hinweis: Der angegebene Pfad darf keine betriebssystemspezifischen Dateisystem- Abstraktionen enthalten, wie etwa das Homedir-Symbol ~ für *NIX-Systeme. Dies würde als fehlerhafter Pfad angesehen werden.

Überschreibt den Speicherort des Pfads (Verzeichnis), in den die Datei appsignal.log geschrieben werden kann.

nginx_port

Feld	Wert
Konfigurationsdatei-Schlüssel	`nginx_port`
Systemumgebungsschlüssel	`APPSIGNAL_NGINX_PORT`
Erforderlich	nein
Typ	`Integer`
Standardwert	`27649`
Verfügbar seit Version	`2.15.8`

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

report_oban_errors

Feld	Wert
Konfigurationsdatei-Schlüssel	`report_oban_errors`
Systemumgebungsschlüssel	`APPSIGNAL_REPORT_OBAN_ERRORS`
Erforderlich	nein
Typ	`String`
Standardwert	`all`
Verfügbar seit Version	`2.5.1`

Beschreibung

Wann Fehler gemeldet werden sollen, die vom Exception-Event-Handler der Oban-Paketintegration während der Verarbeitung eines Jobs empfangen werden. Mögliche Werte sind:

all: Meldet alle Fehler für jede Ausführung von Jobs, einschließlich Wiederholungsversuchen.
discard: Meldet Fehler, wenn der Job aufgrund des Fehlers verworfen wird. Verwenden Sie diese Option, um Fehler nur dann zu melden, wenn alle Job-Wiederholungsversuche aufgebraucht sind.
none: Meldet keine Fehler für Jobs, einschließlich Wiederholungsversuchen.

request_headers

Feld	Wert
Konfigurationsdatei-Schlüssel	`request_headers`
Systemumgebungsschlüssel	`APPSIGNAL_REQUEST_HEADERS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "path-info", "range", "request-method", "request-uri", "server-name", "server-port", "server-protocol"]`
Verfügbar seit Version	`1.6.0`
	Ein Upgrade auf `1.6.3` oder höher wird empfohlen.

Beschreibung

Die Konfigurationsoption request_headers enthält eine Liste von HTTP-Request-Headern, die vom AppSignal-Elixir-Paket gelesen und gespeichert werden. Diese Konfigurationsoption request_headers ist eine Allowlist, was bedeutet, dass nur die in dieser Konfigurationsoption angegebenen Header übernommen werden. Wenn diese Konfigurationsoption nicht gesetzt ist, wird der AppSignal-Standard verwendet. Die folgende Liste ist der Standard des AppSignal-Pakets.

Elixir

# config/appsignal.exs
config :appsignal, :config,
  request_headers: ~w(
    accept accept-charset accept-encoding accept-language cache-control
    connection content-length path-info range request-method
    request-uri server-name server-port server-protocol
  )

Um AppSignal so zu konfigurieren, dass keine HTTP-Request-Header in AppSignal-Transaktionen gespeichert werden, konfigurieren Sie die Option mit einer leeren Liste.

Elixir

# config/appsignal.exs
config :appsignal, :config,
  request_headers: []

revision

Feld	Wert
Konfigurationsdatei-Schlüssel	`revision`
Systemumgebungsschlüssel	`APP_REVISION`
Erforderlich	nein
Typ	`String`
Standardwert	nil (Standardmäßig nicht gesetzt)
Verfügbar seit Version	`1.5.0`
	`1.10.12`: Automatische Erkennung für Heroku-Deploys mit aktivierter Dyno-Metadata-Labs-Funktion. `2.7.6`: Automatische Erkennung für Render-Deploys. `3.4.7`: Automatische Erkennung für Kamal-Deploys.

Beschreibung

Setzen Sie die App-Revision, um die aktuell laufende Version Ihrer App 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 wenn sie auf Heroku bereitgestellt wird und die Funktion Heroku Labs: Dyno Metadata aktiviert ist, erkennt die AppSignal-Integration automatisch den Git-Commit des aktuellen Deployments und verwendet ihn 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. Lesen Sie mehr über Deploy-Marker im Thema Deploy-Marker.

running_in_container

Feld	Wert
Konfigurationsdatei-Schlüssel	`running_in_container`
Systemumgebungsschlüssel	`APPSIGNAL_RUNNING_IN_CONTAINER`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	vom Agent erkannt

Beschreibung

AppSignal erwartet, dass es zwischen verschiedenen Deploys auf demselben Rechner ausgeführt wird. Setzen Sie diesen Schlüssel auf true, wenn die Anwendung in einem Container läuft, z. B. 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`
Systemumgebungsschlüssel	`APPSIGNAL_SEND_ENVIRONMENT_METADATA`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`2.2.8`

Beschreibung

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

send_params

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_params`
Systemumgebungsschlüssel	`APPSIGNAL_SEND_PARAMS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`1.10.0`

Beschreibung

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

send_session_data

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_session_data`
Systemumgebungsschlüssel	`APPSIGNAL_SEND_SESSION_DATA`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`2.2.10`

Beschreibung

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

skip_session_data

Feld	Wert
Konfigurationsdatei-Schlüssel	`skip_session_data`
Systemumgebungsschlüssel	`APPSIGNAL_SKIP_SESSION_DATA`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`

Beschreibung

Warnung: Diese Konfigurationsoption ist im Elixir-Paket 2.2.10 veraltet. Verwenden Sie stattdessen die Option send_session_data für neuere Versionen des Elixir-Pakets.

statsd_port

Feld	Wert
Konfigurationsdatei-Schlüssel	`statsd_port`
Systemumgebungsschlüssel	`APPSIGNAL_STATSD_PORT`
Erforderlich	nein
Typ	`Integer`
Standardwert	`8125`
Verfügbar seit Version	`2.7.2`

Beschreibung

Setzen Sie diese Option, um den StatsD-HTTP-Server-Port des AppSignal-Agent-Prozesses zu konfigurieren. Konfigurieren Sie diesen Port, wenn auf dem Rechner 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`
Systemumgebungsschlüssel	`APPSIGNAL_TRANSACTION_DEBUG_MODE`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar seit Version	`1.11.4`
	Seit Version 2.2.9 zugunsten der Konfigurationsoption `log_level` veraltet.

Beschreibung

Warnung: Diese Konfigurationsoption ist im Elixir-Paket 2.2.9 veraltet. Verwenden Sie stattdessen die Option log_level für Elixir-Paket 2.2.9 und neuer.

Aktiviert den Transaktions-Debug-Modus. Dies aktiviert eine sehr detaillierte Protokollierung von Transaktionen und Ereignissen, was nützlich ist, wenn Integrationen entwickelt werden oder wenn Ereignisse nicht wie erwartet erfasst werden. Das Log wird nur geschrieben, wenn auch die allgemeine debug-Option aktiviert ist.

Diese Option legt die Schweregradstufe des internen Loggers von AppSignal fest und beeinflusst die Logging-Funktion nicht.

working_dir_path

Feld	Wert
Konfigurationsdatei-Schlüssel	`working_dir_path`
Systemumgebungsschlüssel	`APPSIGNAL_WORKING_DIR_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	vom Agent erkannt
Verfügbar seit Version	`1.8.0`

Beschreibung

Warnung: Diese Konfigurationsoption ist im Elixir-Paket 1.8.0 veraltet. Verwenden Sie stattdessen die Option working_directory_path für Elixir-Paket 1.8.0 und neuer.

Überschreibt den Speicherort, an dem AppSignal für Elixir temporäre Dateien ablegen kann. Verwenden Sie diese Option, wenn der Standardspeicherort 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, andernfalls könnten die beiden Instanzen miteinander in Konflikt geraten. Weitere Informationen zu diesem Szenario finden Sie in unserer Dokumentation zum Ausführen mehrerer Anwendungen auf einem Host.

Elixir

# config/config.exs
config :appsignal, :config,
  working_dir_path: "/tmp/project_1/"

Hinweis: Der angegebene Pfad darf keine betriebssystemspezifischen Dateisystem- Abstraktionen enthalten, wie etwa das Homedir-Symbol ~ für *NIX-Systeme. Dies würde als fehlerhafter Pfad angesehen werden.

working_directory_path

Feld	Wert
Konfigurationsdatei-Schlüssel	`working_directory_path`
Systemumgebungsschlüssel	`APPSIGNAL_WORKING_DIRECTORY_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	vom Agent erkannt
Verfügbar seit Version	`1.8.0`
	Verwenden Sie in früheren Versionen die Option `working_dir_path`.

Beschreibung

Elixir

# config/appsignal.exs
config :appsignal, :config,
  working_directory_path: "/tmp/project_1/"

​Verfügbare Optionen

​active

​Beschreibung

​env

​Beschreibung

​name

​Beschreibung

​otp_app

​Beschreibung

​push_api_key

​Beschreibung

​bind_address

​Beschreibung

​ca_file_path

​Beschreibung

​cpu_count

​Beschreibung

​debug

​Beschreibung

​dns_servers

​Beschreibung

​ecto_repos

​Beschreibung

​enable_error_backend

​Beschreibung

​enable_host_metrics

​Beschreibung

​enable_minutely_probes

​Beschreibung

​enable_nginx_metrics

​Beschreibung

​enable_statsd

​Beschreibung

​endpoint

​Beschreibung

​files_world_accessible

​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_absinthe

​Beschreibung

​instrument_ecto

​Beschreibung

​instrument_finch

​Beschreibung

​instrument_oban

​Beschreibung

​instrument_tesla

​Beschreibung

​log

​Beschreibung

​log_level

​Beschreibung

​log_path

​Beschreibung

​nginx_port

​Beschreibung

​report_oban_errors

​Beschreibung

​request_headers

​Beschreibung

​revision

​Beschreibung

​running_in_container

Verfügbare Optionen

active

Beschreibung

env

Beschreibung

name

Beschreibung

otp_app

Beschreibung

push_api_key

Beschreibung

bind_address

Beschreibung

ca_file_path

Beschreibung

cpu_count

Beschreibung

debug

Beschreibung

dns_servers

Beschreibung

ecto_repos

Beschreibung

enable_error_backend

Beschreibung

enable_host_metrics

Beschreibung

enable_minutely_probes

Beschreibung

enable_nginx_metrics

Beschreibung

enable_statsd

Beschreibung

endpoint

Beschreibung

files_world_accessible

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_absinthe

Beschreibung

instrument_ecto

Beschreibung

instrument_finch

Beschreibung

instrument_oban

Beschreibung

instrument_tesla

Beschreibung

log

Beschreibung

log_level

Beschreibung

log_path

Beschreibung

nginx_port

Beschreibung

report_oban_errors

Beschreibung

request_headers

Beschreibung

revision

Beschreibung

running_in_container