Configuratie-opties van het Python-pakket

De volgende lijst bevat alle configuratie-opties met de naam van de environment variable en de naam van de sleutel in het configuratiebestand. Voor meer informatie over het configureren van AppSignal met een configuratiebestand of systeem-environment variables, raadpleegt u onze Configuratie-documentatie.

active

Veld	Waarde
Sleutel in configuratiebestand	`active`
Systeemomgevingssleutel	`APPSIGNAL_ACTIVE`
Verplicht	ja
Type	Boolean (`true` / `false`)
Standaardwaarde	`false`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Configureer of AppSignal actief is voor een bepaalde omgeving. Als AppSignal niet actief is, worden er geen gegevens gerapporteerd voor de app in de opgegeven omgeving.

environment

Veld	Waarde
Configuratiebestandsleutel	`environment`
Systeemomgevingsvariabele	`APPSIGNAL_APP_ENV`
Verplicht	ja
Type	`String`
Standaardwaarde	`development`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

De omgeving van de app die aan AppSignal wordt gerapporteerd.

Let op: Het wijzigen van de naam of omgeving van een bestaande app maakt een nieuwe app aan op AppSignal.com.

name

Veld	Waarde
Configuratiebestandsleutel	`name`
Systeemomgevingsvariabele	`APPSIGNAL_APP_NAME`
Verplicht	ja
Type	`String`
Standaardwaarde	nil (Standaard niet ingesteld)
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Naam van uw applicatie zoals deze op AppSignal.com weergegeven moet worden.

Let op: Het wijzigen van de naam of omgeving van een bestaande app maakt een nieuwe app aan op AppSignal.com.

push_api_key

Veld	Waarde
Configuratiebestandsleutel	`push_api_key`
Systeemomgevingsvariabele	`APPSIGNAL_PUSH_API_KEY`
Verplicht	ja
Type	`String`
Standaardwaarde	nil (Standaard niet ingesteld)
Beschikbaar sinds versie	`0.1.0`

Beschrijving

De authenticatiesleutel op organisatieniveau om te authenticeren bij onze Push API. Lees meer over de AppSignal Push API-sleutel.

bind_address

Veld	Waarde
Sleutel in configuratiebestand	`bind_address`
Systeemomgevingssleutel	`APPSIGNAL_BIND_ADDRESS`
Verplicht	nee
Type	`String`
Standaardwaarde	`127.0.0.1`
Beschikbaar sinds versie	`0.1.5`

Beschrijving

Een geldig IPv4-adres dat de AppSignal-agent als binding voor zijn TCP- en UDP-servers gebruikt. Gebruik een specifiek adres als u wilt dat de agent alleen luistert naar aanvragen die naar dat adres worden gedaan. Stel deze optie in op 0.0.0.0 om aanvragen van hosts met elk willekeurig IP-adres te kunnen ontvangen. Standaard luistert hij alleen naar aanvragen die op dezelfde host worden gedaan. Deze optie wordt toegepast op alle agent-servers (StatsD, OpenTelemetry en NGINX).

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

ca_file_path

Veld	Waarde
Sleutel in configuratiebestand	`ca_file_path`
Systeemomgevingssleutel	`APPSIGNAL_CA_FILE_PATH`
Verplicht	nee
Type	`String`
Standaardwaarde	Bestandspad van meegeleverde `cacert.pem`.
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Gebruik deze optie om naar een ander certificaatbestand te verwijzen als er een probleem is met de verbinding met onze API.

Opmerking: Het opgegeven pad mag geen besturingssysteemspecifieke bestandssysteemabstracties bevatten, zoals het homedir-symbool ~ voor *NIX-systemen. Dit wordt gezien als een ongeldig pad.

Bij gebruik van een externe collector heeft deze configuratieoptie geen invloed op hoe de integratie communiceert met de externe collector. De optie wordt nog steeds gebruikt bij communicatie met de servers van AppSignal.

collector_endpoint

Veld	Waarde
Sleutel in configuratiebestand	`collector_endpoint`
Systeemomgevingssleutel	`APPSIGNAL_COLLECTOR_ENDPOINT`
Verplicht	nee
Type	`String`
Standaardwaarde	nil (deze is standaard niet ingesteld)
Beschikbaar sinds versie	`1.6.0`

Beschrijving

Het adres van een extern uitgerolde AppSignal Collector. Wanneer dit is ingesteld, wordt de AppSignal-agent die bij de integratie is meegeleverd niet gebruikt, en worden OpenTelemetry-gegevens in plaats daarvan naar de collector op dit adres verzonden.

Dit is een experimentele configuratieoptie. De volgende functionaliteit is niet beschikbaar bij gebruik van een externe collector:

De volgende functionaliteit is alleen beschikbaar bij gebruik van een externe collector:

Logging

cpu_count

Veld	Waarde
Configuratiebestandsleutel	`cpu_count`
Systeemomgevingsvariabele	`APPSIGNAL_CPU_COUNT`
Verplicht	nee
Type	`Float`
Standaardwaarde	`undefined`
Beschikbaar sinds versie	`1.2.0`

Beschrijving

De beschikbare CPU-capaciteit van de host, uitgedrukt in aantal CPU’s. Deze waarde wordt gebruikt om het CPU-gebruikspercentage in de hostmetingen te berekenen. Indien niet ingesteld, probeert de agent dit automatisch te detecteren via cgroups. Het aantal CPU’s kan een fractie zijn, bijvoorbeeld 0.5.

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

disable_default_instrumentations

Veld	Waarde
Configuratiebestandsleutel	`disable_default_instrumentations`
Systeemomgevingsvariabele	`APPSIGNAL_DISABLE_DEFAULT_INSTRUMENTATIONS`
Verplicht	nee
Type	`list(String)` of Boolean (`true` / `false`)
Standaardwaarde	`false`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Hiermee kunt u de automatische instrumentatie van standaardintegraties uitschakelen:

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

Wanneer u AppSignal voor Python 1.5.4 of eerder gebruikt, plaatst u voor elk van deze namen het voorvoegsel opentelemetry.instrumentation.. Bijvoorbeeld jinja2 wordt opgegeven als opentelemetry.instrumentation.jinja2.

Houd er rekening mee dat instrumentaties alleen ingeschakeld worden als de bijbehorende OpenTelemetry-instrumentatiebibliotheek is geïnstalleerd. Om alle automatische instrumentaties uit te schakelen, stelt u de waarde in op True.

dns_servers

Veld	Waarde
Configuratiebestandsleutel	`dns_servers`
Systeemomgevingsvariabele	`APPSIGNAL_DNS_SERVERS`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Configureer DNS-servers die de AppSignal-agent moet gebruiken.

Shell

# In de host-omgeving
export APPSIGNAL_DNS_SERVERS="8.8.8.8,8.8.4.4"

Als u last heeft van onze DNS-timeouts, probeer dan handmatig een DNS-server in te stellen met deze optie die niet meer dan 4 punten in de servernaam gebruikt.

Aanvaardbare waarden: 8.8.8.8, my.custom.local.server.
Niet aanvaardbare waarden: foo, my.awesome.custom.local.dns.server.

Als de DNS-server niet bereikbaar is, valt de agent terug op de DNS-configuratie van de host en wordt er een bericht in het appsignal.log-bestand geschreven: A problem occurred while setting DNS servers.

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

enable_host_metrics

Veld	Waarde
Configuratiebestandsleutel	`enable_host_metrics`
Systeemomgevingsvariabele	`APPSIGNAL_ENABLE_HOST_METRICS`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	“true `/ gedetecteerd door systeem`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Stel deze optie in op false om het verzamelen van hostmetingen uit te schakelen. Op Heroku en Dokku zijn hostmetingen standaard uitgeschakeld. Dit komt doordat deze systemen onnauwkeurige metingen vanuit de containers rapporteren. Het verzamelen van hostmetingen kan op deze systemen niet worden ingeschakeld. Gebruik voor Heroku in plaats daarvan de Heroku log drain.

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

enable_minutely_probes

Veld	Waarde
Configuratiebestandsleutel	`enable_minutely_probes`
Systeemomgevingsvariabele	`APPSIGNAL_ENABLE_MINUTELY_PROBES`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`
Beschikbaar sinds versie	`1.2.0`

Beschrijving

Schakelt het systeem van minutely probes in.

enable_nginx_metrics

Veld	Waarde
Configuratiebestandsleutel	`enable_nginx_metrics`
Systeemomgevingsvariabele	`APPSIGNAL_ENABLE_NGINX_METRICS`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`false`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Stel in op true om de NGINX-metricsserver in te schakelen. Zie de NGINX-metricsdocumentatie voor meer informatie. Wanneer ingeschakeld, luistert de AppSignal-agent naar een aan localhost gebonden server op poort 27649. Als u meerdere applicaties met AppSignal-instrumentatie op dezelfde server draait, kan deze configuratieoptie slechts in één daarvan worden ingeschakeld.

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

enable_statsd

Veld	Waarde
Configuratiebestandsleutel	`enable_statsd`
Systeemomgevingsvariabele	`APPSIGNAL_ENABLE_STATSD`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`false`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Schakelt de StatsD-server in de AppSignal-agent in. Wanneer ingeschakeld, luistert de AppSignal-agent naar een aan localhost gebonden server op poort 8125. Als u meerdere applicaties met AppSignal-instrumentatie op dezelfde server draait, kan deze configuratieoptie slechts in één daarvan worden ingeschakeld.

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

endpoint

Veld	Waarde
Configuratiebestandsleutel	`endpoint`
Systeemomgevingsvariabele	`APPSIGNAL_PUSH_API_ENDPOINT`
Verplicht	nee
Type	`String`
Standaardwaarde	`https://push.appsignal.com`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Configureer het endpoint waar gegevens naar AppSignal worden verzonden. Deze instelling hoeft niet te worden gewijzigd.

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

files_world_accessible

Veld	Waarde
Configuratiebestandsleutel	`files_world_accessible`
Systeemomgevingsvariabele	`APPSIGNAL_FILES_WORLD_ACCESSIBLE`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Als dit is ingesteld op true, is de aangemaakte AppSignal-werkmap toegankelijk voor alle gebruikers (Unix-rechten 0666). Dit is vaak nodig omdat processen voor dezelfde app onder een andere gebruiker draaien. Stel in op false om dit gedrag uit te schakelen (Unix-rechten 0644).

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

filter_attributes

Veld	Waarde
Configuratiebestandsleutel	`filter_attributes`
Systeemomgevingsvariabele	`APPSIGNAL_FILTER_ATTRIBUTES`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`
Beschikbaar sinds versie	`1.6.0`

Beschrijving

Lijst met OpenTelemetry-span-attributen die door AppSignal worden gefilterd. Overeenkomende waarden worden vervangen door [FILTERED]. Lees meer over parameterfiltering.

Alleen collector: deze configuratie-optie heeft alleen effect bij gebruik van een externe collector.Zie de configuratie-optie filter_parameters voor het filteren van gegevens bij gebruik van de agent.

filter_function_parameters

Veld	Waarde
Configuratiebestandsleutel	`filter_function_parameters`
Systeemomgevingsvariabele	`APPSIGNAL_FILTER_FUNCTION_PARAMETERS`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`
Beschikbaar sinds versie	`1.6.0`

Beschrijving

Lijst met functieparameterattributen die door AppSignal worden gefilterd. Overeenkomende waarden worden vervangen door [FILTERED]. Lees meer over parameterfiltering.

filter_parameters

Veld	Waarde
Configuratiebestandsleutel	`filter_parameters`
Systeemomgevingsvariabele	`APPSIGNAL_FILTER_PARAMETERS`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Lijst met parametersleutels die door de AppSignal-filtering moeten worden genegeerd. Hun waarden worden vervangen door [FILTERED] wanneer ze naar AppSignal worden verzonden. Lees meer over parameterfiltering.

Alleen agent: wanneer u een externe collector gebruikt, heeft deze configuratieoptie geen effect.Zie de volgende configuratieopties voor het filteren van parameters bij gebruik van een externe collector:

filter_attributes
filter_function_parameters
filter_request_payload
filter_request_query_parameters

filter_request_payload

Veld	Waarde
Configuratiebestandsleutel	`filter_request_payload`
Systeemomgevingsvariabele	`APPSIGNAL_FILTER_REQUEST_PAYLOAD`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`
Beschikbaar sinds versie	`1.6.0`

Beschrijving

Lijst met request-payload-attributen die door AppSignal worden gefilterd. Overeenkomende waarden worden vervangen door [FILTERED]. Lees meer over parameterfiltering.

filter_request_query_parameters

Veld	Waarde
Configuratiebestandsleutel	`filter_request_query_parameters`
Systeemomgevingsvariabele	`APPSIGNAL_FILTER_REQUEST_QUERY_PARAMETERS`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`
Beschikbaar sinds versie	`1.6.0`

Beschrijving

Lijst met request-queryparameterattributen die door AppSignal worden gefilterd. Overeenkomende waarden worden vervangen door [FILTERED]. Lees meer over parameterfiltering.

filter_session_data

Veld	Waarde
Configuratiebestandsleutel	`filter_session_data`
Systeemomgevingsvariabele	`APPSIGNAL_FILTER_SESSION_DATA`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Lijst met sessiegegevenssleutels die door de AppSignal-filtering moeten worden genegeerd. Hun waarden worden vervangen door [FILTERED] wanneer ze naar AppSignal worden verzonden. Lees meer over sessiegegevensfiltering.

host_role

Veld	Waarde
Configuratiebestandsleutel	`host_role`
Systeemomgevingsvariabele	`APPSIGNAL_HOST_ROLE`
Verplicht	nee
Type	`String`
Standaardwaarde	nil (Standaard niet ingesteld)
Beschikbaar sinds versie	`0.2.2`

Beschrijving

Groepeer hosts op rol en genereer metrics op basis van deze rol. Een voorbeeld van zo’n metric is de teller reporting_hosts. Een goede rol geeft aan wat de hoofdrol van de server is, zoals “webserver”, “processor”, “api”, “database”, “loadbalancer”, enzovoort.

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

hostname

Veld	Waarde
Configuratiebestandsleutel	`hostname`
Systeemomgevingsvariabele	`APPSIGNAL_HOSTNAME`
Verplicht	nee
Type	`String`
Standaardwaarde	gedetecteerd vanuit systeem
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Dit overschrijft de hostnaam van de server. Handig wanneer u geen aangepaste hostnaam kunt instellen of wanneer een onleesbaar id voor u wordt gegenereerd door hostingdiensten.

http_proxy

Veld	Waarde
Configuratiebestandsleutel	`http_proxy`
Systeemomgevingsvariabele	`APPSIGNAL_HTTP_PROXY`
Verplicht	nee
Type	`String`
Standaardwaarde	nil (Standaard niet ingesteld)
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Als u wilt dat de agent via een proxy verbinding maakt met het internet, stelt u in deze configuratiesleutel de volledige proxy-URL in.

ignore_actions

Veld	Waarde
Configuratiebestandsleutel	`ignore_actions`
Systeemomgevingsvariabele	`APPSIGNAL_IGNORE_ACTIONS`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

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

ignore_errors

Veld	Waarde
Configuratiebestandsleutel	`ignore_errors`
Systeemomgevingsvariabele	`APPSIGNAL_IGNORE_ERRORS`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Lijst met foutklassen die worden genegeerd. Elke exceptie die met deze foutklasse wordt opgeworpen, wordt niet naar AppSignal verzonden. Lees meer over fouten negeren.

ignore_namespaces

Veld	Waarde
Configuratiebestandsleutel	`ignore_namespaces`
Systeemomgevingsvariabele	`APPSIGNAL_IGNORE_NAMESPACES`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Lijst met namespaces die worden genegeerd. Elke opgetreden fout of trage request in deze namespace wordt niet naar AppSignal verzonden. Lees meer over namespaces.

log

Veld	Waarde
Configuratiebestandsleutel	`log`
Systeemomgevingsvariabele	`APPSIGNAL_LOG`
Verplicht	nee
Type	`String`
Standaardwaarde	`file`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Deze optie bepaalt welke logger door de interne loggingfunctionaliteit van AppSignal wordt gebruikt en heeft geen invloed op de loggingfunctie.Let op: De AppSignal-agent, die door de integratie wordt gebruikt, schrijft altijd naar het bestand “appsignal.log”.

Kies welke logger de AppSignal-integratie gebruikt. Geaccepteerde waarden zijn file en stdout. Zie ook de configuratie van log_path.

file (standaard)
- Schrijf alle AppSignal-logs naar het bestandssysteem.
stdout (standaard op Heroku)
- Druk AppSignal-logs af naar de STDOUT van het bovenliggende proces in plaats van naar een bestand. Handig bij hostingoplossingen zoals containersystemen en Heroku.

Bij gebruik van een externe collector heeft deze configuratieoptie geen invloed op hoe de collector logs uitstuurt. De integratie volgt deze configuratieoptie nog steeds bij het uitsturen van logs.

log_level

Veld	Waarde
Configuratiebestandsleutel	`log_level`
Systeemomgevingsvariabele	`APPSIGNAL_LOG_LEVEL`
Verplicht	nee
Type	`String`
Standaardwaarde	`info`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Deze optie stelt het ernstniveau van de interne logger van AppSignal in en heeft geen invloed op de loggingfunctie.

Stel het ernstniveau van de interne logger van AppSignal in. Als deze is geconfigureerd op “info”, worden alle error-, warning- en info-berichten gelogd, maar geen debug-berichten. Het instellen op de niveaus “debug” of “trace” is meestal alleen nodig op verzoek van de support. Het instellen op “debug”/“trace” kan een lichte impact hebben op het schijfgebruik en de IO, vooral op sites met veel verkeer. De CPU-overhead is minimaal met de debug-optie ingeschakeld. Geaccepteerde waarden:

error
warning
info
debug
trace

Bij gebruik van een externe collector heeft deze configuratieoptie geen invloed op hoe de collector logs uitstuurt. De integratie volgt deze configuratieoptie nog steeds bij het uitsturen van logs.

log_path

Veld	Waarde
Configuratiebestandsleutel	`log_path`
Systeemomgevingsvariabele	`APPSIGNAL_LOG_PATH`
Verplicht	nee
Type	`String`
Standaardwaarde	`/tmp`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Deze optie bepaalt de locatie van het interne loggingbestand van AppSignal en heeft geen invloed op de loggingfunctie.
Let op: Het opgegeven pad mag geen besturingssysteemspecifieke bestandssysteemabstracties bevatten, zoals het homedir-symbool ~ voor *NIX-systemen. Dit wordt gezien als een ongeldig pad.

Overschrijf de locatie van het pad (map) waar het bestand appsignal.log naartoe kan worden geschreven.

Bij gebruik van een externe collector heeft deze configuratieoptie geen invloed op hoe de collector logs uitstuurt. De integratie volgt deze configuratieoptie nog steeds bij het uitsturen van logs.

nginx_port

Veld	Waarde
Configuratiebestandsleutel	`nginx_port`
Systeemomgevingsvariabele	`APPSIGNAL_NGINX_PORT`
Verplicht	nee
Type	`Integer`
Standaardwaarde	`27649`
Beschikbaar sinds versie	`1.5.4`

Beschrijving

Configureer de poort waarop de NGINX-metricsserver wordt blootgesteld. Wanneer AppSignal NGINX-metrics ontvangt, luistert het naar een aan localhost gebonden server, standaard op poort 27649. Als u meerdere applicaties met AppSignal-instrumentatie met NGINX-metrics ingeschakeld op dezelfde server draait, gebruikt u deze optie om elke applicatie op een andere poort te laten luisteren.

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

opentelemetry_port

Veld	Waarde
Configuratiebestandsleutel	`opentelemetry_port`
Systeemomgevingsvariabele	`APPSIGNAL_OPENTELEMETRY_PORT`
Verplicht	nee
Type	`Integer`
Standaardwaarde	`8099`
Beschikbaar sinds versie	`0.2.2`

Beschrijving

Stel deze optie in om de OpenTelemetry HTTP-serverpoort van het AppSignal-agentproces te configureren. Configureer deze poort als er al een ander proces op de machine draait dat dezelfde poort gebruikt, om conflicten te voorkomen.

Alleen agent: wanneer u een externe collector gebruikt, heeft deze configuratieoptie geen effect. De poort die gebruikt wordt om OpenTelemetry-gegevens naar de externe collector te verzenden, kan worden opgegeven als onderdeel van de collector_endpoint-configuratieoptie.

request_headers

Veld	Waarde
Configuratiebestandsleutel	`request_headers`
Systeemomgevingsvariabele	`APPSIGNAL_REQUEST_HEADERS`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "range"]`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

De configuratieoptie request_headers bevat een lijst met HTTP-requestheaders die door het AppSignal Python-pakket worden gelezen en opgeslagen. Deze configuratieoptie request_headers is een allowlist, wat betekent dat alleen de headers worden meegenomen die door deze configuratieoptie zijn opgegeven. Als deze configuratieoptie niet is ingesteld, wordt de AppSignal-standaard gebruikt. De volgende lijst is de standaard van het AppSignal-pakket.

Python

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

Om deze lijst aan te passen, voegt u de configuratieoptie toe met alle headers die u gerapporteerd wilt hebben. Alle headernamen moeten in kleine letters worden geschreven. Als de headernaam X-Custom-Header is, voeg deze dan toe aan deze lijst als x-custom-header. Om AppSignal te configureren om geen enkele HTTP-requestheader op AppSignal-traces op te slaan, configureert u de optie met een lege lijst.

Python

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

response_headers

Veld	Waarde
Configuratiebestandsleutel	`response_headers`
Systeemomgevingsvariabele	`APPSIGNAL_RESPONSE_HEADERS`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`
Beschikbaar sinds versie	`1.6.0`

Beschrijving

De configuratieoptie response_headers bevat een lijst met HTTP-responseheaders die door het AppSignal for Python-pakket worden gelezen en opgeslagen. Deze configuratieoptie response_headers is een allowlist, wat betekent dat alleen de headers worden meegenomen die door deze configuratieoptie zijn opgegeven. Als deze configuratieoptie niet is ingesteld, worden er geen responseheaders gerapporteerd. Om deze lijst aan te passen, voegt u de configuratieoptie toe met alle headers die u gerapporteerd wilt hebben. Alle headernamen moeten in kleine letters worden geschreven. Als de headernaam X-Custom-Header is, voeg deze dan toe aan deze lijst als x-custom-header.

Alleen collector: deze configuratie-optie heeft alleen effect bij gebruik van een externe collector.

revision

Veld	Waarde
Configuratiebestandsleutel	`revision`
Systeemomgevingsvariabele	`APP_REVISION`
Verplicht	nee
Type	`String`
Standaardwaarde	nil (Standaard niet ingesteld)
Beschikbaar sinds versie	`0.1.0`
	`0.2.0`: Automatische detectie voor Render-deploys. `1.3.3`: Automatische detectie voor Kamal-deploys.

Beschrijving

Stel de app-revisie in om de momenteel actieve versie van uw app te rapporteren. AppSignal maakt een deploy-marker aan wanneer deze waarde verandert en tagt alle binnenkomende gegevens met de huidige revisie. Wanneer uw applicatie wordt geïmplementeerd met Kamal, of wanneer deze wordt geïmplementeerd op Render, of wanneer deze wordt geïmplementeerd op Heroku en de functie Heroku Labs: Dyno Metadata is ingeschakeld, detecteert de AppSignal-integratie automatisch de Git-commit van de huidige deployment en gebruikt deze als revisie. U kunt de automatisch gedetecteerde revisies in Heroku, Render of Kamal overschrijven door de configuratieoptie revision handmatig op een aangepaste waarde in te stellen. Lees meer over deploy-markers in het onderwerp deploy-markers.

Bij gebruik van een externe collector wordt de revisie niet automatisch gedetecteerd. Stel deze optie handmatig in om de momenteel actieve versie van uw app te rapporteren.

running_in_container

Veld	Waarde
Configuratiebestandsleutel	`running_in_container`
Systeemomgevingsvariabele	`APPSIGNAL_RUNNING_IN_CONTAINER`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	gedetecteerd door agent
Beschikbaar sinds versie	`0.1.0`

Beschrijving

AppSignal verwacht op dezelfde machine te draaien tussen verschillende deploys. Stel deze sleutel in op true als de applicatie in een container draait, bijvoorbeeld met Docker. Nieuwere versies van de AppSignal-integratie detecteren de containeromgeving automatisch, dus handmatige configuratie is niet nodig. Als u problemen ondervindt met de automatische detectie, neem dan contact op met support. Deze optie wordt automatisch op true gezet op Heroku.

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

send_environment_metadata

Veld	Waarde
Configuratiebestandsleutel	`send_environment_metadata`
Systeemomgevingsvariabele	`APPSIGNAL_SEND_ENVIRONMENT_METADATA`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Verzend omgevingsmetadata over de app. Lees voor meer informatie over omgevingsmetadata.

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

send_function_parameters

Veld	Waarde
Configuratiebestandsleutel	`send_function_parameters`
Systeemomgevingsvariabele	`APPSIGNAL_SEND_FUNCTION_PARAMETERS`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`
Beschikbaar sinds versie	`1.6.0`

Beschrijving

Of functieparameters naar AppSignal moeten worden verzonden.

Alleen collector: deze configuratie-optie heeft alleen effect bij gebruik van een externe collector.Zie de configuratie-optie send_params voor het verzenden van gegevens wanneer u de agent niet gebruikt.

send_params

Veld	Waarde
Configuratiebestandsleutel	`send_params`
Systeemomgevingsvariabele	`APPSIGNAL_SEND_PARAMS`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Of het verzenden van requestparameters naar AppSignal moet worden overgeslagen. Lees voor meer informatie over send_params bij het filteren van requestparameters.

Alleen agent: wanneer u een externe collector gebruikt, heeft deze configuratieoptie geen effect.Zie de volgende configuratieopties voor het verzenden van parameters bij gebruik van een externe collector:

send_function_parameters
send_request_payload
send_request_query_parameters

send_request_payload

Veld	Waarde
Configuratiebestandsleutel	`send_request_payload`
Systeemomgevingsvariabele	`APPSIGNAL_SEND_REQUEST_PAYLOAD`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`
Beschikbaar sinds versie	`1.6.0`

Beschrijving

Of de request-payload naar AppSignal moet worden verzonden.

send_request_query_parameters

Veld	Waarde
Configuratiebestandsleutel	`send_request_query_parameters`
Systeemomgevingsvariabele	`APPSIGNAL_SEND_REQUEST_QUERY_PARAMETERS`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`
Beschikbaar sinds versie	`1.6.0`

Beschrijving

Of request-queryparameters naar AppSignal moeten worden verzonden.

send_session_data

Veld	Waarde
Configuratiebestandsleutel	`send_session_data`
Systeemomgevingsvariabele	`APPSIGNAL_SEND_SESSION_DATA`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Stel deze optie in op false om geen sessiegegevens mee te sturen met exception-traces en performance issue-samples. Lees voor meer informatie over filtering van request-sessiegegevens.

service_name

Veld	Waarde
Configuratiebestandsleutel	`service_name`
Systeemomgevingsvariabele	`APPSIGNAL_SERVICE_NAME`
Verplicht	nee
Type	`String`
Standaardwaarde	“
Beschikbaar sinds versie	`1.6.0`

Beschrijving

De servicenaam helpt AppSignal verschillende services voor traces te herkennen en groepeert de traces automatisch in een namespace op basis van de servicenaam. Kies een naam die bij uw applicatie past, bijvoorbeeld “Web server”, “Background worker”, “Email service”, “Authentication service”, enzovoort.

Alleen collector: deze configuratie-optie heeft alleen effect bij gebruik van een externe collector.

statsd_port

Veld	Waarde
Configuratiebestandsleutel	`statsd_port`
Systeemomgevingsvariabele	`APPSIGNAL_STATSD_PORT`
Verplicht	nee
Type	`Integer`
Standaardwaarde	`8125`
Beschikbaar sinds versie	`0.2.2`

Beschrijving

Stel deze optie in om de StatsD HTTP-serverpoort van het AppSignal-agentproces te configureren. Configureer deze poort als er al een ander proces op de machine draait dat dezelfde poort gebruikt, om conflicten te voorkomen.

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

working_directory_path

Veld	Waarde
Configuratiebestandsleutel	`working_directory_path`
Systeemomgevingsvariabele	`APPSIGNAL_WORKING_DIRECTORY_PATH`
Verplicht	nee
Type	`String`
Standaardwaarde	gedetecteerd door agent
Beschikbaar sinds versie	`0.1.0`

Beschrijving

Overschrijf de locatie waar AppSignal for Python tijdelijke bestanden kan opslaan. Gebruik deze optie als de standaardlocatie niet geschikt is. Zie onze pagina hoe AppSignal werkt voor meer informatie over het doel van deze werkmap. Als u meerdere applicaties draait die AppSignal gebruiken op dezelfde server, gebruikt u deze configuratieoptie om voor elke AppSignal-instantie een andere werkmap te selecteren, anders kunnen de twee instanties met elkaar in conflict komen. Zie voor meer informatie over dit scenario onze documentatie over meerdere applicaties op één host draaien.

Python

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

Let op: Het opgegeven pad mag geen besturingssysteemspecifieke bestandssysteemabstracties bevatten, zoals het homedir-symbool ~ voor *NIX-systemen. Dit wordt gezien als een ongeldig pad.

Alleen agent: bij gebruik van een externe collector heeft deze configuratie-optie geen effect.

​Beschikbare opties

​active

​Beschrijving

​environment

​Beschrijving

​name

​Beschrijving

​push_api_key

​Beschrijving

​bind_address

​Beschrijving

​ca_file_path

​Beschrijving

​collector_endpoint

​Beschrijving

​cpu_count

​Beschrijving

​disable_default_instrumentations

​Beschrijving

​dns_servers

​Beschrijving

​enable_host_metrics

​Beschrijving

​enable_minutely_probes

​Beschrijving

​enable_nginx_metrics

​Beschrijving

​enable_statsd

​Beschrijving

​endpoint

​Beschrijving

​files_world_accessible

​Beschrijving

​filter_attributes

​Beschrijving

​filter_function_parameters

​Beschrijving

​filter_parameters

​Beschrijving

​filter_request_payload

​Beschrijving

​filter_request_query_parameters

​Beschrijving

​filter_session_data

​Beschrijving

​host_role

​Beschrijving

​hostname

​Beschrijving

​http_proxy

​Beschrijving

​ignore_actions

​Beschrijving

​ignore_errors

​Beschrijving

​ignore_namespaces

​Beschrijving

​log

​Beschrijving

​log_level

​Beschrijving

​log_path

​Beschrijving

​nginx_port

​Beschrijving

​opentelemetry_port

​Beschrijving

​request_headers

​Beschrijving

​response_headers

​Beschrijving

​revision

​Beschrijving

​running_in_container

​Beschrijving

​send_environment_metadata

​Beschrijving

​send_function_parameters

​Beschrijving

​send_params

Beschikbare opties

active

Beschrijving

environment

Beschrijving

name

Beschrijving

push_api_key

Beschrijving

bind_address

Beschrijving

ca_file_path

Beschrijving

collector_endpoint

Beschrijving

cpu_count

Beschrijving

disable_default_instrumentations

Beschrijving

dns_servers

Beschrijving

enable_host_metrics

Beschrijving

enable_minutely_probes

Beschrijving

enable_nginx_metrics

Beschrijving

enable_statsd

Beschrijving

endpoint

Beschrijving

files_world_accessible

Beschrijving

filter_attributes

Beschrijving

filter_function_parameters

Beschrijving

filter_parameters

Beschrijving

filter_request_payload

Beschrijving

filter_request_query_parameters

Beschrijving

filter_session_data

Beschrijving

host_role

Beschrijving

hostname

Beschrijving

http_proxy

Beschrijving

ignore_actions

Beschrijving

ignore_errors

Beschrijving

ignore_namespaces

Beschrijving

log

Beschrijving

log_level

Beschrijving

log_path

Beschrijving

nginx_port

Beschrijving

opentelemetry_port

Beschrijving

request_headers

Beschrijving

response_headers

Beschrijving

revision

Beschrijving

running_in_container

Beschrijving

send_environment_metadata

Beschrijving

send_function_parameters

Beschrijving

send_params