AppSignal voor PHP-configuratie-opties - AppSignal Documentation

AppSignal voor PHP kan worden geconfigureerd via het bestand config/appsignal.php of met omgevingsvariabelen. Op deze pagina worden alle beschikbare configuratie-opties vermeld. Lees meer over de laadvolgorde van de configuratie. Zodra u AppSignal hebt geconfigureerd, kunt u de huidige configuratie valideren:

Shell

vendor/bin/appsignal validate

collector_endpoint

Veld	Waarde
Sleutel in configuratiebestand	`collector_endpoint`
Systeemomgevingssleutel	`APPSIGNAL_COLLECTOR_ENDPOINT`
Verplicht	ja
Type	`String`
Standaardwaarde	`null` (standaard niet ingesteld)

Beschrijving

De URL van de AppSignal-collector waarnaar trace-, metric- en loggegevens worden verzonden. AppSignal toont deze URL wanneer u een nieuwe applicatie aanmaakt, en is ook beschikbaar voor bestaande applicaties.

config/appsignal.php

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

environment

Veld	Waarde
Sleutel in configuratiebestand	`environment`
Systeemomgevingssleutel	`APPSIGNAL_APP_ENV`
Verplicht	ja
Type	`String`
Standaardwaarde	`null` (standaard niet ingesteld)

Beschrijving

De omgeving van de app die aan AppSignal wordt gerapporteerd.

config/appsignal.php

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

Opmerking: Het wijzigen van de naam of omgeving van een bestaande app zal een nieuwe app aanmaken op AppSignal.com.

name

Veld	Waarde
Sleutel in configuratiebestand	`name`
Systeemomgevingssleutel	`APPSIGNAL_APP_NAME`
Verplicht	ja
Type	`String`
Standaardwaarde	`null` (standaard niet ingesteld)

Beschrijving

De weergavenaam van uw applicatie op AppSignal.com.

config/appsignal.php

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

Opmerking: Het wijzigen van de naam of omgeving van een bestaande app zal een nieuwe app aanmaken op AppSignal.com.

push_api_key

Veld	Waarde
Sleutel in configuratiebestand	`push_api_key`
Systeemomgevingssleutel	`APPSIGNAL_PUSH_API_KEY`
Verplicht	ja
Type	`String`
Standaardwaarde	`null` (standaard niet ingesteld)

Beschrijving

De sleutel op organisatieniveau die wordt gebruikt om te authenticeren bij de Push API. Lees meer over de AppSignal Push API-sleutel.

config/appsignal.php

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

active

Veld	Waarde
Sleutel in configuratiebestand	`active`
Systeemomgevingssleutel	`APPSIGNAL_ACTIVE`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`false`

Beschrijving

Configureer of AppSignal actief is voor een bepaalde omgeving. Wordt meestal gebruikt in de bestandsconfiguratie per omgeving.

app_path

Veld	Waarde
Sleutel in configuratiebestand	`app_path`
Verplicht	nee
Type	`String`
Standaardwaarde	gedetecteerd op basis van projectroot

Beschrijving

De locatie van de app op het bestandssysteem van de host. Helpt AppSignal backtraces op te schonen door het absolute app-pad uit backtrace-regels te verwijderen, zodat alleen paden binnen de projectdirectory worden weergegeven. Dit maakt onze functie Backtrace-links mogelijk. Het AppSignal-pakket stelt deze waarde automatisch in op basis van de gedetecteerde projectroot. Als de automatische detectie van het app-pad niet werkt, kunt u deze overschrijven:

config/appsignal.php

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

filter_attributes

Veld	Waarde
Sleutel in configuratiebestand	`filter_attributes`
Systeemomgevingssleutel	`APPSIGNAL_FILTER_ATTRIBUTES`
Verplicht	nee
Type	`Array<String>`
Standaardwaarde	`[]`

Beschrijving

Met de configuratieoptie filter_attributes kunt u specifieke attributen uitfilteren zodat ze niet aan AppSignal worden gerapporteerd. Dit kan handig zijn om gevoelige of niet-relevante informatie uit te filteren. Als een attribuut op deze manier wordt uitgefilterd, verschijnt het helemaal niet in de interface.

config/appsignal.php

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

filter_function_parameters

Veld	Waarde
Sleutel in configuratiebestand	`filter_function_parameters`
Systeemomgevingssleutel	`APPSIGNAL_FILTER_FUNCTION_PARAMETERS`
Verplicht	nee
Type	`Array<String>`
Standaardwaarde	`[]`

Beschrijving

Met deze configuratieoptie kunt u functieparameters die zijn ingesteld in het span-attribuut appsignal.function.parameters uitfilteren. AppSignal vervangt de waarden van de sleutels die in de configuratieoptie filter_function_parameters staan door [FILTERED].

config/appsignal.php

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

filter_request_payload

Veld	Waarde
Sleutel in configuratiebestand	`filter_request_payload`
Systeemomgevingssleutel	`APPSIGNAL_FILTER_REQUEST_PAYLOAD`
Verplicht	nee
Type	`Array<String>`
Standaardwaarde	`[]`

Beschrijving

Met deze configuratieoptie kunt u request-payloadgegevens die zijn ingesteld in het span-attribuut appsignal.request.payload uitfilteren. AppSignal vervangt de waarden van de sleutels die in de configuratieoptie filter_request_payload staan door [FILTERED]. Lees meer over het filteren van request-queryparameters.

config/appsignal.php

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

filter_request_query_parameters

Veld	Waarde
Sleutel in configuratiebestand	`filter_request_query_parameters`
Systeemomgevingssleutel	`APPSIGNAL_FILTER_REQUEST_QUERY_PARAMETERS`
Verplicht	nee
Type	`Array<String>`
Standaardwaarde	`[]`

Beschrijving

Met deze configuratieoptie kunt u request-queryparameters die zijn ingesteld in het span-attribuut appsignal.request.query_parameters uitfilteren. AppSignal vervangt de waarden van de sleutels die in de configuratieoptie filter_request_query_parameters staan door [FILTERED]. Lees meer over het filteren van request-queryparameters.

config/appsignal.php

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

filter_request_session_data

Veld	Waarde
Sleutel in configuratiebestand	`filter_request_session_data`
Systeemomgevingssleutel	`APPSIGNAL_FILTER_REQUEST_SESSION_DATA`
Verplicht	nee
Type	`Array<String>`
Standaardwaarde	`[]`

Beschrijving

Met de configuratieoptie filter_request_session_data kunt u request-sessiegegevens die zijn ingesteld in het span-attribuut appsignal.request.session_data uitfilteren. AppSignal vervangt de waarden van de sleutels die in de configuratieoptie filter_request_session_data staan door [FILTERED]. Lees meer over het filteren van request-sessiegegevens.

config/appsignal.php

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

hostname

Veld	Waarde
Sleutel in configuratiebestand	`hostname`
Systeemomgevingssleutel	`APPSIGNAL_HOSTNAME`
Verplicht	nee
Type	`String`
Standaardwaarde	gedetecteerd vanuit systeem

Beschrijving

Helpt AppSignal verschillende hosts voor traces te herkennen en deze automatisch te taggen met de hostnaam. Het AppSignal-pakket stelt deze waarde automatisch in met gethostname().

ignore_actions

Veld	Waarde
Sleutel in configuratiebestand	`ignore_actions`
Systeemomgevingssleutel	`APPSIGNAL_IGNORE_ACTIONS`
Verplicht	nee
Type	`Array<String>`
Standaardwaarde	`[]`

Beschrijving

Met deze configuratieoptie kunt u een lijst van acties opgeven die door AppSignal genegeerd worden. Alles wat gebeurt, inclusief exceptions, wordt niet naar AppSignal verzonden. Dit kan handig zijn om health-check-endpoints of andere acties die u niet wilt monitoren te negeren. Lees meer over acties negeren.

config/appsignal.php

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

ignore_errors

Veld	Waarde
Sleutel in configuratiebestand	`ignore_errors`
Systeemomgevingssleutel	`APPSIGNAL_IGNORE_ERRORS`
Verplicht	nee
Type	`Array<String>`
Standaardwaarde	`[]`

Beschrijving

Met deze configuratieoptie kunt u specifieke fouten niet aan AppSignal laten rapporteren. Dit kan handig zijn om verwachte fouten of fouten die niet kunnen worden opgelost te negeren. Lees meer over fouten negeren.

config/appsignal.php

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

ignore_logs

Veld	Waarde
Sleutel in configuratiebestand	`ignore_logs`
Systeemomgevingssleutel	`APPSIGNAL_IGNORE_LOGS`
Verplicht	nee
Type	`Array<String>`
Standaardwaarde	`[]`

Beschrijving

Lijst van logberichten die genegeerd worden. Elk logbericht dat een van de elementen uit de lijst bevat, wordt niet naar AppSignal verzonden. Een kleine subset van regex-syntaxis wordt ondersteund; lees er meer over in onze handleiding Logs negeren. Het verwachte formaat is een door komma’s gescheiden lijst van waarden.

config/appsignal.php

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

ignore_namespaces

Veld	Waarde
Sleutel in configuratiebestand	`ignore_namespaces`
Systeemomgevingssleutel	`APPSIGNAL_IGNORE_NAMESPACES`
Verplicht	nee
Type	`Array<String>`
Standaardwaarde	`[]`

Beschrijving

Met deze configuratieoptie kunt u specifieke namespaces niet aan AppSignal laten rapporteren. Dit kan handig zijn om specifieke delen van uw applicatie niet te monitoren. Lees meer over namespaces.

config/appsignal.php

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

request_headers

Veld	Waarde
Sleutel in configuratiebestand	`request_headers`
Systeemomgevingssleutel	`APPSIGNAL_REQUEST_HEADERS`
Verplicht	nee
Type	`Array<String>`
Standaardwaarde	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "host", "range"]`

Beschrijving

Configureer welke request-headers worden opgenomen wanneer een aanvraag wordt gedaan aan een HTTP-server. Deze optie is een allowlist. Alleen de geconfigureerde headers worden opgenomen. Als de lijst leeg is, worden er geen headers opgenomen. AppSignal leest request-headers uit de HTTP-aanvraag. Elke sleutel is een genormaliseerde (kleine letters) headernaam.

config/appsignal.php

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

Om AppSignal zo te configureren dat er geen HTTP-request-headers worden opgeslagen, stelt u de configuratiewaarde expliciet in op een lege array.

config/appsignal.php

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

response_headers

Veld	Waarde
Sleutel in configuratiebestand	`response_headers`
Systeemomgevingssleutel	`APPSIGNAL_RESPONSE_HEADERS`
Verplicht	nee
Type	`Array<String>`
Standaardwaarde	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "date", "range"]`

Beschrijving

Configureer welke response-headers worden opgenomen wanneer een aanvraag wordt gedaan door een HTTP-client. Deze optie is een allowlist. Alleen de geconfigureerde headers worden opgenomen. Als de array leeg is, worden er geen headers opgenomen. Elk item in deze array moet een genormaliseerde HTTP-response-headernaam zijn (kleine letters).

config/appsignal.php

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

Om AppSignal zo te configureren dat er geen HTTP-response-headers worden opgeslagen, stelt u de configuratiewaarde expliciet in op een lege array.

config/appsignal.php

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

revision

Veld	Waarde
Sleutel in configuratiebestand	`revision`
Systeemomgevingssleutel	`APPSIGNAL_REVISION`
Verplicht	nee
Type	`String`
Standaardwaarde	gedetecteerd vanuit git

Beschrijving

De huidige actieve versie van uw app. AppSignal maakt een deploy marker aan wanneer deze waarde verandert en tagt alle binnenkomende gegevens met de huidige revisie. Het AppSignal-pakket stelt deze waarde automatisch in met git rev-parse HEAD. Lees meer over deploy markers in het onderwerp deploy markers.

send_function_parameters

Veld	Waarde
Sleutel in configuratiebestand	`send_function_parameters`
Systeemomgevingssleutel	`APPSIGNAL_SEND_FUNCTION_PARAMETERS`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`

Beschrijving

Configureer of functieparameters worden opgenomen in traces. Als dit is ingesteld op false, worden dergelijke gegevens niet naar onze servers verzonden. Deze waarden worden ingesteld met het span-attribuut appsignal.function.parameters.

config/appsignal.php

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

send_request_payload

Veld	Waarde
Sleutel in configuratiebestand	`send_request_payload`
Systeemomgevingssleutel	`APPSIGNAL_SEND_REQUEST_PAYLOAD`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`

Beschrijving

Configureer of request-payloadgegevens worden verzonden in traces. Als dit is ingesteld op false, worden dergelijke gegevens niet naar onze servers verzonden. Deze waarden worden ingesteld met het span-attribuut appsignal.request.payload. Lees voor meer informatie over het filteren van request-payloads.

config/appsignal.php

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

send_request_query_parameters

Veld	Waarde
Sleutel in configuratiebestand	`send_request_query_parameters`
Systeemomgevingssleutel	`APPSIGNAL_SEND_REQUEST_QUERY_PARAMETERS`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`

Beschrijving

Configureer of request-queryparameters worden opgenomen in traces. Als dit is ingesteld op false, worden dergelijke gegevens niet naar onze servers verzonden. Deze waarden worden ingesteld met het span-attribuut appsignal.request.query_parameters. Lees voor meer informatie over het filteren van request-parameters.

config/appsignal.php

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

send_request_session_data

Veld	Waarde
Sleutel in configuratiebestand	`send_request_session_data`
Systeemomgevingssleutel	`APPSIGNAL_SEND_REQUEST_SESSION_DATA`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`

Beschrijving

Configureer of request-sessiegegevens worden verzonden in traces. Als dit is ingesteld op false, worden dergelijke gegevens niet naar onze servers verzonden. Deze waarden worden ingesteld met het span-attribuut appsignal.request.session_data. Lees voor meer informatie over het filteren van request-sessiegegevens.

config/appsignal.php

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

service_name

Veld	Waarde
Sleutel in configuratiebestand	`service_name`
Systeemomgevingssleutel	`APPSIGNAL_SERVICE_NAME`
Verplicht	nee
Type	`String`
Standaardwaarde	`null` (standaard niet ingesteld)

Beschrijving

De servicenaam helpt AppSignal verschillende services te herkennen en groepeert hun traces automatisch in een bijbehorende namespace. Kies een naam die bij uw applicatie past, zoals “Web server”, “Background worker”, “Email service”, “Authentication service”, enzovoort.

config/appsignal.php

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

​Beschikbare opties

​collector_endpoint

​Beschrijving

​environment

​Beschrijving

​name

​Beschrijving

​push_api_key

​Beschrijving

​active

​Beschrijving

​app_path

​Beschrijving

​filter_attributes

​Beschrijving

​filter_function_parameters

​Beschrijving

​filter_request_payload

​Beschrijving

​filter_request_query_parameters

​Beschrijving

​filter_request_session_data

​Beschrijving

​hostname

​Beschrijving

​ignore_actions

​Beschrijving

​ignore_errors

​Beschrijving

​ignore_logs

​Beschrijving

​ignore_namespaces

​Beschrijving

​request_headers

​Beschrijving

​response_headers

​Beschrijving

​revision

​Beschrijving

​send_function_parameters

​Beschrijving

​send_request_payload

​Beschrijving

​send_request_query_parameters

​Beschrijving

​send_request_session_data

​Beschrijving

​service_name

​Beschrijving

Beschikbare opties

collector_endpoint

Beschrijving

environment

Beschrijving

name

Beschrijving

push_api_key

Beschrijving

active

Beschrijving

app_path

Beschrijving

filter_attributes

Beschrijving

filter_function_parameters

Beschrijving

filter_request_payload

Beschrijving

filter_request_query_parameters

Beschrijving

filter_request_session_data

Beschrijving

hostname

Beschrijving

ignore_actions

Beschrijving

ignore_errors

Beschrijving

ignore_logs

Beschrijving

ignore_namespaces

Beschrijving

request_headers

Beschrijving

response_headers

Beschrijving

revision

Beschrijving

send_function_parameters

Beschrijving

send_request_payload

Beschrijving

send_request_query_parameters

Beschrijving

send_request_session_data

Beschrijving

service_name

Beschrijving