Golang OpenTelemetry: фиксация ошибки span.RecordError(err)

span.RecordError(err) — это метод OpenTelemetry, который позволяет зафиксировать информацию об ошибке в текущем Span. Эта информация станет частью трассировки и поможет разработчикам проанализировать, что пошло не так.

---

Как работает RecordError?

• Фиксация ошибки в Span: Метод записывает ошибку (err) как событие типа exception в Span.
• Добавление стандартных атрибутов: OpenTelemetry автоматически добавляет к событию стандартные атрибуты, такие как тип ошибки и её текстовое сообщение.

---

Когда использовать RecordError?

1. Обработка ошибок: Если во время выполнения кода возникает ошибка, её стоит записать в текущий Span.
2. Дополнительная информация: RecordError полезен для анализа ошибок, так как записанные данные будут видны в системе мониторинга.
   
   Go

   package main import ( "context" "errors" "log" "go.opentelemetry.io/otel" "go.opentelemetry.io/otel/codes" "go.opentelemetry.io/otel/trace" ) func main() { tracer := otel.Tracer("example-tracer") // Создаём корневой контекст и Span ctx, span := tracer.Start(context.Background(), "main-operation") defer span.End() // Пример вызова функции, которая возвращает ошибку err := ProcessTask(ctx) if err != nil { // Записываем ошибку в Span span.RecordError(err) // Устанавливаем статус Span как ошибочный span.SetStatus(codes.Error, err.Error()) } log.Println("Main operation finished") } // ProcessTask - пример функции, которая возвращает ошибку func ProcessTask(ctx context.Context) error { tracer := otel.Tracer("example-tracer") ctx, span := tracer.Start(ctx, "ProcessTask") defer span.End() // Имитация ошибки err := errors.New("something went wrong") span.RecordError(err) // Записываем ошибку в Span return err }

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

   package main   import ( "context" "errors" "log"   "go.opentelemetry.io/otel" "go.opentelemetry.io/otel/codes" "go.opentelemetry.io/otel/trace" )   func main() { tracer := otel.Tracer("example-tracer")   // Создаём корневой контекст и Span ctx, span := tracer.Start(context.Background(), "main-operation") defer span.End()   // Пример вызова функции, которая возвращает ошибку err := ProcessTask(ctx) if err != nil { // Записываем ошибку в Span span.RecordError(err)   // Устанавливаем статус Span как ошибочный span.SetStatus(codes.Error, err.Error()) }   log.Println("Main operation finished") }   // ProcessTask - пример функции, которая возвращает ошибку func ProcessTask(ctx context.Context) error { tracer := otel.Tracer("example-tracer") ctx, span := tracer.Start(ctx, "ProcessTask") defer span.End()   // Имитация ошибки err := errors.New("something went wrong") span.RecordError(err) // Записываем ошибку в Span return err }

Что записывает RecordError?

1. Тип ошибки (exception.type):
   • Отражает тип ошибки (например, *errors.errorString).
2. Сообщение об ошибке (exception.message):
   • Текст ошибки (err.Error()).
3. (Опционально) Стек-трейс (exception.stacktrace):
   • Если стек-трейс доступен, его можно передать вручную.

---

Как добавить стек-трейс вручную?

OpenTelemetry не всегда автоматически добавляет стек-трейс. Вы можете использовать библиотеку runtime/debug или другие инструменты для этого.

Пример:

Использование:

Чем полезен RecordError?

1. Улучшает видимость ошибок:
   • Ошибки становятся частью трассировки, их легко просмотреть в системах мониторинга (например, Jaeger, Zipkin).
2. Сопоставление ошибок с контекстом:
   • Ошибки связываются с конкретным Span, что помогает понять, где именно произошла ошибка.
3. Снижение ручной работы:
   • Атрибуты ошибок добавляются автоматически.

---

Частые ошибки при использовании

1. Неуказание статуса Error:
   • Запись ошибки с помощью RecordError не устанавливает статус Error. Для этого нужно явно вызвать:
     Go

     span.SetStatus(codes.Error, err.Error())

     1 2	span.SetStatus(codes.Error, err.Error())

      

1. Избыточное количество записей:
   • Не стоит записывать одну и ту же ошибку несколько раз. Это может загрязнить трейс.
2. Игнорирование контекста:
   • Убедитесь, что контекст правильно передаётся, чтобы ошибка была записана в нужный Span.

---

Итог

Метод span.RecordError(err) — это эффективный способ записать ошибки в OpenTelemetry. Используйте его для:

• Фиксации подробностей об ошибках.
• Добавления ошибок в трейс.
• Улучшения диагностики в распределённых системах.