Options de configuration Java - AppSignal Documentation

AppSignal pour Java peut être configuré via les attributs de ressource OpenTelemetry. Les attributs de ressource sont des attributs qui s’appliquent à chaque trace reportée depuis l’application utilisant OpenTelemetry. Ces attributs de ressource doivent être configurés dans votre application à l’aide de variables d’environnement, là où vous configurez également l’exportateur OpenTelemetry pour exporter vers le collecteur AppSignal. Pour configurer les attributs de ressource, définissez une variable d’environnement OTEL_RESOURCE_ATTRIBUTES, comme indiqué ci-dessous :

Shell

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

environment

Champ	Valeur
Clé de l’attribut de ressource	`appsignal.config.environment`
Obligatoire	oui
Type	`String`
Valeur par défaut	nil (non défini par défaut)

Description

L’environnement de l’application à signaler à AppSignal.

Shell

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

Remarque : Modifier le nom ou l’environnement d’une application existante créera une nouvelle application sur AppSignal.com.

host.name

Champ	Valeur
Clé d’attribut de ressource	`host.name`
Requis	oui
Type	`String`
Valeur par défaut	détectée depuis le système

Description

L’attribut de ressource host.name aide AppSignal à reconnaître différents hôtes pour les traces et à étiqueter automatiquement les traces avec le nom d’hôte.

Shell

HOST_NAME=$(hostname || echo unknown)

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

language_integration

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.language_integration`
Requis	oui
Type	`String`
Valeur par défaut	nil (non défini par défaut)

Description

AppSignal utilise l’attribut de ressource language_integration pour détecter le langage d’une trace et analyser correctement les backtraces d’exceptions. Pour définir cette option, indiquez le nom du langage en minuscules : java.

Shell

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

name

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.name`
Requis	oui
Type	`String`
Valeur par défaut	nil (non défini par défaut)

Description

Nom de votre application tel qu’il doit être affiché sur AppSignal.com.

Shell

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

Remarque : Modifier le nom ou l’environnement d’une application existante créera une nouvelle application sur AppSignal.com.

push_api_key

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.push_api_key`
Requis	oui
Type	`String`
Valeur par défaut	nil (non défini par défaut)

Description

Clé d’authentification au niveau de l’organisation utilisée pour s’authentifier auprès de notre Push API. Pour en savoir plus sur la clé Push API AppSignal.

Shell

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

revision

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.revision`
Requis	oui
Type	`String`
Valeur par défaut	nil (non défini par défaut)

Description

Définissez la révision de l’application pour signaler la version actuellement en cours d’exécution. AppSignal créera un marqueur de déploiement lorsque cette valeur change, et étiquettera toutes les données entrantes avec la révision actuelle. Pour en savoir plus sur les marqueurs de déploiement, consultez la rubrique marqueurs de déploiement.

Shell

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

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

service.name

Champ	Valeur
Clé d’attribut de ressource	`service.name`
Requis	oui
Type	`String`
Valeur par défaut	nil (non défini par défaut)

Description

L’attribut de ressource service.name aide AppSignal à reconnaître différents services pour les traces et regroupe automatiquement les traces dans un namespace basé sur le nom du service. Choisissez un nom qui correspond à votre application, comme « Web server », « Background worker », « Email service », « Authentication service », etc.

Shell

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

app_path

Champ	Valeur
Clé de l’attribut de ressource	`appsignal.config.app_path`
Obligatoire	non
Type	`String`
Valeur par défaut	nil (non défini par défaut)

Description

L’emplacement de l’application sur le système de fichiers de l’hôte. L’attribut de ressource app_path aide AppSignal à nettoyer les traces d’appels en supprimant le chemin absolu de l’application des lignes de trace. Ainsi, seuls les chemins dans le contexte du répertoire du projet sont affichés. Cela rend possible notre fonctionnalité liens de traces d’appels.

Shell

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

filter_attributes

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.filter_attributes`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`

Description

L’attribut de ressource filter_attributes vous permet de filtrer certains attributs spécifiques afin qu’ils ne soient pas envoyés à AppSignal. Cela peut être utile pour empêcher la transmission d’informations sensibles ou non pertinentes. Si un attribut est filtré de cette façon, il n’apparaîtra pas du tout dans l’interface. Le format attendu est une liste de valeurs séparées par des virgules. Les virgules doivent être encodées en pourcentage (remplacées par %2C) dans la variable d’environnement. Vous pouvez utiliser la fonction encode fournie dans l’extrait ci-dessous pour encoder la liste de valeurs :

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

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.filter_function_parameters`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`

Description

Cet attribut de ressource vous permet de filtrer les paramètres de fonction définis dans l’attribut de span appsignal.function.parameters. Dans l’exemple ci-dessous, les valeurs des clés listées dans l’option de configuration filter_function_parameters sont remplacées par [FILTERED]. Le format attendu est une liste de valeurs séparées par des virgules. Les virgules doivent être encodées en pourcentage (remplacées par %2C) dans la variable d’environnement. Vous pouvez utiliser la fonction encode fournie dans l’extrait ci-dessous pour encoder la liste de valeurs :

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

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.filter_request_payload`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`

Description

Cet attribut de ressource vous permet de filtrer les données de charge utile de requête définies dans l’attribut de span appsignal.request.payload. Dans l’exemple ci-dessous, les valeurs des clés listées dans l’option de configuration filter_request_payload sont remplacées par [FILTERED]. Pour en savoir plus, consultez la page sur le filtrage des paramètres de requête. Le format attendu est une liste de valeurs séparées par des virgules. Les virgules doivent être encodées en pourcentage (remplacées par %2C) dans la variable d’environnement. Vous pouvez utiliser la fonction encode fournie dans l’extrait ci-dessous pour encoder la liste de valeurs :

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

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.filter_request_query_parameters`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`

Description

Cet attribut de ressource vous permet de filtrer les paramètres de requête (query parameters) définis dans l’attribut de span appsignal.request.query_parameters. Dans l’exemple ci-dessous, les valeurs des clés listées dans l’option de configuration filter_request_query_parameters sont remplacées par [FILTERED]. Pour en savoir plus, consultez la page sur le filtrage des paramètres de requête. Le format attendu est une liste de valeurs séparées par des virgules. Les virgules doivent être encodées en pourcentage (remplacées par %2C) dans la variable d’environnement. Vous pouvez utiliser la fonction encode fournie dans l’extrait ci-dessous pour encoder la liste de valeurs :

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

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.filter_request_session_data`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`

Description

L’attribut de ressource filter_request_session_data vous permet de filtrer les données de session de requête définies dans l’attribut de span appsignal.request.session_data. Dans l’exemple ci-dessous, les valeurs des clés listées dans l’option de configuration filter_request_session_data sont remplacées par [FILTERED]. Pour en savoir plus, consultez la page sur le filtrage des données de session de requête. Le format attendu est une liste de valeurs séparées par des virgules. Les virgules doivent être encodées en pourcentage (remplacées par %2C) dans la variable d’environnement. Vous pouvez utiliser la fonction encode fournie dans l’extrait ci-dessous pour encoder la liste de valeurs :

Shell

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

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

ignore_actions

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.ignore_actions`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`

Description

Avec cette option de configuration, vous pouvez spécifier une liste d’actions qui seront ignorées par AppSignal. Tout ce qui s’y passe, y compris les exceptions, ne sera pas transmis à AppSignal. Cela peut être utile pour ignorer les endpoints de vérification d’état (health check) ou d’autres actions que vous ne souhaitez pas surveiller. Pour en savoir plus sur l’ignorance des actions. Le format attendu est une liste de valeurs séparées par des virgules. Les virgules doivent être encodées en pourcentage (remplacées par %2C) dans la variable d’environnement. Vous pouvez utiliser la fonction encode fournie dans l’extrait ci-dessous pour encoder la liste de valeurs :

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

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.ignore_errors`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`

Description

Cette option de configuration vous permet d’ignorer certaines erreurs spécifiques afin qu’elles ne soient pas signalées à AppSignal. Cela peut être utile pour ignorer des erreurs attendues ou des erreurs qui ne peuvent pas être résolues. Pour en savoir plus sur l’ignorance des erreurs. Le format attendu est une liste de valeurs séparées par des virgules. Les virgules doivent être encodées en pourcentage (remplacées par %2C) dans la variable d’environnement. Vous pouvez utiliser la fonction encode fournie dans l’extrait ci-dessous pour encoder la liste de valeurs :

Shell

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

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

ignore_logs

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.ignore_logs`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`

Description

Liste des messages de log qui seront ignorés. Tout message de log contenant l’un des éléments de la liste ne sera pas transmis à AppSignal. Un petit sous-ensemble de la syntaxe regex est pris en charge ; pour en savoir plus, consultez notre guide Ignorer les logs. Le format attendu est une liste de valeurs séparées par des virgules. Les virgules doivent être encodées en pourcentage (remplacées par %2C) dans la variable d’environnement. Vous pouvez utiliser la fonction encode fournie dans l’extrait ci-dessous pour encoder la liste de valeurs :

Shell

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

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

ignore_namespaces

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.ignore_namespaces`
Requis	non
Type	`list(String)`
Valeur par défaut	`[]`

Description

Cette option de configuration vous permet d’ignorer certains namespaces spécifiques afin qu’ils ne soient pas signalés à AppSignal. Cela peut être utile pour exclure de la surveillance certaines parties de votre application. Pour en savoir plus sur les namespaces. Le format attendu est une liste de valeurs séparées par des virgules. Les virgules doivent être encodées en pourcentage (remplacées par %2C) dans la variable d’environnement. Vous pouvez utiliser la fonction encode fournie dans l’extrait ci-dessous pour encoder la liste de valeurs :

Shell

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

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

request_headers

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.request_headers`
Requis	non
Type	`list(String)`
Valeur par défaut	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "host", "range"]`

Description

Configure les en-têtes de requête à inclure lorsqu’une requête est faite vers un serveur HTTP. Cette option est une liste d’autorisation. Elle inclut uniquement les en-têtes qui y sont configurés. Si la liste est vide, aucun en-tête n’est inclus. Les en-têtes de requête sont lus depuis les attributs de span OpenTelemetry http.request.header.<key>, où <key> correspond au nom de l’en-tête normalisé (en minuscules). Pour ne définir aucun en-tête, fixez explicitement la valeur de l’attribut de ressource à une valeur vide. Le format attendu est une liste de valeurs séparées par des virgules. Les virgules doivent être encodées en pourcentage (remplacées par %2C) dans la variable d’environnement. Vous pouvez utiliser la fonction encode fournie dans l’extrait ci-dessous pour encoder la liste de valeurs :

Shell

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

# Envoyer uniquement ces en-têtes spécifiques
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.request_headers=$(encode "accept,request_method,content_length"),\
  ..."

# N'envoyer aucun en-tête
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.request_headers=,\
  ..."

response_headers

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.response_headers`
Requis	non
Type	`list(String)`
Valeur par défaut	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "host", "range"]`

Description

Configure les en-têtes de réponse à inclure lorsqu’une requête est effectuée par un client HTTP. Cette option est une liste d’autorisation. Elle inclut uniquement les en-têtes qui y sont configurés. Si la liste est vide, aucun en-tête n’est inclus. Les en-têtes de réponse sont lus depuis les attributs de span OpenTelemetry http.response.header.<key>, où <key> correspond au nom de l’en-tête normalisé (en minuscules). Pour ne définir aucun en-tête, fixez explicitement la valeur de l’attribut de ressource à un tableau vide. Le format attendu est une liste de valeurs séparées par des virgules. Les virgules doivent être encodées en pourcentage (remplacées par %2C) dans la variable d’environnement. Vous pouvez utiliser la fonction encode fournie dans l’extrait ci-dessous pour encoder la liste de valeurs :

Shell

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

# Envoyer uniquement ces en-têtes spécifiques
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.response_headers=$(encode "accept,request_method,content_length"),\
  ..."

# N'envoyer aucun en-tête
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.response_headers=,\
  ..."

send_function_parameters

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.send_function_parameters`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`

Description

Indique si les paramètres de fonction doivent être inclus dans les traces. Si cette option est définie sur false, aucune de ces données n’est envoyée à nos serveurs. Ces valeurs sont définies via l’attribut de span appsignal.function.parameters.

Shell

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

send_request_payload

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.send_request_payload`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`

Description

Indique s’il faut envoyer les données de charge utile de requête dans les traces. Si cette option est définie sur false, aucune de ces données n’est envoyée à nos serveurs. Ces valeurs sont définies via l’attribut de span appsignal.request.payload. Pour en savoir plus, consultez la page sur le filtrage de la charge utile de requête.

Shell

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

send_request_query_parameters

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.send_request_query_parameters`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`

Description

Indique s’il faut inclure les paramètres de requête (query parameters) dans les traces. Si cette option est définie sur false, aucune de ces données n’est envoyée à nos serveurs. Ces valeurs sont définies via l’attribut de span appsignal.request.query_parameters. Pour en savoir plus, consultez la page sur le filtrage des paramètres de requête.

Shell

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

send_request_session_data

Champ	Valeur
Clé d’attribut de ressource	`appsignal.config.send_request_session_data`
Requis	non
Type	Booléen (`true` / `false`)
Valeur par défaut	`true`

Description

Indique s’il faut envoyer les données de session de requête dans les traces. Si cette option est définie sur false, aucune de ces données n’est envoyée à nos serveurs. Ces valeurs sont définies via l’attribut de span appsignal.request.session_data. Pour en savoir plus, consultez la page sur le filtrage des données de session de requête.

Shell

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

​Options disponibles

​environment

​Description

​host.name

​Description

​language_integration

​Description

​name

​Description

​push_api_key

​Description

​revision

​Description

​service.name

​Description

​app_path

​Description

​filter_attributes

​Description

​filter_function_parameters

​Description

​filter_request_payload

​Description

​filter_request_query_parameters

​Description

​filter_request_session_data

​Description

​ignore_actions

​Description

​ignore_errors

​Description

​ignore_logs

​Description

​ignore_namespaces

​Description

​request_headers

​Description

​response_headers

​Description

​send_function_parameters

​Description

​send_request_payload

​Description

​send_request_query_parameters

​Description

​send_request_session_data

​Description

Options disponibles

environment

Description

host.name

Description

language_integration

Description

name

Description

push_api_key

Description

revision

Description

service.name

Description

app_path

Description

filter_attributes

Description

filter_function_parameters

Description

filter_request_payload

Description

filter_request_query_parameters

Description

filter_request_session_data

Description

ignore_actions

Description

ignore_errors

Description

ignore_logs

Description

ignore_namespaces

Description

request_headers

Description

response_headers

Description

send_function_parameters

Description

send_request_payload

Description

send_request_query_parameters

Description

send_request_session_data

Description