Opções de configuração do Java - AppSignal Documentation

O AppSignal for Java pode ser configurado através de atributos de resource do OpenTelemetry. Atributos de resource são atributos aplicados a cada trace reportado pela aplicação usando OpenTelemetry. Esses atributos de resource devem ser configurados na sua aplicação usando variáveis de ambiente, onde você também configura o exporter do OpenTelemetry para exportar dados para o collector do AppSignal. Para configurar os atributos de resource, defina uma variável de ambiente OTEL_RESOURCE_ATTRIBUTES, conforme mostrado abaixo:

Shell

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

environment

Campo	Valor
Chave do atributo de recurso	`appsignal.config.environment`
Obrigatório	sim
Tipo	`String`
Valor padrão	nil (Não definido por padrão)

Descrição

O ambiente da aplicação a ser reportado ao AppSignal.

Shell

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

Observação: Alterar o nome ou o ambiente de uma aplicação existente criará uma nova aplicação no AppSignal.com.

host.name

Campo	Valor
Chave do atributo de recurso	`host.name`
Obrigatório	sim
Tipo	`String`
Valor padrão	detectado a partir do sistema

Descrição

O atributo de recurso host.name ajuda o AppSignal a reconhecer diferentes hosts em traces e marcar os traces automaticamente com o hostname.

Shell

HOST_NAME=$(hostname || echo unknown)

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

language_integration

Campo	Valor
Chave do atributo de recurso	`appsignal.config.language_integration`
Obrigatório	sim
Tipo	`String`
Valor padrão	nil (Não é definido por padrão)

Descrição

O AppSignal usa o atributo de recurso language_integration para detectar a linguagem de um trace e analisar corretamente os backtraces de exceção. Para definir essa opção, especifique o nome da linguagem em formato minúsculo: java.

Shell

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

name

Campo	Valor
Chave do atributo de recurso	`appsignal.config.name`
Obrigatório	sim
Tipo	`String`
Valor padrão	nil (Não é definido por padrão)

Descrição

Nome da sua aplicação como ele deve ser exibido no AppSignal.com.

Shell

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

Nota: Alterar o nome ou o ambiente de uma aplicação existente criará uma nova aplicação no AppSignal.com.

push_api_key

Campo	Valor
Chave do atributo de recurso	`appsignal.config.push_api_key`
Obrigatório	sim
Tipo	`String`
Valor padrão	nil (Não é definido por padrão)

Descrição

A chave de autenticação no nível da organização para autenticar com nossa Push API. Leia mais sobre a chave da Push API do AppSignal.

Shell

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

revision

Campo	Valor
Chave do atributo de recurso	`appsignal.config.revision`
Obrigatório	sim
Tipo	`String`
Valor padrão	nil (Não é definido por padrão)

Descrição

Defina a revisão da aplicação para reportar a versão atualmente em execução. O AppSignal criará um marcador de deploy quando esse valor mudar e marcará todos os dados recebidos com a revisão atual. Leia mais sobre marcadores de deploy no tópico sobre marcadores de deploy.

Shell

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

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

service.name

Campo	Valor
Chave do atributo de recurso	`service.name`
Obrigatório	sim
Tipo	`String`
Valor padrão	nil (Não é definido por padrão)

Descrição

O atributo de recurso service.name ajuda o AppSignal a reconhecer diferentes serviços em traces e agrupa automaticamente os traces em um namespace com base no nome do serviço. Escolha um nome que se encaixe na sua aplicação, como “Web server”, “Background worker”, “Email service”, “Authentication service”, etc.

Shell

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

app_path

Campo	Valor
Chave do atributo de recurso	`appsignal.config.app_path`
Obrigatório	não
Tipo	`String`
Valor padrão	nil (Não definido por padrão)

Descrição

A localização da aplicação no sistema de arquivos do host. O atributo de recurso app_path ajuda o AppSignal a limpar os backtraces removendo o caminho absoluto da aplicação das linhas do backtrace. Dessa forma, apenas os caminhos dentro do contexto do diretório do projeto são exibidos. Isso possibilita o nosso recurso de Backtrace links.

Shell

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

filter_attributes

Campo	Valor
Chave do atributo de recurso	`appsignal.config.filter_attributes`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`[]`

Descrição

O atributo de recurso filter_attributes permite filtrar atributos específicos para que não sejam reportados ao AppSignal. Isso pode ser útil para evitar que informações sensíveis ou irrelevantes sejam reportadas. Se um atributo for filtrado dessa forma, ele não aparecerá de forma alguma na interface. O formato esperado é uma lista de valores separados por vírgulas. As vírgulas devem ser codificadas em percentual (substituídas por %2C) na variável de ambiente. Você pode usar a função encode fornecida no trecho abaixo para codificar a lista de valores:

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

Campo	Valor
Chave do atributo de recurso	`appsignal.config.filter_function_parameters`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`[]`

Descrição

Esse atributo de recurso permite filtrar quaisquer parâmetros de função definidos no atributo de span appsignal.function.parameters. No exemplo abaixo, os valores das chaves listadas na opção de configuração filter_function_parameters são substituídos por [FILTERED]. O formato esperado é uma lista de valores separados por vírgulas. As vírgulas devem ser codificadas em percentual (substituídas por %2C) na variável de ambiente. Você pode usar a função encode fornecida no trecho abaixo para codificar a lista de valores:

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

Campo	Valor
Chave do atributo de recurso	`appsignal.config.filter_request_payload`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`[]`

Descrição

Esse atributo de recurso permite filtrar quaisquer dados de payload de requisição definidos no atributo de span appsignal.request.payload. No exemplo abaixo, os valores das chaves listadas na opção de configuração filter_request_payload são substituídos por [FILTERED]. Leia mais sobre filtragem de parâmetros de consulta de requisição. O formato esperado é uma lista de valores separados por vírgulas. As vírgulas devem ser codificadas em percentual (substituídas por %2C) na variável de ambiente. Você pode usar a função encode fornecida no trecho abaixo para codificar a lista de valores:

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

Campo	Valor
Chave do atributo de recurso	`appsignal.config.filter_request_query_parameters`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`[]`

Descrição

Esse atributo de recurso permite filtrar quaisquer parâmetros de consulta de requisição definidos no atributo de span appsignal.request.query_parameters. No exemplo abaixo, os valores das chaves listadas na opção de configuração filter_request_query_parameters são substituídos por [FILTERED]. Leia mais sobre filtragem de parâmetros de consulta de requisição. O formato esperado é uma lista de valores separados por vírgulas. As vírgulas devem ser codificadas em percentual (substituídas por %2C) na variável de ambiente. Você pode usar a função encode fornecida no trecho abaixo para codificar a lista de valores:

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

Campo	Valor
Chave do atributo de recurso	`appsignal.config.filter_request_session_data`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`[]`

Descrição

O atributo de recurso filter_request_session_data permite filtrar quaisquer dados de sessão de requisição definidos no atributo de span appsignal.request.session_data. No exemplo abaixo, os valores das chaves listadas na opção de configuração filter_request_session_data são substituídos por [FILTERED]. Leia mais sobre filtragem de dados de sessão de requisição. O formato esperado é uma lista de valores separados por vírgulas. As vírgulas devem ser codificadas em percentual (substituídas por %2C) na variável de ambiente. Você pode usar a função encode fornecida no trecho abaixo para codificar a lista de valores:

Shell

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

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

ignore_actions

Campo	Valor
Chave do atributo de recurso	`appsignal.config.ignore_actions`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`[]`

Descrição

Com essa opção de configuração você pode especificar uma lista de actions que serão ignoradas pelo AppSignal. Tudo o que acontecer, incluindo exceções, não será transmitido ao AppSignal. Isso pode ser útil para ignorar endpoints de health check ou outras actions que você não quer monitorar. Leia mais sobre como ignorar actions. O formato esperado é uma lista de valores separados por vírgulas. As vírgulas devem ser codificadas em percentual (substituídas por %2C) na variável de ambiente. Você pode usar a função encode fornecida no trecho abaixo para codificar a lista de valores:

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

Campo	Valor
Chave do atributo de recurso	`appsignal.config.ignore_errors`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`[]`

Descrição

Essa opção de configuração permite que você ignore erros específicos para que não sejam reportados ao AppSignal. Isso pode ser útil para ignorar erros esperados ou erros que não podem ser resolvidos. Leia mais sobre como ignorar erros. O formato esperado é uma lista de valores separados por vírgulas. As vírgulas devem ser codificadas em percentual (substituídas por %2C) na variável de ambiente. Você pode usar a função encode fornecida no trecho abaixo para codificar a lista de valores:

Shell

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

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

ignore_logs

Campo	Valor
Chave do atributo de recurso	`appsignal.config.ignore_logs`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`[]`

Descrição

Lista de mensagens de log que serão ignoradas. Qualquer mensagem de log que contenha algum dos elementos da lista não será transmitida ao AppSignal. Um pequeno subconjunto de sintaxe regex é suportado, leia mais sobre isso em nosso guia Ignore Logs. O formato esperado é uma lista de valores separados por vírgulas. As vírgulas devem ser codificadas em percentual (substituídas por %2C) na variável de ambiente. Você pode usar a função encode fornecida no trecho abaixo para codificar a lista de valores:

Shell

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

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

ignore_namespaces

Campo	Valor
Chave do atributo de recurso	`appsignal.config.ignore_namespaces`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`[]`

Descrição

Essa opção de configuração permite que você ignore namespaces específicos para que não sejam reportados ao AppSignal. Isso pode ser útil para ignorar partes específicas da sua aplicação que você não quer monitorar. Leia mais sobre namespaces. O formato esperado é uma lista de valores separados por vírgulas. As vírgulas devem ser codificadas em percentual (substituídas por %2C) na variável de ambiente. Você pode usar a função encode fornecida no trecho abaixo para codificar a lista de valores:

Shell

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

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

request_headers

Campo	Valor
Chave do atributo de recurso	`appsignal.config.request_headers`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "host", "range"]`

Descrição

Configure quais cabeçalhos de requisição incluir quando uma requisição é feita a um servidor HTTP. Essa opção é uma allowlist. Ela inclui apenas os cabeçalhos que estão configurados. Se a lista estiver vazia, nenhum cabeçalho será incluído. Os cabeçalhos de requisição são lidos dos atributos de span do OpenTelemetry http.request.header.<key>, onde <key> é o nome do cabeçalho normalizado (minúsculo). Para não definir nenhum cabeçalho, defina explicitamente o valor do atributo de recurso como um valor vazio. O formato esperado é uma lista de valores separados por vírgulas. As vírgulas devem ser codificadas em percentual (substituídas por %2C) na variável de ambiente. Você pode usar a função encode fornecida no trecho abaixo para codificar a lista de valores:

Shell

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

# Enviar apenas esses cabeçalhos específicos
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.request_headers=$(encode "accept,request_method,content_length"),\
  ..."

# Não enviar nenhum cabeçalho
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.request_headers=,\
  ..."

response_headers

Campo	Valor
Chave do atributo de recurso	`appsignal.config.response_headers`
Obrigatório	não
Tipo	`list(String)`
Valor padrão	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "host", "range"]`

Descrição

Configure quais cabeçalhos de resposta incluir quando uma requisição é feita por um cliente HTTP. Essa opção é uma allowlist. Ela inclui apenas os cabeçalhos que estão configurados. Se a lista estiver vazia, nenhum cabeçalho será incluído. Os cabeçalhos de resposta são lidos dos atributos de span do OpenTelemetry http.response.header.<key>, onde <key> é o nome do cabeçalho normalizado (minúsculo). Para não definir nenhum cabeçalho, defina explicitamente o valor do atributo de recurso como um array vazio. O formato esperado é uma lista de valores separados por vírgulas. As vírgulas devem ser codificadas em percentual (substituídas por %2C) na variável de ambiente. Você pode usar a função encode fornecida no trecho abaixo para codificar a lista de valores:

Shell

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

# Enviar apenas esses cabeçalhos específicos
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.response_headers=$(encode "accept,request_method,content_length"),\
  ..."

# Não enviar nenhum cabeçalho
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.response_headers=,\
  ..."

send_function_parameters

Campo	Valor
Chave do atributo de recurso	`appsignal.config.send_function_parameters`
Obrigatório	não
Tipo	Boolean (`true` / `false`)
Valor padrão	`true`

Descrição

Configure se os parâmetros de função devem ser incluídos nos traces. Se definido como false, esses dados não são enviados aos nossos servidores. Esses valores são definidos com o atributo de span appsignal.function.parameters.

Shell

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

send_request_payload

Campo	Valor
Chave do atributo de recurso	`appsignal.config.send_request_payload`
Obrigatório	não
Tipo	Boolean (`true` / `false`)
Valor padrão	`true`

Descrição

Configure se os dados de payload de requisição devem ser enviados nos traces. Se definido como false, esses dados não são enviados aos nossos servidores. Esses valores são definidos com o atributo de span appsignal.request.payload. Para mais informações, leia sobre filtragem de payload de requisição.

Shell

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

send_request_query_parameters

Campo	Valor
Chave do atributo de recurso	`appsignal.config.send_request_query_parameters`
Obrigatório	não
Tipo	Boolean (`true` / `false`)
Valor padrão	`true`

Descrição

Configure se os parâmetros de consulta de requisição devem ser incluídos nos traces. Se definido como false, esses dados não são enviados aos nossos servidores. Esses valores são definidos com o atributo de span appsignal.request.query_parameters. Para mais informações, leia sobre filtragem de parâmetros de requisição.

Shell

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

send_request_session_data

Campo	Valor
Chave do atributo de recurso	`appsignal.config.send_request_session_data`
Obrigatório	não
Tipo	Boolean (`true` / `false`)
Valor padrão	`true`

Descrição

Configure se os dados de sessão de requisição devem ser enviados nos traces. Se definido como false, esses dados não são enviados aos nossos servidores. Esses valores são definidos com o atributo de span appsignal.request.session_data. Para mais informações, leia sobre filtragem de dados de sessão de requisição.

Shell

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

​Opções disponíveis

​environment

​Descrição

​host.name

​Descrição

​language_integration

​Descrição

​name

​Descrição

​push_api_key

​Descrição

​revision

​Descrição

​service.name

​Descrição

​app_path

​Descrição

​filter_attributes

​Descrição

​filter_function_parameters

​Descrição

​filter_request_payload

​Descrição

​filter_request_query_parameters

​Descrição

​filter_request_session_data

​Descrição

​ignore_actions

​Descrição

​ignore_errors

​Descrição

​ignore_logs

​Descrição

​ignore_namespaces

​Descrição

​request_headers

​Descrição

​response_headers

​Descrição

​send_function_parameters

​Descrição

​send_request_payload

​Descrição

​send_request_query_parameters

​Descrição

​send_request_session_data

​Descrição

Opções disponíveis

environment

Descrição

host.name

Descrição

language_integration

Descrição

name

Descrição

push_api_key

Descrição

revision

Descrição

service.name

Descrição

app_path

Descrição

filter_attributes

Descrição

filter_function_parameters

Descrição

filter_request_payload

Descrição

filter_request_query_parameters

Descrição

filter_request_session_data

Descrição

ignore_actions

Descrição

ignore_errors

Descrição

ignore_logs

Descrição

ignore_namespaces

Descrição

request_headers

Descrição

response_headers

Descrição

send_function_parameters

Descrição

send_request_payload

Descrição

send_request_query_parameters

Descrição

send_request_session_data

Descrição