Zum Hauptinhalt springen
AppSignal ist kompatibel mit OpenTelemetry-Instrumentierungspaketen. Einige dieser Instrumentierungspakete erfordern möglicherweise eine zusätzliche Einrichtung. Diese enthalten nicht immer die Informationen, die Sie zum Debuggen von Problemen benötigen. Für ein feingranulareres Reporting können Sie benutzerdefinierte Instrumentierung hinzufügen. Wir unterstützen OpenTelemetry-Tracing wie in der OpenTelemetry-Dokumentation beschrieben. Es ist möglich, einem Span mithilfe von OpenTelemetry-Span-Attributen weitere Daten hinzuzufügen. Es gibt außerdem AppSignal-Span-Attribute, die ändern können, wie Traces gruppiert werden, sowie einige Attribute, die das Herausfiltern sensibler Daten ermöglichen.

Einrichtung

Wenn Sie benutzerdefinierte Instrumentierung hinzufügen, importieren Sie zunächst das OpenTelemetry-Trace-Paket in der Datei, der Sie die Instrumentierung hinzufügen möchten.

Einen neuen Span erstellen

Erstellen Sie mit dem während der Installation initialisierten Tracer einen neuen Span.
Hinweis: In diesen Beispielen verlassen wir uns auf den Kontext aus dem HTTP-Request, der durch r.Context() bereitgestellt wird. Das Empfangen des Kontexts kann in Ihrer Anwendung anders sein.

Den aktuellen Span abrufen

Sie können den aktuellen Span auch mit dem während der Installation initialisierten Tracer abrufen:
Hinweis: Dies gibt nur dann einen Span zurück, wenn bereits einer aktiv ist. Weitere Möglichkeiten zum Erstellen und Abrufen von Spans sind auf der OpenTelemetry-Go-Instrumentierungsseite dokumentiert.

AppSignal-Attribute

Sobald Sie einen Span erstellt oder abgerufen haben, können Sie bestimmte AppSignal-spezifische Attribute setzen, um anzupassen, wie die Daten in AppSignal eintreffen.
Weitere Informationen dazu, welche benutzerdefinierten AppSignal-Attribute unterstützt werden, finden Sie in unseren Leitfäden:

Fehler melden

Um einen Fehler zu melden, erfassen Sie ihn auf einem Span mit der OpenTelemetry-Methode RecordError. Übergeben Sie trace.WithStackTrace(true), um den Stacktrace einzuschließen. Sie können den Status des Spans mit SetStatus außerdem auf Error setzen.
RecordError fügt dem Span ein exception-Event mit dem Typ und der Meldung des Fehlers hinzu, plus dem Stacktrace, wenn Sie trace.WithStackTrace(true) übergeben. AppSignal meldet diese Exception-Events als Fehler, wenn sie auf dem Root-Span des Teils des Traces erfasst werden, der zu Ihrem Service gehört, etwa dem Span für eine eingehende HTTP-Anfrage. Damit AppSignal einen Fehler nicht meldet, fügen Sie seinen Typ zur ignore_errors-Liste hinzu. Der Typ ist der Go-Typ des Fehlers, und AppSignal zeigt ihn auch als Namen des Fehlers an. Zum Beispiel hat jeder mit errors.New erstellte Fehler den Typ *errors.errorString. Wenn Sie diesen Typ hinzufügen, werden also alle diese Fehler ignoriert.

Einen Fehler aus einem Child-Span melden

AppSignal meldet einen auf einem Child-Span erfassten Fehler, etwa auf einem Span, den Sie innerhalb einer Anfrage erstellt haben, nur dann, wenn Sie das Attribut appsignal.alert_this_error mit dem Wert true hinzufügen:

Einen Fehler außerhalb einer Anfrage melden

Für Code, der nicht innerhalb einer Anfrage läuft, etwa einen Hintergrundjob, starten Sie einen neuen Span aus context.Background(). Dieser Span ist der Root-Span eines neuen Traces, daher meldet AppSignal die darauf erfassten Fehler: