Go-Konfigurationsoptionen - AppSignal Documentation

AppSignal für Go 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 konfiguriert werden, dort, wo Sie auch den OpenTelemetry-Exporter so konfigurieren, dass er an den AppSignal-Collector exportiert. Um die Resource-Attribute zu konfigurieren, fügen Sie Ihrem Tracer-Provider eine Resource hinzu, wie unten gezeigt.

import (
	// Other imports here...

	// Import these OpenTelemetry packages
	"go.opentelemetry.io/otel"
	"go.opentelemetry.io/otel/attribute"
	"go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp"
	"go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp"
	"go.opentelemetry.io/otel/exporters/otlp/otlptrace"
	"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp"
	"go.opentelemetry.io/otel/log/global"
	"go.opentelemetry.io/otel/propagation"
	sdklog "go.opentelemetry.io/otel/sdk/log"
	sdkmetric "go.opentelemetry.io/otel/sdk/metric"
	sdkresource "go.opentelemetry.io/otel/sdk/resource"
	sdktrace "go.opentelemetry.io/otel/sdk/trace"
)

func initTracer() func(context.Context) error {
	// OpenTelemetry config setup here

	resource, err := sdkresource.Merge(
		sdkresource.Default(),
		sdkresource.NewSchemaless(
			resource.WithAttributes(attribute.String("appsignal.config.name", "My app name")),

			// And other resource attributes
		),
	)

	tracerProvider := sdktrace.NewTracerProvider(
		// Including other `.With...` function calls
		sdktrace.WithResource(resource),
	)

	// Followed by the rest of the OpenTelemetry config
}

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.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.String("appsignal.config.environment", "production")),

		// And other resource attributes
	),
)

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

host.name

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

Beschreibung

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

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.String("host.name", "my-hostname")),

		// And other resource attributes
	),
)

language_integration

Feld	Wert
Resource-Attribut-Schlü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 Trace zu erkennen und Exception-Backtraces korrekt zu parsen. Um diese Option zu setzen, geben Sie den Sprachnamen in Kleinschreibung an: go.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.String("appsignal.config.language_integration", "go")),

		// And other resource attributes
	),
)

name

Feld	Wert
Resource-Attribut-Schlü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.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.String("appsignal.config.name", "My awesome app")),

		// And other resource attributes
	),
)

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

push_api_key

Feld	Wert
Resource-Attribut-Schlü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 key.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.String("appsignal.config.push_api_key", "00000000-0000-0000-0000-000000000000")),

		// And other resource attributes
	),
)

revision

Feld	Wert
Resource-Attribut-Schlü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 Thema Deploy-Marker.

import (
	"os/exec"

	// And other imports
)

var revision string
cmd := exec.Command("git", "rev-parse", "--short", "HEAD")
output, err := cmd.Output()
if err != nil {
	revision = "unknown"
} else {
	revision = strings.TrimSpace(string(output))
}

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.String("appsignal.config.revision", revision)),

		// And other resource attributes
	),
)

service.name

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

Beschreibung

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

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.String("service.name", "My service name")),

		// And other resource attributes
	),
)

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.

import (
	"os"

	// And other imports
)

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.String("appsignal.config.app_path", os.Getenv("PWD"))),

		// And other resource attributes
	),
)

filter_attributes

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

Beschreibung

Das Resource-Attribut filter_attributes ermöglicht es Ihnen, bestimmte Attribute davon auszuschließen, an AppSignal gemeldet zu werden. Dies kann nützlich sein, um sensible oder nicht relevante Informationen davon auszuschließen, gemeldet zu werden. Wenn ein Attribut auf diese Weise herausgefiltert wird, erscheint es überhaupt nicht in der Oberfläche.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.StringSlice("appsignal.config.filter_attributes", []string{"my.secret.attribute", "some.opentelemetry.attribute"})),

		// And other resource attributes
	),
)

filter_function_parameters

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

Beschreibung

Dieses Resource-Attribut ermöglicht es Ihnen, beliebige Funktionsparameter herauszufiltern, die im Span-Attribut appsignal.function.parameters gesetzt sind. Im folgenden Beispiel werden die Werte für die in der Konfigurationsoption filter_function_parameters aufgeführten Schlüssel durch [FILTERED] ersetzt.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.StringSlice("appsignal.config.filter_function_parameters", []string{"api_token", "secret"})),

		// And other resource attributes
	),
)

filter_request_payload

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

Beschreibung

Dieses Resource-Attribut ermöglicht es Ihnen, beliebige Request-Payload-Daten herauszufiltern, die im Span-Attribut appsignal.request.payload 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 die Filterung von Request-Query-Parametern.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.StringSlice("appsignal.config.filter_request_payload", []string{"password", "cvv"})),

		// And other resource attributes
	),
)

filter_request_query_parameters

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

Beschreibung

Dieses Resource-Attribut ermöglicht es Ihnen, beliebige Request-Query-Parameter herauszufiltern, die im Span-Attribut appsignal.request.query_parameters 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 die Filterung von Request-Query-Parametern.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.StringSlice("appsignal.config.filter_request_query_parameters", []string{"password", "cvv"})),

		// And other resource attributes
	),
)

filter_request_session_data

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

Beschreibung

Das Resource-Attribut filter_request_session_data ermöglicht es Ihnen, beliebige Request-Sitzungsdaten herauszufiltern, die im Span-Attribut appsignal.request.session_data 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 die Filterung von Request-Sitzungsdaten.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.StringSlice("appsignal.config.filter_session_data", []string{"password", "cvv"})),

		// And other resource attributes
	),
)

ignore_actions

Feld	Wert
Resource-Attribut-Schlü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 Exceptions, 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.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.StringSlice("appsignal.config.ignore_actions", []string{"GET /heath_check", "POST /ping"})),

		// And other resource attributes
	),
)

ignore_errors

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

Beschreibung

Diese Konfigurationsoption ermöglicht es Ihnen, bestimmte Fehler davon auszuschließ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.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.StringSlice("appsignal.config.ignore_errors", []string{"MyCustomError", "ExpectedError"})),

		// And other resource attributes
	),
)

ignore_logs

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

Beschreibung

Liste von Lognachrichten, die ignoriert werden. Jede Lognachricht, die eines der Elemente der Liste enthält, wird nicht an AppSignal übertragen. Eine kleine Teilmenge der Regex-Syntax wird unterstützt; lesen Sie mehr darüber in unserem Leitfaden Logs ignorieren.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.StringSlice("appsignal.config.ignore_logs", []string{"^done$", "Task .* completed successfully"})),

		// And other resource attributes
	),
)

ignore_namespaces

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

Beschreibung

Diese Konfigurationsoption ermöglicht es Ihnen, bestimmte Namespaces davon auszuschließ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.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.StringSlice("appsignal.config.ignore_namespaces", []string{"admin", "secret"})),

		// And other resource attributes
	),
)

request_headers

Feld	Wert
Resource-Attribut-Schlü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 Allowlist. Es werden nur die konfigurierten Header einbezogen. Wenn die Liste leer ist, werden keine Header einbezogen. Die Request-Header werden aus den OpenTelemetry-Span-Attributen http.request.header.<key> gelesen, wobei <key> der normalisierte Header-Name (Kleinschreibung) ist. Um keine Header zu setzen, setzen Sie den Resource-Attributwert explizit auf ein leeres Array.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		// Only send these specific headers
		resource.WithAttributes(attribute.StringSlice("appsignal.config.request_headers", []string{"accept", "request_method", "content_length"})),

		// Do not send any headers
		// resource.WithAttributes(attribute.StringSlice("appsignal.config.request_headers", []string{})),

		// And other resource attributes
	),
)

response_headers

Feld	Wert
Resource-Attribut-Schlü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 Allowlist. Es werden nur die konfigurierten Header einbezogen. Wenn die Liste leer ist, werden keine Header einbezogen. Die Response-Header werden aus den OpenTelemetry-Span-Attributen http.response.header.<key> gelesen, wobei <key> der normalisierte Header-Name (Kleinschreibung) ist. Um keine Header zu setzen, setzen Sie den Resource-Attributwert explizit auf ein leeres Array.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		// Only send these specific headers
		resource.WithAttributes(attribute.StringSlice("appsignal.config.response_headers", []string{"accept", "request_method", "content_length"})),

		// Do not send any headers
		// resource.WithAttributes(attribute.StringSlice("appsignal.config.response_headers", []string{})),

		// And other resource attributes
	),
)

send_function_parameters

Feld	Wert
Resource-Attribut-Schlü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 mit dem Span-Attribut appsignal.function.parameters gesetzt.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.Bool("appsignal.config.send_function_parameters", false)),

		// And other resource attributes
	),
)

send_request_payload

Feld	Wert
Resource-Attribut-Schlü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 mit dem Span-Attribut appsignal.request.payload gesetzt. Weitere Informationen finden Sie unter Filterung von Request-Payloads.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.Bool("appsignal.config.send_request_payload", false)),

		// And other resource attributes
	),
)

send_request_query_parameters

Feld	Wert
Resource-Attribut-Schlü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 mit dem Span-Attribut appsignal.request.query_parameters gesetzt. Weitere Informationen finden Sie unter Filterung von Request-Parametern.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.Bool("appsignal.config.send_request_query_parameters", false)),

		// And other resource attributes
	),
)

send_request_session_data

Feld	Wert
Resource-Attribut-Schlü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 mit dem Span-Attribut appsignal.request.session_data gesetzt. Weitere Informationen finden Sie unter Filterung von Request-Sitzungsdaten.

resource, err := sdkresource.Merge(
	sdkresource.Default(),
	sdkresource.NewSchemaless(
		resource.WithAttributes(attribute.Bool("appsignal.config.send_session_data", false)),

		// And other resource attributes
	),
)

​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