Node.js-Paket Konfigurationsoptionen - 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
Schlüssel in Konfigurationsdatei	`active`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_ACTIVE`
Erforderlich	ja
Typ	Boolean (`true` / `false`)
Standardwert	`false`

Beschreibung

Konfigurieren Sie, ob AppSignal für eine bestimmte Umgebung aktiv sein soll oder nicht. Wird am häufigsten in der Datei-Konfiguration pro Umgebung verwendet.

environment

Feld	Wert
Schlüssel in Konfigurationsdatei	`environment`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_APP_ENV`
Erforderlich	ja
Typ	`String`
Standardwert	`Wird aus der Umgebungsvariable` NODE_ENV `gelesen, Standardwert "development".`

Beschreibung

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

Hinweis: Das Ändern des Namens oder der Umgebung einer bestehenden App erzeugt eine neue App auf AppSignal.com.

name

Feld	Wert
Konfigurationsdatei-Schlüssel	`name`
Systemumgebungs-Schlüssel	`APPSIGNAL_APP_NAME`
Erforderlich	ja
Typ	`String`
Standardwert	`nil`

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.

pushApiKey

Feld	Wert
Konfigurationsdatei-Schlüssel	`pushApiKey`
Systemumgebungs-Schlüssel	`APPSIGNAL_PUSH_API_KEY`
Erforderlich	ja
Typ	`String`
Standardwert	`null` (standardmäßig nicht gesetzt)
Verfügbar seit Version	`2.2.5`
	Diese Konfigurationsoption wurde in Version 2.2.5 von `apiKey` umbenannt.

Beschreibung

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

additionalInstrumentations

Feld	Wert
Schlüssel in Konfigurationsdatei	`additionalInstrumentations`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar ab Version	`3.0.0`

Beschreibung

Liste zusätzlicher OpenTelemetry-Instrumentierungen, die mit AppSignal verwendet werden sollen – über Drittanbieter-Bibliotheken oder eigene Integrationen.

bindAddress

Feld	Wert
Schlüssel in Konfigurationsdatei	`bindAddress`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_BIND_ADDRESS`
Erforderlich	nein
Typ	`String`
Standardwert	`127.0.0.1`
Verfügbar ab Version	`3.0.15`

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 an diese Adresse hören soll. Setzen Sie diese Option auf 0.0.0.0, um Anfragen von Hosts mit beliebiger IP-Adresse zuzulassen. Standardmäßig lauscht er nur auf Anfragen, die auf demselben Host gestellt werden. Diese Option wird auf alle Server des Agents angewendet (StatsD, OpenTelemetry und NGINX).

caFilePath

Feld	Wert
Schlüssel in Konfigurationsdatei	`caFilePath`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_CA_FILE_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	Pfad zur mitgelieferten Datei `cacert.pem`.

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, etwa das Homedir-Symbol ~ bei *NIX-Systemen. Dies wird als fehlerhafter Pfad erkannt.

cpuCount

Feld	Wert
Schlüssel in Konfigurationsdatei	`cpuCount`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_CPU_COUNT`
Erforderlich	nein
Typ	`Float`
Standardwert	`undefined`
Verfügbar ab Version	`3.3.2`

Beschreibung

Die verfügbare CPU-Kapazität des Hosts, in Anzahl der CPUs. Dies wird verwendet, um den prozentualen CPU-Verbrauch in den Host-Metriken zu berechnen. Wenn nicht gesetzt, versucht der Agent, diesen Wert automatisch aus cgroups zu ermitteln. Die Anzahl der CPUs kann ein Bruchwert sein, z. B. 0.5.

debug

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

Beschreibung

Warnung: Diese Konfigurationsoption ist im Node.js-Paket 2.2.6 veraltet. Verwenden Sie stattdessen die Option logLevel für das Node.js-Paket 2.2.6 und neuer.

Aktiviert die Debug-Protokollierung; dies ist in der Regel nur auf Anfrage des Supports erforderlich. Mit aktivierter Option protokolliert AppSignal deutlich mehr Informationen über Entscheidungen, die während der Metrik-Erfassung getroffen werden, und über das Senden von Daten an die Server von AppSignal.com. Das Aktivieren der Debug-Protokollierung kann eine leichte Auswirkung auf die Festplattennutzung und I/O haben, insbesondere bei stark frequentierten Websites. Der CPU-Overhead ist mit aktivierter Debug-Option minimal.

Diese Option legt den Schweregrad des internen Loggers von AppSignal fest. Diese Konfigurationsoption beeinflusst nicht die Logging-Funktion.

disableDefaultInstrumentations

Feld	Wert
Schlüssel in Konfigurationsdatei	`disableDefaultInstrumentations`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_DISABLE_DEFAULT_INSTRUMENTATIONS`
Erforderlich	nein
Typ	`list(String)` oder Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar ab Version	`3.0.0`

Beschreibung

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

@appsignal/opentelemetry-instrumentation-bullmq
@opentelemetry/instrumentation-amqplib
@opentelemetry/instrumentation-express
@opentelemetry/instrumentation-fastify
@opentelemetry/instrumentation-graphql
@opentelemetry/instrumentation-http
@opentelemetry/instrumentation-ioredis
@opentelemetry/instrumentation-knex
@opentelemetry/instrumentation-koa
@opentelemetry/instrumentation-mongodb
@opentelemetry/instrumentation-mongoose
@opentelemetry/instrumentation-mysql2
@opentelemetry/instrumentation-mysql
@opentelemetry/instrumentation-nestjs-core
@opentelemetry/instrumentation-pg
@opentelemetry/instrumentation-redis
@opentelemetry/instrumentation-redis-4
@opentelemetry/instrumentation-restify
@opentelemetry/instrumentation-undici
@prisma/instrumentation

Um alle Instrumentierungen zu deaktivieren, setzen Sie den Wert auf true.

dnsServers

Feld	Wert
Schlüssel in Konfigurationsdatei	`dnsServers`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_DNS_SERVERS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

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

Shell

# In the host environment
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, dessen Name nicht mehr als 4 Punkte enthält.

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.

enableHostMetrics

Feld	Wert
Schlüssel in Konfigurationsdatei	`enableHostMetrics`
Schlüssel der Systemumgebungsvariable	`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 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.

enableMinutelyProbes

Feld	Wert
Schlüssel in Konfigurationsdatei	`enableMinutelyProbes`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_ENABLE_MINUTELY_PROBES`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar ab Version	`0.4.0`
	`2.3.0`: Unterstützung für die Umgebungsvariablen-Option hinzugefügt. `2.3.0`: Deaktiviert das System der minütlichen Probes, sodass keine Metriken mehr gemeldet werden. Vor Version `2.3.0` wurden lediglich die Standard-Probes abgemeldet.

Beschreibung

Aktiviert das System der minütlichen Probes.

enableNginxMetrics

Feld	Wert
Schlüssel in Konfigurationsdatei	`enableNginxMetrics`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_ENABLE_NGINX_METRICS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar ab Version	`3.0.8`

Beschreibung

Setzen Sie diese Option auf true, um den NGINX-Metrik-Server zu aktivieren. Details finden Sie in der NGINX-Metriken-Dokumentation. 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 davon aktiviert werden.

enableOpentelemetryHttp

Feld	Wert
Schlüssel in Konfigurationsdatei	`enableOpentelemetryHttp`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_ENABLE_OPENTELEMETRY_HTTP`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar ab Version	`3.1.0`

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 davon aktiviert werden. Dies ist erforderlich für Apps, die den OpenTelemetry-HTTP-Exporter verwenden, um Daten an AppSignal zu melden.

enableStatsd

Feld	Wert
Schlüssel in Konfigurationsdatei	`enableStatsd`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_ENABLE_STATSD`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`
Verfügbar ab Version	`2.2.2`

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 mit AppSignal instrumentierte Anwendungen auf demselben Server ausführen, kann diese Konfigurationsoption nur in einer davon aktiviert werden.

filesWorldAccessible

Feld	Wert
Schlüssel in Konfigurationsdatei	`filesWorldAccessible`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_FILES_WORLD_ACCESSIBLE`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar ab Version	`2.2.4`

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 verschiedenen Benutzern laufen. Setzen Sie es auf false, um dieses Verhalten zu deaktivieren (Unix-Berechtigungen 0644).

filterParameters

Feld	Wert
Schlüssel in Konfigurationsdatei	`filterParameters`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_FILTER_PARAMETERS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar ab Version	`2.2.5`

Beschreibung

Liste von Parameterschlüsseln, die durch die AppSignal-Filterung ignoriert werden sollen. Ihre Werte werden beim Übertragen an AppSignal durch [FILTERED] ersetzt. Lesen Sie mehr über Parameterfilterung.

filterSessionData

Feld	Wert
Schlüssel in Konfigurationsdatei	`filterSessionData`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_FILTER_SESSION_DATA`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar ab Version	`2.2.5`

Beschreibung

Liste von Sitzungsdaten-Schlüsseln, die durch die AppSignal-Filterung ignoriert werden sollen. Ihre Werte werden beim Übertragen an AppSignal durch [FILTERED] ersetzt. Lesen Sie mehr über Filterung von Sitzungsdaten.

hostname

Feld	Wert
Schlüssel in Konfigurationsdatei	`hostname`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_HOSTNAME`
Erforderlich	nein
Typ	`String`
Standardwert	vom 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.

hostRole

Feld	Wert
Schlüssel in Konfigurationsdatei	`hostRole`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_HOST_ROLE`
Erforderlich	nein
Typ	`String`
Standardwert	`null` (standardmäßig nicht gesetzt)
Verfügbar ab Version	`3.0.19`

Beschreibung

Gruppieren Sie Hosts nach Rolle und erzeugen Sie auf dieser Rolle basierende Metriken. Eine solche Metrik ist die Zähler-Metrik reporting_hosts. Eine gute Rolle gibt an, was die Hauptaufgabe des Servers ist, etwa “webserver”, “processor”, “api”, “database”, “loadbalancer” usw.

httpProxy

Feld	Wert
Schlüssel in Konfigurationsdatei	`httpProxy`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_HTTP_PROXY`
Erforderlich	nein
Typ	`String`
Standardwert	`null` (standardmäßig nicht gesetzt)

Beschreibung

Wenn der Agent eine Verbindung zum Internet über einen Proxy benötigt, setzen Sie die vollständige Proxy-URL in diesem Konfigurationsschlüssel.

ignoreActions

Feld	Wert
Schlüssel in Konfigurationsdatei	`ignoreActions`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_IGNORE_ACTIONS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

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

ignoreErrors

Feld	Wert
Schlüssel in Konfigurationsdatei	`ignoreErrors`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_IGNORE_ERRORS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

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

ignoreLogs

Feld	Wert
Schlüssel in Konfigurationsdatei	`ignoreLogs`
Schlüssel der Systemumgebungsvariable	`APPSIGNAL_IGNORE_LOGS`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`
Verfügbar ab Version	`3.4.0`

Beschreibung

Liste von Protokollnachrichten, die ignoriert werden. Jede Protokollnachricht, die eines der Elemente der Liste enthält, wird nicht an AppSignal übertragen. Eine kleine Untermenge der Regex-Syntax wird unterstützt; lesen Sie mehr dazu in unserem Leitfaden Protokolle ignorieren.

ignoreNamespaces

Feld	Wert
Konfigurationsdatei-Schlüssel	`ignoreNamespaces`
Systemumgebungs-Schlüssel	`APPSIGNAL_IGNORE_NAMESPACES`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

Liste der Namespaces, die ignoriert werden. Fehler oder langsame Anfragen, die in diesem Namespace auftreten, werden nicht an AppSignal gesendet. Erfahren Sie mehr über Namespaces.

log

Feld	Wert
Konfigurationsdatei-Schlüssel	`log`
Systemumgebungs-Schlüssel	`APPSIGNAL_LOG`
Erforderlich	nein
Typ	`String`
Standardwert	`file`

Beschreibung

Diese Option konfiguriert, welchen Logger die interne Logging-Funktionalität von AppSignal verwendet, und beeinflusst nicht das Logging-Feature.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 Konfigurationsoption 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 sie in eine Datei zu schreiben. Nützlich bei Hosting-Lösungen wie Container-Systemen und Heroku.

logLevel

Feld	Wert
Konfigurationsdatei-Schlüssel	`logLevel`
Systemumgebungs-Schlüssel	`APPSIGNAL_LOG_LEVEL`
Erforderlich	nein
Typ	`String`
Standardwert	`info`
Verfügbar seit Version	`2.2.6`

Beschreibung

Diese Option legt den Schweregrad des internen Loggers von AppSignal fest und beeinflusst nicht das Logging-Feature.

Legen Sie den Schweregrad des internen Loggers von AppSignal fest. Wenn er auf “info” konfiguriert ist, werden alle Fehler-, Warn- und Info-Meldungen protokolliert, jedoch keine Debug-Meldungen. Die Stufen “debug” oder “trace” werden in der Regel nur auf Anfrage des Supports benötigt. Das Setzen der Stufe auf “debug”/“trace” kann sich leicht auf die Festplattennutzung und die IO auswirken, insbesondere auf Sites mit hohem Datenverkehr. Der CPU-Overhead ist mit aktivierter Debug-Option minimal. Zulässige Werte:

error
warning
info
debug
trace

logPath

Feld	Wert
Konfigurationsdatei-Schlüssel	`logPath`
Systemumgebungs-Schlüssel	`APPSIGNAL_LOG_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	`/tmp`

Beschreibung

Diese Option konfiguriert den Speicherort der internen Logging-Datei von AppSignal und beeinflusst nicht das Logging-Feature.
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.

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

nginxPort

Feld	Wert
Konfigurationsdatei-Schlüssel	`nginxPort`
Systemumgebungs-Schlüssel	`APPSIGNAL_NGINX_PORT`
Erforderlich	nein
Typ	`Integer`
Standardwert	`27649`
Verfügbar seit Version	`3.6.7`

Beschreibung

Konfigurieren Sie den Port, an dem der NGINX-Metrik-Server bereitgestellt wird. Wenn AppSignal NGINX-Metriken empfängt, lauscht es standardmäßig auf einem an localhost gebundenen Server 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.

opentelemetry_port

Feld	Wert
Konfigurationsdatei-Schlüssel	`opentelemetry_port`
Systemumgebungs-Schlüssel	`APPSIGNAL_OPENTELEMETRY_PORT`
Erforderlich	nein
Typ	`String`
Standardwert	`8099`
Verfügbar seit Version	`3.1.0`

Beschreibung

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

requestHeaders

Feld	Wert
Konfigurationsdatei-Schlüssel	`requestHeaders`
Systemumgebungs-Schlü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	`2.2.5`

Beschreibung

Die Konfigurationsoption requestHeaders enthält eine Liste von HTTP-Anfrage-Headern, die vom AppSignal Node.js-Paket gelesen und gespeichert werden. Diese Konfigurationsoption requestHeaders ist eine Erlaubnisliste, was bedeutet, dass nur die in dieser Konfigurationsoption angegebenen Header verwendet werden. Wenn diese Konfigurationsoption nicht gesetzt ist, wird der AppSignal-Standard verwendet. Die folgende Liste ist der AppSignal-Paket-Standard.

Node.js

client = Appsignal.new(
  // ...Other config opts
  requestHeaders: [
    "accept",
    "accept-charset",
    "accept-encoding",
    "accept-language",
    "cache-control",
    "connection",
    "content-length",
    "range"
  ]
)

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

Node.js

client = Appsignal.new(
  // ...Other config opts
  requestHeaders: []
)

revision

Feld	Wert
Konfigurationsdatei-Schlüssel	`revision`
Systemumgebungs-Schlüssel	`APP_REVISION`
Erforderlich	nein
Typ	`String`
Standardwert	`null` (standardmäßig nicht gesetzt)
Verfügbar seit Version	`1.0.0`
	`3.0.16`: Automatische Erkennung für Render-Deploys. `3.4.4`: 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, auf Render bereitgestellt wird oder 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. Erfahren Sie mehr über Deploy-Marker im Deploy-Marker-Thema.

runningInContainer

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

Beschreibung

AppSignal erwartet, dass es zwischen verschiedenen Deploys auf derselben Maschine läuft. Setzen Sie diesen Schlüssel auf true, wenn die Anwendung in einem Container, zum Beispiel mit Docker, läuft. 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.

sendEnvironmentMetadata

Feld	Wert
Konfigurationsdatei-Schlüssel	`sendEnvironmentMetadata`
Systemumgebungs-Schlüssel	`APPSIGNAL_SEND_ENVIRONMENT_METADATA`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`2.2.6`

Beschreibung

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

sendParams

Feld	Wert
Konfigurationsdatei-Schlüssel	`sendParams`
Systemumgebungs-Schlüssel	`APPSIGNAL_SEND_PARAMS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`2.2.8`

Beschreibung

Ob das Senden von Anfrageparametern an AppSignal übersprungen werden soll. Weitere Informationen finden Sie unter send_params zum Filtern von Anfrageparametern.

sendSessionData

Feld	Wert
Konfigurationsdatei-Schlüssel	`sendSessionData`
Systemumgebungs-Schlüssel	`APPSIGNAL_SEND_SESSION_DATA`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`
Verfügbar seit Version	`2.2.9`

Beschreibung

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

statsdPort

Feld	Wert
Konfigurationsdatei-Schlüssel	`statsdPort`
Systemumgebungs-Schlüssel	`APPSIGNAL_STATSD_PORT`
Erforderlich	nein
Typ	`Integer`
Standardwert	`8125`
Verfügbar seit Version	`3.0.16`

Beschreibung

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

workingDirectoryPath

Feld	Wert
Konfigurationsdatei-Schlüssel	`workingDirectoryPath`
Systemumgebungs-Schlüssel	`APPSIGNAL_WORKING_DIRECTORY_PATH`
Erforderlich	nein
Typ	`String`
Standardwert	vom Agent erkannt
Verfügbar seit Version	`1.0.0`

Beschreibung

Überschreiben Sie den Speicherort, an dem AppSignal für Node.js 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 arbeitet. 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.

Node.js

// Example: appsignal.js
const { Appsignal } = require("@appsignal/nodejs");

const appsignal = new Appsignal({
  // Other config
  workingDirectoryPath: "/tmp/project_1"
});

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.

​Verfügbare Optionen

​active

​Beschreibung

​environment

​Beschreibung

​name

​Beschreibung

​pushApiKey

​Beschreibung

​additionalInstrumentations

​Beschreibung

​bindAddress

​Beschreibung

​caFilePath

​Beschreibung

​cpuCount

​Beschreibung

​debug

​Beschreibung

​disableDefaultInstrumentations

​Beschreibung

​dnsServers

​Beschreibung

​enableHostMetrics

​Beschreibung

​enableMinutelyProbes

​Beschreibung

​enableNginxMetrics

​Beschreibung

​enableOpentelemetryHttp

​Beschreibung

​enableStatsd

​Beschreibung

​filesWorldAccessible

​Beschreibung

​filterParameters

​Beschreibung

​filterSessionData

​Beschreibung

​hostname

​Beschreibung

​hostRole

​Beschreibung

​httpProxy

​Beschreibung

​ignoreActions

​Beschreibung

​ignoreErrors

​Beschreibung

​ignoreLogs

​Beschreibung

​ignoreNamespaces

​Beschreibung

​log

​Beschreibung

​logLevel

​Beschreibung

​logPath

​Beschreibung

​nginxPort

​Beschreibung

​opentelemetry_port

​Beschreibung

​requestHeaders

​Beschreibung

​revision

​Beschreibung

​runningInContainer

​Beschreibung

​sendEnvironmentMetadata

​Beschreibung

​sendParams

​Beschreibung

​sendSessionData

​Beschreibung

​statsdPort

​Beschreibung

​workingDirectoryPath

​Beschreibung

Verfügbare Optionen

active

Beschreibung

environment

Beschreibung

name

Beschreibung

pushApiKey

Beschreibung

additionalInstrumentations

Beschreibung

bindAddress

Beschreibung

caFilePath

Beschreibung

cpuCount

Beschreibung

debug

Beschreibung

disableDefaultInstrumentations

Beschreibung

dnsServers

Beschreibung

enableHostMetrics

Beschreibung

enableMinutelyProbes

Beschreibung

enableNginxMetrics

Beschreibung

enableOpentelemetryHttp

Beschreibung

enableStatsd

Beschreibung

filesWorldAccessible

Beschreibung

filterParameters

Beschreibung

filterSessionData

Beschreibung

hostname

Beschreibung

hostRole

Beschreibung

httpProxy

Beschreibung

ignoreActions

Beschreibung

ignoreErrors

Beschreibung

ignoreLogs

Beschreibung

ignoreNamespaces

Beschreibung

log

Beschreibung

logLevel

Beschreibung

logPath

Beschreibung

nginxPort

Beschreibung

opentelemetry_port

Beschreibung

requestHeaders

Beschreibung

revision

Beschreibung

runningInContainer

Beschreibung

sendEnvironmentMetadata

Beschreibung

sendParams

Beschreibung

sendSessionData

Beschreibung

statsdPort

Beschreibung

workingDirectoryPath

Beschreibung