Java-Konfigurationsoptionen - AppSignal Documentation

AppSignal für Java kann über OpenTelemetry-Resource-Attribute konfiguriert werden. Resource-Attribute sind Attribute, die für jeden Trace gelten, der von der Anwendung über OpenTelemetry gemeldet wird. Diese Resource-Attribute sollten in Ihrer Anwendung über Umgebungsvariablen konfiguriert werden, dort, wo Sie auch den OpenTelemetry-Exporter so konfigurieren, dass er an den AppSignal-Collector exportiert. Um die Resource-Attribute zu konfigurieren, setzen Sie die Umgebungsvariable OTEL_RESOURCE_ATTRIBUTES wie unten gezeigt:

Shell

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

environment

Feld	Wert
Resource-Attribut-Schlüssel	`appsignal.config.environment`
Erforderlich	ja
Typ	`String`
Standardwert	nil (Standardmäßig nicht gesetzt)

Beschreibung

Die Umgebung der App, die an AppSignal gemeldet werden soll.

Shell

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

Hinweis: Das Ändern des Namens oder der Umgebung einer bestehenden App erstellt eine neue App auf AppSignal.com.

host.name

Feld	Wert
Resource-Attributschlüssel	`host.name`
Erforderlich	ja
Typ	`String`
Standardwert	vom System erkannt

Beschreibung

Das Resource-Attribut host.name hilft AppSignal dabei, verschiedene Hosts für Traces zu erkennen, und versieht die Traces automatisch mit dem Hostnamen.

Shell

HOST_NAME=$(hostname || echo unknown)

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

language_integration

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.language_integration`
Erforderlich	ja
Typ	`String`
Standardwert	nil (standardmäßig nicht gesetzt)

Beschreibung

AppSignal verwendet das Resource-Attribut language_integration, um die Sprache eines Traces zu erkennen und Ausnahme-Backtraces korrekt zu parsen. Um diese Option zu setzen, geben Sie den Sprachnamen in Kleinbuchstaben an: java.

Shell

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

name

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.name`
Erforderlich	ja
Typ	`String`
Standardwert	nil (standardmäßig nicht gesetzt)

Beschreibung

Name Ihrer Anwendung, wie er auf AppSignal.com angezeigt werden soll.

Shell

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

Hinweis: Das Ändern des Namens oder der Umgebung einer bestehenden App erzeugt eine neue App auf AppSignal.com.

push_api_key

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.push_api_key`
Erforderlich	ja
Typ	`String`
Standardwert	nil (standardmäßig nicht gesetzt)

Beschreibung

Der Authentifizierungsschlüssel auf Organisationsebene zur Authentifizierung bei unserer Push-API. Lesen Sie mehr über den AppSignal Push-API-Schlüssel.

Shell

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

revision

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.revision`
Erforderlich	ja
Typ	`String`
Standardwert	nil (standardmäßig nicht gesetzt)

Beschreibung

Setzen Sie die App-Revision, um die aktuell laufende Version Ihrer App zu melden. AppSignal erstellt einen Deploy-Marker, wenn sich dieser Wert ändert, und versieht alle eingehenden Daten mit der aktuellen Revision. Lesen Sie mehr über Deploy-Marker im Themenbereich Deploy-Marker.

Shell

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

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

service.name

Feld	Wert
Resource-Attributschlüssel	`service.name`
Erforderlich	ja
Typ	`String`
Standardwert	nil (standardmäßig nicht gesetzt)

Beschreibung

Das Resource-Attribut service.name hilft AppSignal dabei, verschiedene Dienste für Traces zu erkennen, und gruppiert die Traces basierend auf dem Dienstnamen automatisch in einem Namespace. Wählen Sie einen Namen, der zu Ihrer Anwendung passt, wie z. B. “Web server”, “Background worker”, “Email service”, “Authentication service” usw.

Shell

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

app_path

Feld	Wert
Resource-Attribut-Schlüssel	`appsignal.config.app_path`
Erforderlich	nein
Typ	`String`
Standardwert	nil (Standardmäßig nicht gesetzt)

Beschreibung

Der Speicherort der App im Dateisystem des Hosts. Das Resource-Attribut app_path hilft AppSignal beim Aufräumen von Backtraces, indem es den absoluten App-Pfad aus den Backtrace-Zeilen entfernt. So werden nur Pfade innerhalb des Kontexts des Projektverzeichnisses angezeigt. Dies macht unsere Funktion Backtrace-Links möglich.

Shell

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

filter_attributes

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.filter_attributes`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

Mit dem Resource-Attribut filter_attributes können Sie bestimmte Attribute davon ausschließen, an AppSignal gemeldet zu werden. Dies kann nützlich sein, um sensible oder nicht relevante Informationen aus der Meldung herauszufiltern. Wird ein Attribut auf diese Weise herausgefiltert, erscheint es überhaupt nicht in der Oberfläche. Das erwartete Format ist eine durch Kommas getrennte Liste von Werten. Die Kommas müssen in der Umgebungsvariablen prozentcodiert (durch %2C ersetzt) werden. Sie können die im folgenden Snippet bereitgestellte Funktion encode verwenden, um die Liste der Werte zu codieren:

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

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.filter_function_parameters`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

Mit diesem Resource-Attribut können Sie beliebige Funktionsparameter herausfiltern, die im appsignal.function.parameters-Span-Attribut gesetzt sind. Im folgenden Beispiel werden die Werte für die in der Konfigurationsoption filter_function_parameters aufgeführten Schlüssel durch [FILTERED] ersetzt. Das erwartete Format ist eine durch Kommas getrennte Liste von Werten. Die Kommas müssen in der Umgebungsvariablen prozentcodiert (durch %2C ersetzt) werden. Sie können die im folgenden Snippet bereitgestellte Funktion encode verwenden, um die Liste der Werte zu codieren:

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

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.filter_request_payload`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

Mit diesem Resource-Attribut können Sie beliebige Request-Payload-Daten herausfiltern, die im appsignal.request.payload-Span-Attribut gesetzt sind. Im folgenden Beispiel werden die Werte für die in der Konfigurationsoption filter_request_payload aufgeführten Schlüssel durch [FILTERED] ersetzt. Lesen Sie mehr über Filterung von Request-Query-Parametern. Das erwartete Format ist eine durch Kommas getrennte Liste von Werten. Die Kommas müssen in der Umgebungsvariablen prozentcodiert (durch %2C ersetzt) werden. Sie können die im folgenden Snippet bereitgestellte Funktion encode verwenden, um die Liste der Werte zu codieren:

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

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.filter_request_query_parameters`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

Mit diesem Resource-Attribut können Sie beliebige Request-Query-Parameter herausfiltern, die im appsignal.request.query_parameters-Span-Attribut gesetzt sind. Im folgenden Beispiel werden die Werte für die in der Konfigurationsoption filter_request_query_parameters aufgeführten Schlüssel durch [FILTERED] ersetzt. Lesen Sie mehr über Filterung von Request-Query-Parametern. Das erwartete Format ist eine durch Kommas getrennte Liste von Werten. Die Kommas müssen in der Umgebungsvariablen prozentcodiert (durch %2C ersetzt) werden. Sie können die im folgenden Snippet bereitgestellte Funktion encode verwenden, um die Liste der Werte zu codieren:

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

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.filter_request_session_data`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

Mit dem Resource-Attribut filter_request_session_data können Sie beliebige Request-Sitzungsdaten herausfiltern, die im appsignal.request.session_data-Span-Attribut gesetzt sind. Im folgenden Beispiel werden die Werte für die in der Konfigurationsoption filter_request_session_data aufgeführten Schlüssel durch [FILTERED] ersetzt. Lesen Sie mehr über Filterung von Request-Sitzungsdaten. Das erwartete Format ist eine durch Kommas getrennte Liste von Werten. Die Kommas müssen in der Umgebungsvariablen prozentcodiert (durch %2C ersetzt) werden. Sie können die im folgenden Snippet bereitgestellte Funktion encode verwenden, um die Liste der Werte zu codieren:

Shell

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

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

ignore_actions

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.ignore_actions`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

Mit dieser Konfigurationsoption können Sie eine Liste von Aktionen angeben, die von AppSignal ignoriert werden. Alles, was passiert, einschließlich Ausnahmen, wird nicht an AppSignal übertragen. Dies kann nützlich sein, um Health-Check-Endpunkte oder andere Aktionen zu ignorieren, die Sie nicht überwachen möchten. Lesen Sie mehr über das Ignorieren von Aktionen. Das erwartete Format ist eine durch Kommas getrennte Liste von Werten. Die Kommas müssen in der Umgebungsvariablen prozentcodiert (durch %2C ersetzt) werden. Sie können die im folgenden Snippet bereitgestellte Funktion encode verwenden, um die Liste der Werte zu codieren:

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

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.ignore_errors`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

Mit dieser Konfigurationsoption können Sie bestimmte Fehler davon ausschließen, an AppSignal gemeldet zu werden. Dies kann nützlich sein, um erwartete Fehler oder Fehler zu ignorieren, die nicht behoben werden können. Lesen Sie mehr über das Ignorieren von Fehlern. Das erwartete Format ist eine durch Kommas getrennte Liste von Werten. Die Kommas müssen in der Umgebungsvariablen prozentcodiert (durch %2C ersetzt) werden. Sie können die im folgenden Snippet bereitgestellte Funktion encode verwenden, um die Liste der Werte zu codieren:

Shell

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

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

ignore_logs

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.ignore_logs`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

Liste von Protokollnachrichten, die ignoriert werden. Jede Protokollnachricht, die eines der Elemente der Liste enthält, wird nicht an AppSignal übertragen. Eine kleine Untermenge der Regex-Syntax wird unterstützt; lesen Sie mehr dazu in unserem Leitfaden Protokolle ignorieren. Das erwartete Format ist eine durch Kommas getrennte Liste von Werten. Die Kommas müssen in der Umgebungsvariablen prozentcodiert (durch %2C ersetzt) werden. Sie können die im folgenden Snippet bereitgestellte Funktion encode verwenden, um die Liste der Werte zu codieren:

Shell

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

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

ignore_namespaces

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.ignore_namespaces`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`[]`

Beschreibung

Mit dieser Konfigurationsoption können Sie bestimmte Namespaces davon ausschließen, an AppSignal gemeldet zu werden. Dies kann nützlich sein, um bestimmte Teile Ihrer Anwendung von der Überwachung auszuschließen. Lesen Sie mehr über Namespaces. Das erwartete Format ist eine durch Kommas getrennte Liste von Werten. Die Kommas müssen in der Umgebungsvariablen prozentcodiert (durch %2C ersetzt) werden. Sie können die im folgenden Snippet bereitgestellte Funktion encode verwenden, um die Liste der Werte zu codieren:

Shell

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

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

request_headers

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.request_headers`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "host", "range"]`

Beschreibung

Konfigurieren Sie, welche Request-Header einbezogen werden sollen, wenn eine Anfrage an einen HTTP-Server gestellt wird. Diese Option ist eine Zulassungsliste. Es werden nur die Header einbezogen, die konfiguriert sind. Ist die Liste leer, werden keine Header einbezogen. Die Request-Header werden aus den OpenTelemetry-Span-Attributen http.request.header.<key> gelesen, wobei <key> der normalisierte Header-Name (Kleinbuchstaben) ist. Um keine Header zu setzen, setzen Sie den Wert des Resource-Attributs explizit auf einen leeren Wert. Das erwartete Format ist eine durch Kommas getrennte Liste von Werten. Die Kommas müssen in der Umgebungsvariablen prozentcodiert (durch %2C ersetzt) werden. Sie können die im folgenden Snippet bereitgestellte Funktion encode verwenden, um die Liste der Werte zu codieren:

Shell

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

# Only send these specific headers
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.request_headers=$(encode "accept,request_method,content_length"),\
  ..."

# Do not send any headers
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.request_headers=,\
  ..."

response_headers

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.response_headers`
Erforderlich	nein
Typ	`list(String)`
Standardwert	`["accept", "accept-charset", "accept-encoding", "accept-language", "cache-control", "connection", "content-length", "host", "range"]`

Beschreibung

Konfigurieren Sie, welche Response-Header einbezogen werden sollen, wenn eine Anfrage von einem HTTP-Client gestellt wird. Diese Option ist eine Zulassungsliste. Es werden nur die Header einbezogen, die konfiguriert sind. Ist die Liste leer, werden keine Header einbezogen. Die Response-Header werden aus den OpenTelemetry-Span-Attributen http.response.header.<key> gelesen, wobei <key> der normalisierte Header-Name (Kleinbuchstaben) ist. Um keine Header zu setzen, setzen Sie den Wert des Resource-Attributs explizit auf ein leeres Array. Das erwartete Format ist eine durch Kommas getrennte Liste von Werten. Die Kommas müssen in der Umgebungsvariablen prozentcodiert (durch %2C ersetzt) werden. Sie können die im folgenden Snippet bereitgestellte Funktion encode verwenden, um die Liste der Werte zu codieren:

Shell

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

# Only send these specific headers
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.response_headers=$(encode "accept,request_method,content_length"),\
  ..."

# Do not send any headers
export OTEL_RESOURCE_ATTRIBUTES="\
  appsignal.config.response_headers=,\
  ..."

send_function_parameters

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.send_function_parameters`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`

Beschreibung

Konfigurieren Sie, ob Funktionsparameter in Traces einbezogen werden sollen. Wenn auf false gesetzt, werden keine solchen Daten an unsere Server gesendet. Diese Werte werden über das appsignal.function.parameters-Span-Attribut gesetzt.

Shell

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

send_request_payload

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.send_request_payload`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`

Beschreibung

Konfigurieren Sie, ob Request-Payload-Daten in Traces gesendet werden sollen. Wenn auf false gesetzt, werden keine solchen Daten an unsere Server gesendet. Diese Werte werden über das appsignal.request.payload-Span-Attribut gesetzt. Weitere Informationen finden Sie unter Filterung von Request-Payloads.

Shell

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

send_request_query_parameters

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.send_request_query_parameters`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`

Beschreibung

Konfigurieren Sie, ob Request-Query-Parameter in Traces einbezogen werden sollen. Wenn auf false gesetzt, werden keine solchen Daten an unsere Server gesendet. Diese Werte werden über das appsignal.request.query_parameters-Span-Attribut gesetzt. Weitere Informationen finden Sie unter Filterung von Request-Parametern.

Shell

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

send_request_session_data

Feld	Wert
Resource-Attributschlüssel	`appsignal.config.send_request_session_data`
Erforderlich	nein
Typ	Boolean (`true` / `false`)
Standardwert	`true`

Beschreibung

Konfigurieren Sie, ob Request-Sitzungsdaten in Traces gesendet werden sollen. Wenn auf false gesetzt, werden keine solchen Daten an unsere Server gesendet. Diese Werte werden über das appsignal.request.session_data-Span-Attribut gesetzt. Weitere Informationen finden Sie unter Filterung von Request-Sitzungsdaten.

Shell

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

​Verfügbare Optionen

​environment

​Beschreibung

​host.name

​Beschreibung

​language_integration

​Beschreibung

​name

​Beschreibung

​push_api_key

​Beschreibung

​revision

​Beschreibung

​service.name

​Beschreibung

​app_path

​Beschreibung

​filter_attributes

​Beschreibung

​filter_function_parameters

​Beschreibung

​filter_request_payload

​Beschreibung

​filter_request_query_parameters

​Beschreibung

​filter_request_session_data

​Beschreibung

​ignore_actions

​Beschreibung

​ignore_errors

​Beschreibung

​ignore_logs

​Beschreibung

​ignore_namespaces

​Beschreibung

​request_headers

​Beschreibung

​response_headers

​Beschreibung

​send_function_parameters

​Beschreibung

​send_request_payload

​Beschreibung

​send_request_query_parameters

​Beschreibung

​send_request_session_data

​Beschreibung

Verfügbare Optionen

environment

Beschreibung

host.name

Beschreibung

language_integration

Beschreibung

name

Beschreibung

push_api_key

Beschreibung

revision

Beschreibung

service.name

Beschreibung

app_path

Beschreibung

filter_attributes

Beschreibung

filter_function_parameters

Beschreibung

filter_request_payload

Beschreibung

filter_request_query_parameters

Beschreibung

filter_request_session_data

Beschreibung

ignore_actions

Beschreibung

ignore_errors

Beschreibung

ignore_logs

Beschreibung

ignore_namespaces

Beschreibung

request_headers

Beschreibung

response_headers

Beschreibung

send_function_parameters

Beschreibung

send_request_payload

Beschreibung

send_request_query_parameters

Beschreibung

send_request_session_data

Beschreibung