Konfigurationsoptionen des Python-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 unserer Konfigurations-Dokumentation.

active

Feld	Wert
Konfigurationsdatei-Schlüssel	`active`
Systemumgebungs-Schlüssel	`APPSIGNAL_ACTIVE`
Erforderlich	ja
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar seit Version	`0.1.0`

Beschreibung

Konfigurieren Sie AppSignal so, dass es für eine bestimmte Umgebung aktiv ist oder nicht. Wenn AppSignal nicht aktiv ist, werden für die App in der angegebenen Umgebung keine Daten gemeldet.

environment

Feld	Wert
Konfigurationsdatei-Schlüssel	`environment`
System-Umgebungsschlüssel	`APPSIGNAL_APP_ENV`
Erforderlich	ja
Typ	`String`
Standardwert	`development`
Verfügbar seit Version	`0.1.0`

Beschreibung

Die Umgebung der App, die an AppSignal gemeldet werden soll.

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`
System-Umgebungsschlüssel	`APPSIGNAL_APP_NAME`
Erforderlich	ja
Typ	`String`
Standardwert	nil (Dies ist standardmäßig nicht gesetzt)
Verfügbar seit Version	`0.1.0`

Beschreibung

Name Ihrer Anwendung, wie er auf AppSignal.com angezeigt werden soll.

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

push_api_key

Feld	Wert
Konfigurationsdatei-Schlüssel	`push_api_key`
System-Umgebungsschlüssel	`APPSIGNAL_PUSH_API_KEY`
Erforderlich	ja
Typ	`String`
Standardwert	nil (Dies ist standardmäßig nicht gesetzt)
Verfügbar seit Version	`0.1.0`

Beschreibung

Der Authentifizierungsschlüssel auf Organisationsebene zur Authentifizierung bei unserer Push-API. Weitere Informationen finden Sie unter AppSignal Push-API-Schlüssel.

bind_address

Feld	Wert
Konfigurationsdatei-Schlüssel	`bind_address`
Systemumgebungs-Schlüssel	`APPSIGNAL_BIND_ADDRESS`
Erforderlich	nein
Typ	`String`
Standardwert	`127.0.0.1`
Verfügbar seit Version	`0.1.5`

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 gestellt werden. Diese Option wird auf alle Agent-Server angewendet (StatsD, OpenTelemetry und NGINX).

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

ca_file_path

Feld	Wert
Konfigurationsdatei-Schlüssel	`ca_file_path`
Systemumgebungs-Schlüssel	`APPSIGNAL_CA_FILE_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	Pfad der mitgelieferten Datei `cacert.pem`.
Verfügbar seit Version	`0.1.0`

Beschreibung

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 ~ für *NIX-Systeme. Dies wird als fehlerhafter Pfad angesehen.

Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keinen Einfluss darauf, wie die Integration mit dem externen Collector kommuniziert. Sie wird weiterhin für die Kommunikation mit den Servern von AppSignal verwendet.

collector_endpoint

Feld	Wert
Konfigurationsdatei-Schlüssel	`collector_endpoint`
Systemumgebungs-Schlüssel	`APPSIGNAL_COLLECTOR_ENDPOINT`
Erforderlich	nein
Typ	`String`
Standardwert	nil (Dies ist standardmäßig nicht gesetzt)
Verfügbar seit Version	`1.6.0`

Beschreibung

Die Adresse eines extern bereitgestellten AppSignal Collectors. Wenn gesetzt, wird der mit der Integration gebündelte AppSignal-Agent nicht verwendet, und OpenTelemetry-Daten werden stattdessen an den Collector unter dieser Adresse gesendet.

Dies ist eine experimentelle Konfigurationsoption. Die folgenden Funktionen stehen nicht zur Verfügung, wenn ein externer Collector verwendet wird:

Die folgende Funktion ist nur verfügbar, wenn ein externer Collector verwendet wird:

Logging

cpu_count

Feld	Wert
Konfigurationsdatei-Schlüssel	`cpu_count`
System-Umgebungsschlüssel	`APPSIGNAL_CPU_COUNT`
Erforderlich	nein
Typ	`Float`
Standardwert	`undefined`
Verfügbar seit Version	`1.2.0`

Beschreibung

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

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

disable_default_instrumentations

Feld	Wert
Konfigurationsdatei-Schlüssel	`disable_default_instrumentations`
System-Umgebungsschlüssel	`APPSIGNAL_DISABLE_DEFAULT_INSTRUMENTATIONS`
Erforderlich	nein
Typ	`list(String)` oder Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar seit Version	`0.1.0`

Beschreibung

Ermöglicht es Ihnen, die automatische Instrumentierung der Standardintegrationen zu deaktivieren:

aiopg
asyncpg
celery
django
flask
mysql
mysqlclient
psycopg
psycopg2
pymysql
redis
jinja2
requests
sqlalchemy
sqlite3
logging

Wenn Sie AppSignal für Python 1.5.4 oder älter verwenden, stellen Sie jedem dieser Namen opentelemetry.instrumentation. voran. Zum Beispiel würde jinja2 als opentelemetry.instrumentation.jinja2 angegeben werden.

Beachten Sie, dass Instrumentierungen nur aktiviert werden, wenn die entsprechende OpenTelemetry-Instrumentierungsbibliothek installiert ist. Um alle automatischen Instrumentierungen zu deaktivieren, setzen Sie den Wert auf True.

dns_servers

Feld	Wert
Konfigurationsdatei-Schlüssel	`dns_servers`
System-Umgebungsschlüssel	`APPSIGNAL_DNS_SERVERS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`0.1.0`

Beschreibung

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

Shell

# 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 eine Meldung in der Datei appsignal.log aus: A problem occurred while setting DNS servers.

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

enable_host_metrics

Feld	Wert
Konfigurationsdatei-Schlüssel	`enable_host_metrics`
System-Umgebungsschlüssel	`APPSIGNAL_ENABLE_HOST_METRICS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	“true `/ vom System erkannt`
Verfügbar seit Version	`0.1.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. Das liegt daran, dass diese Systeme aus den Containern heraus ungenaue Metriken melden würden. Die Erfassung von Host-Metriken kann auf diesen Systemen nicht aktiviert werden. Verwenden Sie für Heroku stattdessen den Heroku-Log-Drain.

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

enable_minutely_probes

Feld	Wert
Konfigurationsdatei-Schlüssel	`enable_minutely_probes`
System-Umgebungsschlüssel	`APPSIGNAL_ENABLE_MINUTELY_PROBES`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`1.2.0`

Beschreibung

Aktiviert das Minütliche-Probes-System.

enable_nginx_metrics

Feld	Wert
Konfigurationsdatei-Schlüssel	`enable_nginx_metrics`
System-Umgebungsschlüssel	`APPSIGNAL_ENABLE_NGINX_METRICS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar seit Version	`0.1.0`

Beschreibung

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

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

enable_statsd

Feld	Wert
Konfigurationsdatei-Schlüssel	`enable_statsd`
System-Umgebungsschlüssel	`APPSIGNAL_ENABLE_STATSD`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar seit Version	`0.1.0`

Beschreibung

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

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

endpoint

Feld	Wert
Konfigurationsdatei-Schlüssel	`endpoint`
System-Umgebungsschlüssel	`APPSIGNAL_PUSH_API_ENDPOINT`
Erforderlich	nein
Typ	`String`
Standardwert	`https://push.appsignal.com`
Verfügbar seit Version	`0.1.0`

Beschreibung

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

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

files_world_accessible

Feld	Wert
Konfigurationsdatei-Schlüssel	`files_world_accessible`
System-Umgebungsschlüssel	`APPSIGNAL_FILES_WORLD_ACCESSIBLE`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`0.1.0`

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, weil Prozesse derselben App unter einem anderen Benutzer laufen. Auf false setzen, um dieses Verhalten zu deaktivieren (Unix-Berechtigungen 0644).

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

filter_attributes

Feld	Wert
Konfigurationsdatei-Schlüssel	`filter_attributes`
System-Umgebungsschlüssel	`APPSIGNAL_FILTER_ATTRIBUTES`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`1.6.0`

Beschreibung

Liste von OpenTelemetry-Span-Attributen, die mit AppSignal gefiltert werden sollen. Übereinstimmende Werte werden durch [FILTERED] ersetzt. Weitere Informationen finden Sie unter Parameterfilterung.

Nur Collector: Diese Konfigurationsoption hat nur eine Wirkung, wenn Sie einen externen Collector verwenden.Siehe die Konfigurationsoption filter_parameters zum Filtern von Daten bei Verwendung des Agents.

filter_function_parameters

Feld	Wert
Konfigurationsdatei-Schlüssel	`filter_function_parameters`
System-Umgebungsschlüssel	`APPSIGNAL_FILTER_FUNCTION_PARAMETERS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`1.6.0`

Beschreibung

Liste von Funktionsparameter-Attributen, die mit AppSignal gefiltert werden sollen. Übereinstimmende Werte werden durch [FILTERED] ersetzt. Weitere Informationen finden Sie unter Parameterfilterung.

filter_parameters

Feld	Wert
Konfigurationsdatei-Schlüssel	`filter_parameters`
System-Umgebungsschlüssel	`APPSIGNAL_FILTER_PARAMETERS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`0.1.0`

Beschreibung

Liste von Parameterschlüsseln, die mithilfe der AppSignal-Filterung ignoriert werden sollen. Ihre Werte werden bei der Übertragung an AppSignal durch [FILTERED] ersetzt. Weitere Informationen finden Sie unter Parameterfilterung.

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Auswirkung.Sehen Sie sich die folgenden Konfigurationsoptionen zum Filtern von Parametern bei Verwendung eines externen Collectors an:

filter_attributes
filter_function_parameters
filter_request_payload
filter_request_query_parameters

filter_request_payload

Feld	Wert
Konfigurationsdatei-Schlüssel	`filter_request_payload`
System-Umgebungsschlüssel	`APPSIGNAL_FILTER_REQUEST_PAYLOAD`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`1.6.0`

Beschreibung

Liste von Request-Payload-Attributen, die mit AppSignal gefiltert werden sollen. Übereinstimmende Werte werden durch [FILTERED] ersetzt. Weitere Informationen finden Sie unter Parameterfilterung.

filter_request_query_parameters

Feld	Wert
Konfigurationsdatei-Schlüssel	`filter_request_query_parameters`
System-Umgebungsschlüssel	`APPSIGNAL_FILTER_REQUEST_QUERY_PARAMETERS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`1.6.0`

Beschreibung

Liste von Request-Query-Parameter-Attributen, die mit AppSignal gefiltert werden sollen. Übereinstimmende Werte werden durch [FILTERED] ersetzt. Weitere Informationen finden Sie unter Parameterfilterung.

filter_session_data

Feld	Wert
Konfigurationsdatei-Schlüssel	`filter_session_data`
System-Umgebungsschlüssel	`APPSIGNAL_FILTER_SESSION_DATA`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`0.1.0`

Beschreibung

Liste von Sitzungsdaten-Schlüsseln, die mithilfe der AppSignal-Filterung ignoriert werden sollen. Ihre Werte werden bei der Übertragung an AppSignal durch [FILTERED] ersetzt. Weitere Informationen finden Sie unter Sitzungsdatenfilterung.

host_role

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

Beschreibung

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

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

hostname

Feld	Wert
Konfigurationsdatei-Schlüssel	`hostname`
System-Umgebungsschlüssel	`APPSIGNAL_HOSTNAME`
Erforderlich	nein
Typ	`String`
Standardwert	vom System erkannt
Verfügbar seit Version	`0.1.0`

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
Konfigurationsdatei-Schlüssel	`http_proxy`
System-Umgebungsschlüssel	`APPSIGNAL_HTTP_PROXY`
Erforderlich	nein
Typ	`String`
Standardwert	nil (Dies ist standardmäßig nicht gesetzt)
Verfügbar seit Version	`0.1.0`

Beschreibung

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

ignore_actions

Feld	Wert
Konfigurationsdatei-Schlüssel	`ignore_actions`
System-Umgebungsschlüssel	`APPSIGNAL_IGNORE_ACTIONS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`0.1.0`

Beschreibung

Mit dieser Konfigurationsoption können Sie eine Liste von Aktionen angeben, die von AppSignal ignoriert werden. Alles, was passiert, einschließlich Ausnahmen, wird nicht an AppSignal übertragen. Dies kann nützlich sein, um Healthcheck-Endpunkte oder andere Aktionen zu ignorieren, die Sie nicht überwachen möchten. Weitere Informationen finden Sie unter Aktionen ignorieren.

ignore_errors

Feld	Wert
Konfigurationsdatei-Schlüssel	`ignore_errors`
System-Umgebungsschlüssel	`APPSIGNAL_IGNORE_ERRORS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`0.1.0`

Beschreibung

Liste von Fehlerklassen, die ignoriert werden. Jede mit dieser Fehlerklasse ausgelöste Ausnahme wird nicht an AppSignal übertragen. Weitere Informationen finden Sie unter Fehler ignorieren.

ignore_namespaces

Feld	Wert
Konfigurationsdatei-Schlüssel	`ignore_namespaces`
System-Umgebungsschlüssel	`APPSIGNAL_IGNORE_NAMESPACES`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`0.1.0`

Beschreibung

Liste von Namespaces, die ignoriert werden. Jeder ausgelöste Fehler oder jeder langsame Request, der in diesem Namespace auftritt, wird nicht an AppSignal gesendet. Weitere Informationen finden Sie unter Namespaces.

log

Feld	Wert
Konfigurationsdatei-Schlüssel	`log`
System-Umgebungsschlüssel	`APPSIGNAL_LOG`
Erforderlich	nein
Typ	`String`
Standardwert	`file`
Verfügbar seit Version	`0.1.0`

Beschreibung

Diese Option konfiguriert, welchen Logger die interne Logging-Funktionalität von AppSignal verwendet, und wirkt sich nicht auf die Logging-Funktion aus.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 verwenden wird. 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 übergeordneten Prozesses aus, anstatt in eine Datei zu schreiben. Nützlich bei Hosting-Lösungen wie Container-Systemen und Heroku.

Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keinen Einfluss darauf, wie der Collector Logs ausgibt. Die Integration befolgt diese Konfigurationsoption weiterhin beim Ausgeben von Logs.

log_level

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

Beschreibung

Diese Option legt den Schweregrad des internen Loggers von AppSignal fest und wirkt sich nicht auf die Logging-Funktion aus.

Legen Sie den Schweregrad des internen Loggers von AppSignal fest. Wenn er auf “info” konfiguriert ist, werden alle Fehler-, Warn- und Info-Meldungen protokolliert, aber keine Debug-Meldungen. Die Einstellung auf “debug” oder “trace” wird in der Regel nur auf Anfrage des Supports benötigt. Die Einstellung “debug”/“trace” kann sich geringfügig auf die Festplattennutzung und I/O auswirken, insbesondere auf Sites mit hohem Datenverkehr. Der CPU-Overhead ist mit aktivierter Debug-Option minimal. Akzeptierte Werte:

error
warning
info
debug
trace

log_path

Feld	Wert
Konfigurationsdatei-Schlüssel	`log_path`
System-Umgebungsschlüssel	`APPSIGNAL_LOG_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	`/tmp`
Verfügbar seit Version	`0.1.0`

Beschreibung

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

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

nginx_port

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

Beschreibung

Konfigurieren Sie den Port, auf dem der NGINX-Metrik-Server verfügbar gemacht 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.

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

opentelemetry_port

Feld	Wert
Konfigurationsdatei-Schlüssel	`opentelemetry_port`
System-Umgebungsschlüssel	`APPSIGNAL_OPENTELEMETRY_PORT`
Erforderlich	nein
Typ	`Integer`
Standardwert	`8099`
Verfügbar seit Version	`0.2.2`

Beschreibung

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

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Auswirkung. Der Port zum Senden von OpenTelemetry-Daten an den externen Collector kann als Teil der Konfigurationsoption collector_endpoint angegeben werden.

request_headers

Feld	Wert
Konfigurationsdatei-Schlüssel	`request_headers`
System-Umgebungsschlüssel	`APPSIGNAL_REQUEST_HEADERS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "range"]`
Verfügbar seit Version	`0.1.0`

Beschreibung

Die Konfigurationsoption request_headers enthält eine Liste von HTTP-Request-Headern, die vom AppSignal-Python-Paket gelesen und gespeichert werden. Diese Konfigurationsoption request_headers ist eine Allowlist, was bedeutet, dass nur Header berücksichtigt werden, die durch diese Konfigurationsoption angegeben sind. Wenn diese Konfigurationsoption nicht gesetzt ist, wird der AppSignal-Standard verwendet. Die folgende Liste ist der Standard des AppSignal-Pakets.

Python

# __appsignal__.py
appsignal = Appsignal(
  # ...Other config opts
  request_headers=[
    "accept",
    "accept-charset",
    "accept-encoding",
    "accept-language",
    "cache-control",
    "connection",
    "content-length",
    "range"
  ]
)

Um diese Liste anzupassen, fügen Sie die Konfigurationsoption mit allen Headern hinzu, die gemeldet werden sollen. Alle Header-Namen sollten in Kleinbuchstaben geschrieben werden. Wenn der Header-Name X-Custom-Header ist, fügen Sie ihn dieser Liste als x-custom-header hinzu. Um AppSignal so zu konfigurieren, dass keine HTTP-Request-Header auf AppSignal-Traces gespeichert werden, konfigurieren Sie die Option mit einer leeren Liste.

Python

# __appsignal__.py
appsignal = Appsignal(
  # ...Other config opts
  request_headers=[]
)

response_headers

Feld	Wert
Konfigurationsdatei-Schlüssel	`response_headers`
System-Umgebungsschlüssel	`APPSIGNAL_RESPONSE_HEADERS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar seit Version	`1.6.0`

Beschreibung

Die Konfigurationsoption response_headers enthält eine Liste von HTTP-Response-Headern, die vom AppSignal-für-Python-Paket gelesen und gespeichert werden. Diese Konfigurationsoption response_headers ist eine Allowlist, was bedeutet, dass nur Header berücksichtigt werden, die durch diese Konfigurationsoption angegeben sind. Wenn diese Konfigurationsoption nicht gesetzt ist, werden keine Response-Header gemeldet. Um diese Liste anzupassen, fügen Sie die Konfigurationsoption mit allen Headern hinzu, die gemeldet werden sollen. Alle Header-Namen sollten in Kleinbuchstaben geschrieben werden. Wenn der Header-Name X-Custom-Header ist, fügen Sie ihn dieser Liste als x-custom-header hinzu.

Nur Collector: Diese Konfigurationsoption hat nur eine Wirkung, wenn Sie einen externen Collector verwenden.

revision

Feld	Wert
Konfigurationsdatei-Schlüssel	`revision`
System-Umgebungsschlüssel	`APP_REVISION`
Erforderlich	nein
Typ	`String`
Standardwert	nil (Dies ist standardmäßig nicht gesetzt)
Verfügbar seit Version	`0.1.0`
	`0.2.0`: Automatische Erkennung für Render-Deploys. `1.3.3`: 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 kennzeichnet alle eingehenden Daten mit der aktuellen Revision. Wenn Ihre Anwendung mit Kamal bereitgestellt wird, oder wenn sie auf Render bereitgestellt wird, oder wenn sie auf Heroku bereitgestellt wird und das Feature 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. Weitere Informationen zu Deploy-Markern finden Sie im Thema Deploy-Marker.

Bei Verwendung eines externen Collectors wird die Revision nicht automatisch erkannt. Setzen Sie diese Option manuell, um die aktuell laufende Version Ihrer App zu melden.

running_in_container

Feld	Wert
Konfigurationsdatei-Schlüssel	`running_in_container`
System-Umgebungsschlüssel	`APPSIGNAL_RUNNING_IN_CONTAINER`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	vom Agent erkannt
Verfügbar seit Version	`0.1.0`

Beschreibung

AppSignal geht davon aus, dass es zwischen verschiedenen Deploys auf derselben Maschine läuft. 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. Auf Heroku wird diese Option automatisch auf true gesetzt.

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

send_environment_metadata

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_environment_metadata`
System-Umgebungsschlüssel	`APPSIGNAL_SEND_ENVIRONMENT_METADATA`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`0.1.0`

Beschreibung

Sendet Umgebungs-Metadaten über die App. Weitere Informationen finden Sie unter Umgebungs-Metadaten.

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

send_function_parameters

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_function_parameters`
System-Umgebungsschlüssel	`APPSIGNAL_SEND_FUNCTION_PARAMETERS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`1.6.0`

Beschreibung

Ob Funktionsparameter an AppSignal gesendet werden sollen.

Nur Collector: Diese Konfigurationsoption hat nur eine Wirkung, wenn Sie einen externen Collector verwenden.Siehe die Konfigurationsoption send_params zum Senden von Daten, wenn der Agent nicht verwendet wird.

send_params

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

Beschreibung

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.

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Auswirkung.Sehen Sie sich die folgenden Konfigurationsoptionen zum Senden von Parametern bei Verwendung eines externen Collectors an:

send_function_parameters
send_request_payload
send_request_query_parameters

send_request_payload

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_request_payload`
System-Umgebungsschlüssel	`APPSIGNAL_SEND_REQUEST_PAYLOAD`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`1.6.0`

Beschreibung

Ob das Request-Payload an AppSignal gesendet werden soll.

send_request_query_parameters

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_request_query_parameters`
System-Umgebungsschlüssel	`APPSIGNAL_SEND_REQUEST_QUERY_PARAMETERS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`1.6.0`

Beschreibung

Ob Request-Query-Parameter an AppSignal gesendet werden sollen.

send_session_data

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

Beschreibung

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

service_name

Feld	Wert
Konfigurationsdatei-Schlüssel	`service_name`
System-Umgebungsschlüssel	`APPSIGNAL_SERVICE_NAME`
Erforderlich	nein
Typ	`String`
Standardwert	“
Verfügbar seit Version	`1.6.0`

Beschreibung

Der Service-Name hilft AppSignal, verschiedene Services für Traces zu erkennen, und gruppiert die Traces automatisch in einem Namespace basierend auf dem Service-Namen. Wählen Sie einen Namen, der zu Ihrer Anwendung passt, wie “Web server”, “Background worker”, “Email service”, “Authentication service” usw.

Nur Collector: Diese Konfigurationsoption hat nur eine Wirkung, wenn Sie einen externen Collector verwenden.

statsd_port

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

Beschreibung

Setzen Sie diese Option, um den Port des StatsD-HTTP-Servers 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.

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

working_directory_path

Feld	Wert
Konfigurationsdatei-Schlüssel	`working_directory_path`
System-Umgebungsschlüssel	`APPSIGNAL_WORKING_DIRECTORY_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	vom Agent erkannt
Verfügbar seit Version	`0.1.0`

Beschreibung

Überschreiben Sie den Speicherort, an dem AppSignal für Python temporäre Dateien speichern 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, 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.

Python

# __appsignal__.py
appsignal = Appsignal(
  # Other config
  working_directory_path="/tmp/project_1"
)

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

Nur Agent: Bei Verwendung eines externen Collectors hat diese Konfigurationsoption keine Wirkung.

​Verfügbare Optionen

​active

​Beschreibung

​environment

​Beschreibung

​name

​Beschreibung

​push_api_key

​Beschreibung

​bind_address

​Beschreibung

​ca_file_path

​Beschreibung

​collector_endpoint

​Beschreibung

​cpu_count

​Beschreibung

​disable_default_instrumentations

​Beschreibung

​dns_servers

​Beschreibung

​enable_host_metrics

​Beschreibung

​enable_minutely_probes

​Beschreibung

​enable_nginx_metrics

​Beschreibung

​enable_statsd

​Beschreibung

​endpoint

​Beschreibung

​files_world_accessible

​Beschreibung

​filter_attributes

​Beschreibung

​filter_function_parameters

​Beschreibung

​filter_parameters

​Beschreibung

​filter_request_payload

​Beschreibung

​filter_request_query_parameters

​Beschreibung

​filter_session_data

​Beschreibung

​host_role

​Beschreibung

​hostname

​Beschreibung

​http_proxy

​Beschreibung

​ignore_actions

​Beschreibung

​ignore_errors

​Beschreibung

​ignore_namespaces

​Beschreibung

​log

​Beschreibung

​log_level

​Beschreibung

​log_path

​Beschreibung

​nginx_port

​Beschreibung

​opentelemetry_port

​Beschreibung

​request_headers

​Beschreibung

​response_headers

​Beschreibung

​revision

​Beschreibung

​running_in_container

​Beschreibung

​send_environment_metadata

​Beschreibung

​send_function_parameters

​Beschreibung

​send_params

Verfügbare Optionen

active

Beschreibung

environment

Beschreibung

name

Beschreibung

push_api_key

Beschreibung

bind_address

Beschreibung

ca_file_path

Beschreibung

collector_endpoint

Beschreibung

cpu_count

Beschreibung

disable_default_instrumentations

Beschreibung

dns_servers

Beschreibung

enable_host_metrics

Beschreibung

enable_minutely_probes

Beschreibung

enable_nginx_metrics

Beschreibung

enable_statsd

Beschreibung

endpoint

Beschreibung

files_world_accessible

Beschreibung

filter_attributes

Beschreibung

filter_function_parameters

Beschreibung

filter_parameters

Beschreibung

filter_request_payload

Beschreibung

filter_request_query_parameters

Beschreibung

filter_session_data

Beschreibung

host_role

Beschreibung

hostname

Beschreibung

http_proxy

Beschreibung

ignore_actions

Beschreibung

ignore_errors

Beschreibung

ignore_namespaces

Beschreibung

log

Beschreibung

log_level

Beschreibung

log_path

Beschreibung

nginx_port

Beschreibung

opentelemetry_port

Beschreibung

request_headers

Beschreibung

response_headers

Beschreibung

revision

Beschreibung

running_in_container

Beschreibung

send_environment_metadata

Beschreibung

send_function_parameters

Beschreibung

send_params