Java-configuratie-opties - AppSignal Documentation

AppSignal voor Java kan worden geconfigureerd via OpenTelemetry-resource-attributen. Resource-attributen zijn attributen die op elke trace van toepassing zijn die vanuit de applicatie via OpenTelemetry wordt gerapporteerd. Deze resource-attributen moeten worden geconfigureerd in uw applicatie via omgevingsvariabelen, waar u ook de OpenTelemetry-exporter configureert om te exporteren naar de AppSignal collector. Stel een omgevingsvariabele OTEL_RESOURCE_ATTRIBUTES in om de resource-attributen te configureren, zoals hieronder getoond:

Shell

export OTEL_RESOURCE_ATTRIBUTES="\
  attribute_key=attribute_value,\
  ...,\
	last_attribute_key=last_attribute_value"

environment

Veld	Waarde
Sleutel resource-attribuut	`appsignal.config.environment`
Vereist	ja
Type	`String`
Standaardwaarde	nil (Standaard niet ingesteld)

Beschrijving

De omgeving van de app die aan AppSignal wordt gerapporteerd.

Shell

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.environment=production,\
  ..."

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

host.name

Veld	Waarde
Resource attribute key	`host.name`
Verplicht	ja
Type	`String`
Standaardwaarde	gedetecteerd op basis van systeem

Beschrijving

De host.name resource attribute helpt AppSignal verschillende hosts voor traces te herkennen en de traces automatisch te taggen met de hostnaam.

Shell

HOST_NAME=$(hostname || echo unknown)

export OTEL_RESOURCE_ATTRIBUTES="\
  host.name=$HOST_NAME,\
  ..."

language_integration

Veld	Waarde
Resource attribute key	`appsignal.config.language_integration`
Verplicht	ja
Type	`String`
Standaardwaarde	nil (deze is standaard niet ingesteld)

Beschrijving

AppSignal gebruikt de language_integration resource attribute om de taal van een trace te detecteren en exception-backtraces correct te ontleden. Stel deze optie in door de naam van de taal in kleine letters op te geven: java.

Shell

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.language_integration=java,\
  ..."

name

Veld	Waarde
Resource attribute key	`appsignal.config.name`
Verplicht	ja
Type	`String`
Standaardwaarde	nil (deze is standaard niet ingesteld)

Beschrijving

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

Shell

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.name=My awesome app,\
  ..."

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
Resource attribute key	`appsignal.config.push_api_key`
Verplicht	ja
Type	`String`
Standaardwaarde	nil (deze is standaard niet ingesteld)

Beschrijving

De authenticatiesleutel op organisatieniveau om te authentiseren met onze Push API. Lees meer over de AppSignal Push API key.

Shell

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.push_api_key=00000000-0000-0000-0000-000000000000,\
  ..."

revision

Veld	Waarde
Resource attribute key	`appsignal.config.revision`
Verplicht	ja
Type	`String`
Standaardwaarde	nil (deze is standaard niet ingesteld)

Beschrijving

Stel de app-revisie in om de huidige draaiende versie van uw app te rapporteren. AppSignal maakt een deploy marker aan wanneer deze waarde verandert en tagt alle binnenkomende data met de huidige revisie. Lees meer over deploy markers in het onderwerp deploy markers.

Shell

REVISION=$(git rev-parse --short HEAD 2>/dev/null || echo unknown)

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.revision=$REVISION,\
  ..."

service.name

Veld	Waarde
Resource attribute key	`service.name`
Verplicht	ja
Type	`String`
Standaardwaarde	nil (deze is standaard niet ingesteld)

Beschrijving

De service.name resource attribute 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, zoals “Web server”, “Background worker”, “Email service”, “Authentication service”, enz.

Shell

export OTEL_RESOURCE_ATTRIBUTES="\
  service.name=My service name,\
  ..."

app_path

Veld	Waarde
Sleutel resource-attribuut	`appsignal.config.app_path`
Vereist	nee
Type	`String`
Standaardwaarde	nil (Standaard niet ingesteld)

Beschrijving

De locatie van de app op het bestandssysteem van de host. Het resource-attribuut app_path helpt AppSignal backtraces op te schonen door het absolute app-pad uit de backtrace-regels te verwijderen. Op die manier worden alleen paden binnen de context van de projectmap getoond. Dit maakt onze functie Backtrace links mogelijk.

Shell

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.app_path=$PWD,\
  ..."

filter_attributes

Veld	Waarde
Resource attribute key	`appsignal.config.filter_attributes`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`

Beschrijving

Met de filter_attributes resource attribute kunt u specifieke attributen uitfilteren zodat deze niet aan AppSignal worden gerapporteerd. Dit kan nuttig zijn om gevoelige of niet-relevante informatie uit te filteren. Als een attribuut op deze manier wordt gefilterd, verschijnt het helemaal niet in de interface. Het verwachte formaat is een door komma’s gescheiden lijst van waarden. De komma’s moeten in de omgevingsvariabele percent-encoded worden (vervangen door %2C). U kunt de encode-functie uit het onderstaande fragment gebruiken om de lijst met waarden te coderen:

Shell

function encode() {
  echo -n "$@" | sed 's/,/%2C/g'
}

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.filter_attributes=$(encode "my.secret.attribute,some.opentelemetry.attribute"),\
  ..."

filter_function_parameters

Veld	Waarde
Resource attribute key	`appsignal.config.filter_function_parameters`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`

Beschrijving

Met deze resource attribute kunt u functieparameters die zijn ingesteld in de appsignal.function.parameters span attribute uitfilteren. In het onderstaande voorbeeld worden waarden voor de sleutels die in de configuratieoptie filter_function_parameters staan, vervangen door [FILTERED]. Het verwachte formaat is een door komma’s gescheiden lijst van waarden. De komma’s moeten in de omgevingsvariabele percent-encoded worden (vervangen door %2C). U kunt de encode-functie uit het onderstaande fragment gebruiken om de lijst met waarden te coderen:

Shell

function encode() {
  echo -n "$@" | sed 's/,/%2C/g'
}

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.filter_function_parameters=$(encode "api_token,secret"),\
  ..."

filter_request_payload

Veld	Waarde
Resource attribute key	`appsignal.config.filter_request_payload`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`

Beschrijving

Met deze resource attribute kunt u request-payloadgegevens die zijn ingesteld in de appsignal.request.payload span attribute uitfilteren. In het onderstaande voorbeeld worden waarden voor de sleutels die in de configuratieoptie filter_request_payload staan, vervangen door [FILTERED]. Lees meer over filteren van request-queryparameters. Het verwachte formaat is een door komma’s gescheiden lijst van waarden. De komma’s moeten in de omgevingsvariabele percent-encoded worden (vervangen door %2C). U kunt de encode-functie uit het onderstaande fragment gebruiken om de lijst met waarden te coderen:

Shell

function encode() {
  echo -n "$@" | sed 's/,/%2C/g'
}

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.filter_request_payload=$(encode "password,cvv"),\
  ..."

filter_request_query_parameters

Veld	Waarde
Resource attribute key	`appsignal.config.filter_request_query_parameters`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`

Beschrijving

Met deze resource attribute kunt u request-queryparameters die zijn ingesteld in de appsignal.request.query_parameters span attribute uitfilteren. In het onderstaande voorbeeld worden waarden voor de sleutels die in de configuratieoptie filter_request_query_parameters staan, vervangen door [FILTERED]. Lees meer over filteren van request-queryparameters. Het verwachte formaat is een door komma’s gescheiden lijst van waarden. De komma’s moeten in de omgevingsvariabele percent-encoded worden (vervangen door %2C). U kunt de encode-functie uit het onderstaande fragment gebruiken om de lijst met waarden te coderen:

Shell

function encode() {
  echo -n "$@" | sed 's/,/%2C/g'
}

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.filter_request_query_parameters=$(encode "password,cvv"),\
  ..."

filter_request_session_data

Veld	Waarde
Resource attribute key	`appsignal.config.filter_request_session_data`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`

Beschrijving

Met de filter_request_session_data resource attribute kunt u request-sessiegegevens die zijn ingesteld in de appsignal.request.session_data span attribute uitfilteren. In het onderstaande voorbeeld worden waarden voor de sleutels die in de configuratieoptie filter_request_session_data staan, vervangen door [FILTERED]. Lees meer over filteren van request-sessiegegevens. Het verwachte formaat is een door komma’s gescheiden lijst van waarden. De komma’s moeten in de omgevingsvariabele percent-encoded worden (vervangen door %2C). U kunt de encode-functie uit het onderstaande fragment gebruiken om de lijst met waarden te coderen:

Shell

function encode() {
  echo -n "$@" | sed 's/,/%2C/g'
}

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.filter_session_data=$(encode "password,cvv"),\
  ..."

ignore_actions

Veld	Waarde
Resource attribute key	`appsignal.config.ignore_actions`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`

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. Het verwachte formaat is een door komma’s gescheiden lijst van waarden. De komma’s moeten in de omgevingsvariabele percent-encoded worden (vervangen door %2C). U kunt de encode-functie uit het onderstaande fragment gebruiken om de lijst met waarden te coderen:

Shell

function encode() {
  echo -n "$@" | sed 's/,/%2C/g'
}

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.ignore_actions=$(encode "GET /health_check,POST /ping"),\
  ..."

ignore_errors

Veld	Waarde
Resource attribute key	`appsignal.config.ignore_errors`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`

Beschrijving

Met deze configuratieoptie kunt u specifieke fouten negeren zodat ze niet naar AppSignal worden gerapporteerd. Dit kan handig zijn om verwachte fouten of fouten die niet opgelost kunnen worden te negeren. Lees meer over fouten negeren. Het verwachte formaat is een door komma’s gescheiden lijst van waarden. De komma’s moeten in de omgevingsvariabele percent-encoded worden (vervangen door %2C). U kunt de encode-functie uit het onderstaande fragment gebruiken om de lijst met waarden te coderen:

Shell

function encode() {
  echo -n "$@" | sed 's/,/%2C/g'
}

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.ignore_errors=$(encode "MyCustomError,ExpectedError"),\
  ..."

ignore_logs

Veld	Waarde
Resource attribute key	`appsignal.config.ignore_logs`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`

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. Het verwachte formaat is een door komma’s gescheiden lijst van waarden. De komma’s moeten in de omgevingsvariabele percent-encoded worden (vervangen door %2C). U kunt de encode-functie uit het onderstaande fragment gebruiken om de lijst met waarden te coderen:

Shell

function encode() {
  echo -n "$@" | sed 's/,/%2C/g'
}

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.ignore_logs=$(encode "^done$,Task .* completed successfully"),\
  ..."

ignore_namespaces

Veld	Waarde
Resource attribute key	`appsignal.config.ignore_namespaces`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`[]`

Beschrijving

Met deze configuratieoptie kunt u specifieke namespaces negeren zodat ze niet naar AppSignal worden gerapporteerd. Dit kan handig zijn om specifieke delen van uw applicatie niet te monitoren. Lees meer over namespaces. Het verwachte formaat is een door komma’s gescheiden lijst van waarden. De komma’s moeten in de omgevingsvariabele percent-encoded worden (vervangen door %2C). U kunt de encode-functie uit het onderstaande fragment gebruiken om de lijst met waarden te coderen:

Shell

function encode() {
  echo -n "$@" | sed 's/,/%2C/g'
}

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.ignore_namespaces=$(encode "admin,secret"),\
  ..."

request_headers

Veld	Waarde
Resource attribute key	`appsignal.config.request_headers`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "host", "range"]`

Beschrijving

Configureer welke request-headers moeten worden meegenomen wanneer er een verzoek aan een HTTP-server wordt gedaan. Deze optie is een allowlist. Alleen de geconfigureerde headers worden meegenomen. Als de lijst leeg is, worden er geen headers meegenomen. De request-headers worden gelezen uit de http.request.header.<key> OpenTelemetry span-attributen, waarbij <key> de genormaliseerde headernaam (in kleine letters) is. Stel de waarde van de resource attribute expliciet in op een lege waarde om geen headers in te stellen. Het verwachte formaat is een door komma’s gescheiden lijst van waarden. De komma’s moeten in de omgevingsvariabele percent-encoded worden (vervangen door %2C). U kunt de encode-functie uit het onderstaande fragment gebruiken om de lijst met waarden te coderen:

Shell

function encode() {
  echo -n "$@" | sed 's/,/%2C/g'
}

# Alleen deze specifieke headers verzenden
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.request_headers=$(encode "accept,request_method,content_length"),\
  ..."

# Geen headers verzenden
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.request_headers=,\
  ..."

response_headers

Veld	Waarde
Resource attribute key	`appsignal.config.response_headers`
Verplicht	nee
Type	`list(String)`
Standaardwaarde	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "host", "range"]`

Beschrijving

Configureer welke response-headers moeten worden meegenomen wanneer er een verzoek wordt gedaan door een HTTP-client. Deze optie is een allowlist. Alleen de geconfigureerde headers worden meegenomen. Als de lijst leeg is, worden er geen headers meegenomen. De response-headers worden gelezen uit de http.response.header.<key> OpenTelemetry span-attributen, waarbij <key> de genormaliseerde headernaam (in kleine letters) is. Stel de waarde van de resource attribute expliciet in op een lege array om geen headers in te stellen. Het verwachte formaat is een door komma’s gescheiden lijst van waarden. De komma’s moeten in de omgevingsvariabele percent-encoded worden (vervangen door %2C). U kunt de encode-functie uit het onderstaande fragment gebruiken om de lijst met waarden te coderen:

Shell

function encode() {
  echo -n "$@" | sed 's/,/%2C/g'
}

# Alleen deze specifieke headers verzenden
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.response_headers=$(encode "accept,request_method,content_length"),\
  ..."

# Geen headers verzenden
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.response_headers=,\
  ..."

send_function_parameters

Veld	Waarde
Resource attribute key	`appsignal.config.send_function_parameters`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`

Beschrijving

Configureer of functieparameters moeten worden meegenomen in traces. Als dit op false staat, worden dergelijke gegevens niet naar onze servers verzonden. Deze waarden worden ingesteld met de appsignal.function.parameters span attribute.

Shell

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.send_function_parameters=false,\
  ..."

send_request_payload

Veld	Waarde
Resource attribute key	`appsignal.config.send_request_payload`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`

Beschrijving

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

Shell

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.send_request_payload=false,\
  ..."

send_request_query_parameters

Veld	Waarde
Resource attribute key	`appsignal.config.send_request_query_parameters`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`

Beschrijving

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

Shell

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.send_request_query_parameters=false,\
  ..."

send_request_session_data

Veld	Waarde
Resource attribute key	`appsignal.config.send_request_session_data`
Verplicht	nee
Type	Boolean (`true` / `false`)
Standaardwaarde	`true`

Beschrijving

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

Shell

export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.send_request_session_data=false,\
  ..."

​Beschikbare opties

​environment

​Beschrijving

​host.name

​Beschrijving

​language_integration

​Beschrijving

​name

​Beschrijving

​push_api_key

​Beschrijving

​revision

​Beschrijving

​service.name

​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

​ignore_actions

​Beschrijving

​ignore_errors

​Beschrijving

​ignore_logs

​Beschrijving

​ignore_namespaces

​Beschrijving

​request_headers

​Beschrijving

​response_headers

​Beschrijving

​send_function_parameters

​Beschrijving

​send_request_payload

​Beschrijving

​send_request_query_parameters

​Beschrijving

​send_request_session_data

​Beschrijving

Beschikbare opties

environment

Beschrijving

host.name

Beschrijving

language_integration

Beschrijving

name

Beschrijving

push_api_key

Beschrijving

revision

Beschrijving

service.name

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

ignore_actions

Beschrijving

ignore_errors

Beschrijving

ignore_logs

Beschrijving

ignore_namespaces

Beschrijving

request_headers

Beschrijving

response_headers

Beschrijving

send_function_parameters

Beschrijving

send_request_payload

Beschrijving

send_request_query_parameters

Beschrijving

send_request_session_data

Beschrijving