Beschikbare opties
- Vereiste opties
- Opties
additionalInstrumentationsbindAddresscaFilePathcpuCountdebugdisableDefaultInstrumentationsdnsServersenableHostMetricsenableMinutelyProbesenableNginxMetricsenableOpentelemetryHttpenableStatsdfilesWorldAccessiblefilterParametersfilterSessionDatahostnamehostRolehttpProxyignoreActionsignoreErrorsignoreLogsignoreNamespacesloglogLevellogPathnginxPortopentelemetry_portrequestHeadersrevisionrunningInContainersendEnvironmentMetadatasendParamssendSessionDatastatsdPortworkingDirectoryPath
active
Beschrijving
Configureer of AppSignal actief moet zijn voor een bepaalde omgeving. Meestal gebruikt in de bestandsconfiguratie per omgeving.environment
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
Beschrijving
Naam van uw applicatie zoals deze moet worden weergegeven op AppSignal.com.Opmerking: Het wijzigen van de naam of omgeving van een bestaande app
zal een nieuwe app aanmaken op AppSignal.com.
pushApiKey
Beschrijving
De authenticatiesleutel op organisatieniveau om te authenticeren bij onze Push API. Lees meer over de AppSignal Push API-sleutel.additionalInstrumentations
Beschrijving
Lijst van extra OpenTelemetry-instrumentaties om met AppSignal te gebruiken, via bibliotheken van derden of uw eigen integraties.bindAddress
Beschrijving
Een geldig IPv4-adres dat de AppSignal-agent gebruikt als binding voor zijn TCP- en UDP-servers. Gebruik een specifiek adres als u wilt dat de agent alleen luistert naar verzoeken die naar dat adres worden gedaan. Stel deze optie in op0.0.0.0 om verzoeken te kunnen ontvangen van hosts met elk IP-adres. Standaard luistert hij alleen naar verzoeken die op dezelfde host worden gedaan. Deze optie wordt toegepast op alle agent-servers (StatsD, OpenTelemetry en NGINX).
caFilePath
Beschrijving
Gebruik deze optie om naar een ander certificaatbestand te verwijzen als er een probleem is met de verbinding naar onze API.Let op: Het opgegeven pad mag geen besturingssysteemspecifieke
bestandssysteem-abstracties bevatten, zoals het homedir-symbool
~ voor *NIX-systemen. Dit
wordt gezien als een ongeldig pad.cpuCount
Beschrijving
De beschikbare CPU-capaciteit van de host, uitgedrukt in aantal CPU’s. Dit wordt gebruikt om het CPU-gebruikspercentage in de host-metrieken te berekenen. Als dit niet is ingesteld, zal de agent dit automatisch proberen te detecteren via cgroups. Het aantal CPU’s kan een breuk zijn, bijvoorbeeld0.5.
debug
Beschrijving
Schakel debug-logging in; dit is meestal alleen nodig op verzoek van support. Met deze optie ingeschakeld logt AppSignal veel meer informatie over beslissingen die worden genomen tijdens het verzamelen van metrieken en wanneer er data naar de AppSignal.com-servers wordt verzonden. Het inschakelen van debug-logging kan een lichte impact hebben op het schijfgebruik en IO, vooral op sites met veel verkeer. De CPU-overhead is minimaal met de debug-optie ingeschakeld.Deze optie stelt het severity-niveau in van de interne logger van AppSignal. Deze
configuratieoptie heeft geen invloed op de logging-functie.
disableDefaultInstrumentations
Beschrijving
Hiermee kunt u de automatische instrumentatie van standaardintegraties uitschakelen:- @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
true om alle instrumentaties uit te schakelen.
dnsServers
Beschrijving
Configureer DNS-servers voor de AppSignal-agent.Shell
- Acceptabele waarden:
8.8.8.8,my.custom.local.server. - Niet acceptabele waarden:
foo,my.awesome.custom.local.dns.server.
appsignal.log: A problem occurred while setting DNS servers.
enableHostMetrics
Beschrijving
Stel deze optie in opfalse om het verzamelen van host-metrieken uit te schakelen.
Op Heroku en Dokku zijn host-metrieken standaard uitgeschakeld. Dat is zo omdat deze systemen vanuit de containers onnauwkeurige metrieken zouden rapporteren. Het verzamelen van host-metrieken op deze systemen kan niet worden ingeschakeld. Gebruik voor Heroku in plaats daarvan de Heroku log drain.
enableMinutelyProbes
Beschrijving
Schakelt het minutely probes-systeem in.enableNginxMetrics
Beschrijving
Stel in optrue om de NGINX-metrieken-server in te schakelen. Zie de NGINX-metrieken-documentatie voor details.
Indien ingeschakeld luistert de AppSignal-agent naar een aan localhost gebonden server op poort 27649. Als u meerdere AppSignal-geïnstrumenteerde applicaties op dezelfde server draait, kan deze configuratieoptie maar in één van die applicaties worden ingeschakeld.
enableOpentelemetryHttp
Beschrijving
Stel deze optie in optrue om de OpenTelemetry HTTP-server in te schakelen.
Indien ingeschakeld luistert de AppSignal-agent naar een aan localhost gebonden server op poort 8099. Als u meerdere AppSignal-geïnstrumenteerde applicaties op dezelfde server draait, kan deze configuratieoptie maar in één van die applicaties worden ingeschakeld.
Dit is vereist voor apps die de OpenTelemetry HTTP-exporter gebruiken om data naar AppSignal te rapporteren.
enableStatsd
Beschrijving
Schakelt de StatsD-server in de AppSignal-agent in. Indien ingeschakeld luistert de AppSignal-agent naar een aanlocalhost gebonden server op poort 8125. Als u meerdere AppSignal-geïnstrumenteerde applicaties op dezelfde server draait, kan deze configuratieoptie maar in één van die applicaties worden ingeschakeld.
filesWorldAccessible
Beschrijving
Als dit optrue staat, is de aangemaakte AppSignal-werkdirectory toegankelijk voor alle gebruikers (Unix-rechten 0666). Dit is vaak nodig omdat processen voor dezelfde app onder een andere gebruiker draaien. Zet op false om dit gedrag uit te schakelen (Unix-rechten 0644).
filterParameters
Beschrijving
Lijst van parametersleutels die moeten worden genegeerd via AppSignal-filtering. Hun waarden worden vervangen door[FILTERED] wanneer ze naar AppSignal worden verzonden.
Lees meer over parameterfiltering.
filterSessionData
Beschrijving
Lijst van sessiedata-sleutels die moeten worden genegeerd via AppSignal-filtering. Hun waarden worden vervangen door[FILTERED] wanneer ze naar AppSignal worden verzonden.
Lees meer over sessiedata-filtering.
hostname
Beschrijving
Dit overschrijft de hostnaam van de server. Handig voor wanneer u geen aangepaste hostnaam kunt instellen of wanneer er een nietszeggende id voor u wordt gegenereerd op hostingdiensten.hostRole
Beschrijving
Groepeer hosts op rol en genereer metrieken op basis van deze rol. Een voorbeeld van zo’n metriek is de counter-metriekreporting_hosts. Een goede rol geeft aan wat de hoofdrol van de server is, zoals “webserver”, “processor”, “api”, “database”, “loadbalancer”, enz.
httpProxy
Beschrijving
Als u wilt dat de agent via een proxy met het internet verbindt, stel dan de volledige proxy-URL in deze configuratiesleutel in.ignoreActions
Beschrijving
Met deze configuratieoptie kunt u een lijst opgeven van acties die door AppSignal worden genegeerd. Alles wat zich daarin afspeelt, inclusief uitzonderingen, 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.ignoreErrors
Beschrijving
Lijst van foutklassen die worden genegeerd. Elke uitzondering die met deze foutklasse wordt opgeworpen, wordt niet naar AppSignal verzonden. Lees meer over fouten negeren.ignoreLogs
Beschrijving
Lijst van logberichten die worden genegeerd. Elk logbericht dat een van de elementen uit de lijst bevat, wordt niet naar AppSignal verzonden. Een kleine subset van de regex-syntaxis wordt ondersteund; lees er meer over in onze Ignore Logs-gids.ignoreNamespaces
Beschrijving
Lijst van namespaces die genegeerd worden. Elke fout of trage aanvraag die in deze namespace optreedt, wordt niet naar AppSignal verzonden. Lees meer over namespaces.log
Beschrijving
Deze optie configureert welke logger de interne logfunctionaliteit van AppSignal
gebruikt en heeft geen invloed op de logging-functie.Opmerking: De AppSignal agent,
die door de integratie wordt gebruikt, schrijft altijd naar het bestand “appsignal.log”.
file en stdout. Zie ook de configuratie log_path.
file(standaard)- Schrijf alle AppSignal-logs naar het bestandssysteem.
stdout(standaard op Heroku)- Druk AppSignal-logs af in STDOUT van het bovenliggende proces in plaats van naar een bestand. Handig bij hostingoplossingen zoals containersystemen en Heroku.
logLevel
Beschrijving
Deze optie stelt het ernstniveau van de interne logger van AppSignal in en heeft
geen invloed op de logging-functie.
- error
- warning
- info
- debug
- trace
logPath
Beschrijving
Deze optie configureert de locatie van het interne logbestand van AppSignal en
heeft geen invloed op de logging-functie.
Opmerking: Het opgegeven pad mag geen besturingssysteemspecifieke bestandssysteemabstracties bevatten, zoals het homedir-symbool
Opmerking: Het opgegeven pad mag geen besturingssysteemspecifieke bestandssysteemabstracties bevatten, zoals het homedir-symbool
~ voor *NIX-systemen. Dit wordt gezien
als een ongeldig pad.appsignal.log
naar geschreven kan worden.
nginxPort
Beschrijving
Configureer de poort waarop de NGINX-metrics-server beschikbaar is. Wanneer AppSignal NGINX-metrics ontvangt, luistert het op een aanlocalhost gebonden server, standaard op poort 27649. Als u meerdere applicaties met AppSignal-instrumentatie en NGINX-metrics ingeschakeld op dezelfde server uitvoert, gebruikt u deze optie om elke applicatie op een andere poort te laten luisteren.
opentelemetry_port
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 ook deze poort gebruikt, om conflicten te voorkomen.requestHeaders
Beschrijving
De configuratieoptierequestHeaders bevat een lijst van HTTP-request-headers die door het AppSignal Node.js-pakket worden gelezen en opgeslagen.
Deze requestHeaders-configuratieoptie is een allowlist, wat betekent dat alleen de headers worden opgenomen die door deze configuratieoptie zijn opgegeven. Als deze configuratieoptie niet is ingesteld, wordt de AppSignal-standaard gebruikt.
De volgende lijst is de standaardwaarde van het AppSignal-pakket.
Node.js
Node.js
revision
Beschrijving
Stel de app-revisie in om de huidige 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 gedeployed met Kamal, of wanneer deze wordt gedeployed naar Render, of wanneer deze wordt gedeployed naar Heroku en de functie Heroku Labs: Dyno Metadata is ingeschakeld, detecteert de AppSignal-integratie automatisch de Git-commit van de huidige deploy en gebruikt deze als revisie. U kunt de automatisch gedetecteerde revisies in Heroku, Render of Kamal overschrijven door handmatig de configuratieoptierevision op een aangepaste waarde in te stellen.
Lees meer over deploy markers in het onderwerp deploy markers.
runningInContainer
Beschrijving
AppSignal verwacht op dezelfde machine te draaien tussen verschillende deploys. Stel deze sleutel in optrue als de applicatie in een container draait, zoals met Docker.
Nieuwere versies van de AppSignal-integratie detecteren automatisch hun containeromgeving, 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.
sendEnvironmentMetadata
Beschrijving
Verzend omgevingsmetadata over de app. Lees voor meer informatie over omgevingsmetadata.sendParams
Beschrijving
Of het verzenden van request-parameters naar AppSignal overgeslagen moet worden. Lees voor meer informatie over send_params bij het filteren van request-parameters.sendSessionData
Beschrijving
Stel deze optie in opfalse om geen sessiegegevens te verzenden met exception traces en performance-issue-samples.
Lees voor meer informatie over filteren van request-sessiegegevens.
statsdPort
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 ook deze poort gebruikt, om conflicten te voorkomen.workingDirectoryPath
Beschrijving
Overschrijf de locatie waar AppSignal voor Node.js 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 werkdirectory. Als u meerdere applicaties met AppSignal op dezelfde server uitvoert, gebruik dan deze configuratieoptie om voor elke AppSignal-instantie een andere werkdirectory te kiezen, anders kunnen de twee instanties met elkaar conflicteren. Zie voor meer informatie over dit scenario onze documentatie meerdere applicaties op één host uitvoeren.Node.js
Opmerking: Het opgegeven pad mag geen besturingssysteemspecifieke bestandssysteemabstracties
bevatten, zoals het homedir-symbool
~ voor *NIX-systemen. Dit wordt gezien
als een ongeldig pad.