Konfigurationsoptionen für AppSignal für PHP

AppSignal für PHP lässt sich über die Datei config/appsignal.php oder über Umgebungsvariablen konfigurieren. Diese Seite listet alle verfügbaren Konfigurationsoptionen auf. Erfahren Sie mehr über die Konfigurationsladereihenfolge. Sobald Sie AppSignal konfiguriert haben, können Sie die aktuelle Konfiguration validieren:

Shell

vendor/bin/appsignal validate

collector_endpoint

Feld	Wert
Konfigurationsdatei-Schlüssel	`collector_endpoint`
Systemumgebungs-Schlüssel	`APPSIGNAL_COLLECTOR_ENDPOINT`
Erforderlich	ja
Typ	`String`
Standardwert	`null` (standardmäßig nicht gesetzt)

Beschreibung

Die URL des AppSignal-Collectors, an den Trace-, Metrik- und Log-Daten gesendet werden sollen. AppSignal zeigt diese URL an, wenn Sie eine neue Anwendung erstellen, und sie ist auch für bestehende Anwendungen verfügbar.

config/appsignal.php

return [
    'collector_endpoint' => $_ENV['APPSIGNAL_COLLECTOR_ENDPOINT'] ?? null,
    // ... other options
];

environment

Feld	Wert
Konfigurationsdatei-Schlüssel	`environment`
Systemumgebungs-Schlüssel	`APPSIGNAL_APP_ENV`
Erforderlich	ja
Typ	`String`
Standardwert	`null` (standardmäßig nicht gesetzt)

Beschreibung

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

config/appsignal.php

return [
    'environment' => $_ENV['APPSIGNAL_APP_ENV'] ?? 'production',
    // ... other options
];

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

name

Feld	Wert
Konfigurationsdatei-Schlüssel	`name`
Systemumgebungs-Schlüssel	`APPSIGNAL_APP_NAME`
Erforderlich	ja
Typ	`String`
Standardwert	`null` (standardmäßig nicht gesetzt)

Beschreibung

Der Anzeigename Ihrer Anwendung auf AppSignal.com.

config/appsignal.php

return [
    'name' => 'My App',
    // ... other options
];

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

push_api_key

Feld	Wert
Konfigurationsdatei-Schlüssel	`push_api_key`
Systemumgebungs-Schlüssel	`APPSIGNAL_PUSH_API_KEY`
Erforderlich	ja
Typ	`String`
Standardwert	`null` (standardmäßig nicht gesetzt)

Beschreibung

Der Schlüssel auf Organisationsebene, der zur Authentifizierung bei der Push API verwendet wird. Erfahren Sie mehr über den AppSignal Push API-Schlüssel.

config/appsignal.php

return [
    'push_api_key' => $_ENV['APPSIGNAL_PUSH_API_KEY'] ?? '00000000-0000-0000-0000-000000000000',
    // ... other options
];

active

Feld	Wert
Konfigurationsdatei-Schlüssel	`active`
Systemumgebungs-Schlüssel	`APPSIGNAL_ACTIVE`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`false`

Beschreibung

Konfigurieren Sie, ob AppSignal für eine bestimmte Umgebung aktiv ist. Wird am häufigsten in der Dateikonfiguration pro Umgebung verwendet.

app_path

Feld	Wert
Konfigurationsdatei-Schlüssel	`app_path`
Erforderlich	nein
Typ	`String`
Standardwert	aus dem Projekt-Root erkannt

Beschreibung

Der Speicherort der App im Dateisystem des Hosts. Hilft AppSignal dabei, Backtraces aufzuräumen, indem der absolute App-Pfad aus den Backtrace-Zeilen entfernt und nur die Pfade innerhalb des Projektverzeichnisses angezeigt werden. Dies ermöglicht unser Feature Backtrace-Links. Das AppSignal-Paket setzt diesen Wert automatisch basierend auf dem erkannten Projekt-Root. Falls die automatische Erkennung des App-Pfads nicht funktioniert, können Sie ihn überschreiben:

config/appsignal.php

return [
	'app_path' => '/var/www/html/your-app'
    // ... other options
];

filter_attributes

Feld	Wert
Konfigurationsdatei-Schlüssel	`filter_attributes`
Systemumgebungs-Schlüssel	`APPSIGNAL_FILTER_ATTRIBUTES`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`

Beschreibung

Die Konfigurationsoption filter_attributes ermöglicht es Ihnen, bestimmte Attribute davon auszuschließen, an AppSignal gemeldet zu werden. Dies kann nützlich sein, um sensible oder nicht relevante Informationen aus der Berichterstattung herauszufiltern. Wenn ein Attribut auf diese Weise herausgefiltert wird, erscheint es überhaupt nicht in der Oberfläche.

config/appsignal.php

return [
    'filter_attributes' => ['my.secret.attribute', 'some.opentelemetry.attribute'],
    // ... other options
];

filter_function_parameters

Feld	Wert
Konfigurationsdatei-Schlüssel	`filter_function_parameters`
Systemumgebungs-Schlüssel	`APPSIGNAL_FILTER_FUNCTION_PARAMETERS`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`

Beschreibung

Diese Konfigurationsoption ermöglicht es Ihnen, alle Funktionsparameter herauszufiltern, die im Span-Attribut appsignal.function.parameters gesetzt sind. AppSignal ersetzt die Werte für die in der Konfigurationsoption filter_function_parameters aufgeführten Schlüssel durch [FILTERED].

config/appsignal.php

return [
    'filter_function_parameters' => ['api_token', 'secret'],
    // ... other options
];

filter_request_payload

Feld	Wert
Konfigurationsdatei-Schlüssel	`filter_request_payload`
Systemumgebungs-Schlüssel	`APPSIGNAL_FILTER_REQUEST_PAYLOAD`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`

Beschreibung

Diese Konfigurationsoption ermöglicht es Ihnen, alle Request-Payload-Daten herauszufiltern, die im Span-Attribut appsignal.request.payload gesetzt sind. AppSignal ersetzt die Werte für die in der Konfigurationsoption filter_request_payload aufgeführten Schlüssel durch [FILTERED]. Erfahren Sie mehr über Filterung von Request-Query-Parametern.

config/appsignal.php

return [
    'filter_request_payload' => ['password', 'cvv'],
    // ... other options
];

filter_request_query_parameters

Feld	Wert
Konfigurationsdatei-Schlüssel	`filter_request_query_parameters`
Systemumgebungs-Schlüssel	`APPSIGNAL_FILTER_REQUEST_QUERY_PARAMETERS`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`

Beschreibung

Diese Konfigurationsoption ermöglicht es Ihnen, alle Request-Query-Parameter herauszufiltern, die im Span-Attribut appsignal.request.query_parameters gesetzt sind. AppSignal ersetzt die Werte für die in der Konfigurationsoption filter_request_query_parameters aufgeführten Schlüssel durch [FILTERED]. Erfahren Sie mehr über Filterung von Request-Query-Parametern.

config/appsignal.php

return [
    'filter_request_query_parameters' => ['password', 'cvv'],
    // ... other options
];

filter_request_session_data

Feld	Wert
Konfigurationsdatei-Schlüssel	`filter_request_session_data`
Systemumgebungs-Schlüssel	`APPSIGNAL_FILTER_REQUEST_SESSION_DATA`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`

Beschreibung

Die Konfigurationsoption filter_request_session_data ermöglicht es Ihnen, alle Request-Session-Daten herauszufiltern, die im Span-Attribut appsignal.request.session_data gesetzt sind. AppSignal ersetzt die Werte für die in der Konfigurationsoption filter_request_session_data aufgeführten Schlüssel durch [FILTERED]. Erfahren Sie mehr über Filterung von Request-Session-Daten.

config/appsignal.php

return [
    'filter_request_session_data' => ['password', 'cvv'],
    // ... other options
];

hostname

Feld	Wert
Konfigurationsdatei-Schlüssel	`hostname`
Systemumgebungs-Schlüssel	`APPSIGNAL_HOSTNAME`
Erforderlich	nein
Typ	`String`
Standardwert	vom System erkannt

Beschreibung

Hilft AppSignal dabei, verschiedene Hosts für Traces zu erkennen und sie automatisch mit dem Hostnamen zu kennzeichnen. Das AppSignal-Paket setzt diesen Wert automatisch mithilfe von gethostname().

ignore_actions

Feld	Wert
Konfigurationsdatei-Schlüssel	`ignore_actions`
Systemumgebungs-Schlüssel	`APPSIGNAL_IGNORE_ACTIONS`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`

Beschreibung

Mit dieser Konfigurationsoption können Sie eine Liste von Aktionen angeben, die von AppSignal ignoriert werden. Alles, was passiert, einschließlich Exceptions, wird nicht an AppSignal übertragen. Dies kann nützlich sein, um Health-Check-Endpunkte oder andere Aktionen zu ignorieren, die Sie nicht überwachen möchten. Erfahren Sie mehr über das Ignorieren von Aktionen.

config/appsignal.php

return [
    'ignore_actions' => ['GET /health_check', 'POST /ping'],
    // ... other options
];

ignore_errors

Feld	Wert
Konfigurationsdatei-Schlüssel	`ignore_errors`
Systemumgebungs-Schlüssel	`APPSIGNAL_IGNORE_ERRORS`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`

Beschreibung

Diese Konfigurationsoption ermöglicht es Ihnen, bestimmte Fehler davon auszuschließen, an AppSignal gemeldet zu werden. Dies kann nützlich sein, um erwartete Fehler oder Fehler, die nicht behoben werden können, zu ignorieren. Erfahren Sie mehr über das Ignorieren von Fehlern.

config/appsignal.php

return [
    'ignore_errors' => ['MyCustomError', 'ExpectedError'],
    // ... other options
];

ignore_logs

Feld	Wert
Konfigurationsdatei-Schlüssel	`ignore_logs`
Systemumgebungs-Schlüssel	`APPSIGNAL_IGNORE_LOGS`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`

Beschreibung

Liste der Log-Nachrichten, die ignoriert werden. Jede Log-Nachricht, die ein Element aus der Liste enthält, wird nicht an AppSignal übertragen. Eine kleine Teilmenge der Regex-Syntax wird unterstützt; lesen Sie mehr darüber in unserer Anleitung Logs ignorieren. Das erwartete Format ist eine kommagetrennte Liste von Werten.

config/appsignal.php

return [
	'ignore_logs' => ["^success", "OK"],
	// ... other options
];

ignore_namespaces

Feld	Wert
Konfigurationsdatei-Schlüssel	`ignore_namespaces`
Systemumgebungs-Schlüssel	`APPSIGNAL_IGNORE_NAMESPACES`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`[]`

Beschreibung

Diese Konfigurationsoption ermöglicht es Ihnen, bestimmte Namespaces davon auszuschließen, an AppSignal gemeldet zu werden. Dies kann nützlich sein, um bestimmte Teile Ihrer Anwendung von der Überwachung auszuschließen. Erfahren Sie mehr über Namespaces.

config/appsignal.php

return [
    'ignore_namespaces' => ['admin', 'secret'],
    // ... other options
];

request_headers

Feld	Wert
Konfigurationsdatei-Schlüssel	`request_headers`
Systemumgebungs-Schlüssel	`APPSIGNAL_REQUEST_HEADERS`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "host", "range"]`

Beschreibung

Konfigurieren Sie, welche Request-Header einbezogen werden, wenn eine Anfrage an einen HTTP-Server gestellt wird. Diese Option ist eine Erlaubnisliste. Sie schließt nur die Header ein, die konfiguriert sind. Wenn die Liste leer ist, werden keine Header einbezogen. AppSignal liest Request-Header aus der HTTP-Anfrage. Jeder Schlüssel ist ein normalisierter (kleingeschriebener) Header-Name.

config/appsignal.php

return [
	'request_headers' => ['accept-encoding', 'content-length', 'user-agent'],
	// ... other options
];

Um AppSignal so zu konfigurieren, dass keine HTTP-Request-Header gespeichert werden, setzen Sie den Konfigurationswert explizit auf ein leeres Array.

config/appsignal.php

return [
    'request_headers' => [],
	// ... other options
];

response_headers

Feld	Wert
Konfigurationsdatei-Schlüssel	`response_headers`
Systemumgebungs-Schlüssel	`APPSIGNAL_RESPONSE_HEADERS`
Erforderlich	nein
Typ	`Array<String>`
Standardwert	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "date", "range"]`

Beschreibung

Konfigurieren Sie, welche Response-Header einbezogen werden, wenn eine Anfrage von einem HTTP-Client gestellt wird. Diese Option ist eine Erlaubnisliste. Sie schließt nur die Header ein, die konfiguriert sind. Wenn das Array leer ist, werden keine Header einbezogen. Jeder Eintrag in diesem Array sollte ein normalisierter HTTP-Response-Header-Name (kleingeschrieben) sein.

config/appsignal.php

return [
    'response_headers' => ['accept', 'accept-charset', 'accept-encoding'],
	// ... other options
];

Um AppSignal so zu konfigurieren, dass keine HTTP-Response-Header gespeichert werden, setzen Sie den Konfigurationswert explizit auf ein leeres Array.

config/appsignal.php

return [
    'response_headers' => [],
	// ... other options
];

revision

Feld	Wert
Konfigurationsdatei-Schlüssel	`revision`
Systemumgebungs-Schlüssel	`APPSIGNAL_REVISION`
Erforderlich	nein
Typ	`String`
Standardwert	aus Git erkannt

Beschreibung

Die aktuell laufende Version Ihrer App. AppSignal erstellt einen Deploy-Marker, wenn sich dieser Wert ändert, und kennzeichnet alle eingehenden Daten mit der aktuellen Revision. Das AppSignal-Paket setzt diesen Wert automatisch mithilfe von git rev-parse HEAD. Erfahren Sie mehr über Deploy-Marker im Deploy-Marker-Thema.

send_function_parameters

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_function_parameters`
Systemumgebungs-Schlüssel	`APPSIGNAL_SEND_FUNCTION_PARAMETERS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`

Beschreibung

Konfigurieren Sie, ob Funktionsparameter in Traces einbezogen werden sollen. Wenn auf false gesetzt, werden keine solchen Daten an unsere Server gesendet. Diese Werte werden mit dem Span-Attribut appsignal.function.parameters gesetzt.

config/appsignal.php

return [
    'send_function_parameters' => false,
    // ... other options
];

send_request_payload

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_request_payload`
Systemumgebungs-Schlüssel	`APPSIGNAL_SEND_REQUEST_PAYLOAD`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`

Beschreibung

Konfigurieren Sie, ob Request-Payload-Daten in Traces gesendet werden sollen. Wenn auf false gesetzt, werden keine solchen Daten an unsere Server gesendet. Diese Werte werden mit dem Span-Attribut appsignal.request.payload gesetzt. Weitere Informationen finden Sie unter Filterung von Request-Payloads.

config/appsignal.php

return [
    'send_request_payload' => false,
    // ... other options
];

send_request_query_parameters

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_request_query_parameters`
Systemumgebungs-Schlüssel	`APPSIGNAL_SEND_REQUEST_QUERY_PARAMETERS`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`

Beschreibung

Konfigurieren Sie, ob Request-Query-Parameter in Traces einbezogen werden sollen. Wenn auf false gesetzt, werden keine solchen Daten an unsere Server gesendet. Diese Werte werden mit dem Span-Attribut appsignal.request.query_parameters gesetzt. Weitere Informationen finden Sie unter Filterung von Request-Parametern.

config/appsignal.php

return [
    'send_request_query_parameters' => false,
    // ... other options
];

send_request_session_data

Feld	Wert
Konfigurationsdatei-Schlüssel	`send_request_session_data`
Systemumgebungs-Schlüssel	`APPSIGNAL_SEND_REQUEST_SESSION_DATA`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`

Beschreibung

Konfigurieren Sie, ob Request-Session-Daten in Traces gesendet werden sollen. Wenn auf false gesetzt, werden keine solchen Daten an unsere Server gesendet. Diese Werte werden mit dem Span-Attribut appsignal.request.session_data gesetzt. Weitere Informationen finden Sie unter Filterung von Request-Session-Daten.

config/appsignal.php

return [
    'send_request_session_data' => false,
    // ... other options
];

service_name

Feld	Wert
Konfigurationsdatei-Schlüssel	`service_name`
Systemumgebungs-Schlüssel	`APPSIGNAL_SERVICE_NAME`
Erforderlich	nein
Typ	`String`
Standardwert	`null` (standardmäßig nicht gesetzt)

Beschreibung

Der Service-Name hilft AppSignal, verschiedene Services zu erkennen, und gruppiert deren Traces automatisch in einem passenden Namespace. Wählen Sie einen Namen, der zu Ihrer Anwendung passt, wie zum Beispiel “Web server”, “Background worker”, “Email service”, “Authentication service” usw.

config/appsignal.php

return [
    'service_name' => 'My service name',
    // ... other options
];

​Verfügbare Optionen

​collector_endpoint

​Beschreibung

​environment

​Beschreibung

​name

​Beschreibung

​push_api_key

​Beschreibung

​active

​Beschreibung

​app_path

​Beschreibung

​filter_attributes

​Beschreibung

​filter_function_parameters

​Beschreibung

​filter_request_payload

​Beschreibung

​filter_request_query_parameters

​Beschreibung

​filter_request_session_data

​Beschreibung

​hostname

​Beschreibung

​ignore_actions

​Beschreibung

​ignore_errors

​Beschreibung

​ignore_logs

​Beschreibung

​ignore_namespaces

​Beschreibung

​request_headers

​Beschreibung

​response_headers

​Beschreibung

​revision

​Beschreibung

​send_function_parameters

​Beschreibung

​send_request_payload

​Beschreibung

​send_request_query_parameters

​Beschreibung

​send_request_session_data

​Beschreibung

​service_name

​Beschreibung

Verfügbare Optionen

collector_endpoint

Beschreibung

environment

Beschreibung

name

Beschreibung

push_api_key

Beschreibung

active

Beschreibung

app_path

Beschreibung

filter_attributes

Beschreibung

filter_function_parameters

Beschreibung

filter_request_payload

Beschreibung

filter_request_query_parameters

Beschreibung

filter_request_session_data

Beschreibung

hostname

Beschreibung

ignore_actions

Beschreibung

ignore_errors

Beschreibung

ignore_logs

Beschreibung

ignore_namespaces

Beschreibung

request_headers

Beschreibung

response_headers

Beschreibung

revision

Beschreibung

send_function_parameters

Beschreibung

send_request_payload

Beschreibung

send_request_query_parameters

Beschreibung

send_request_session_data

Beschreibung

service_name

Beschreibung