Files
tasks/common/persistence/telemetry/queue_v2_gen.go
Stephan BehnkeandGitHub 73cf609933 OTEL persistence context deadline (#7208)
## What changed?
<!-- Describe what has changed in this PR -->

Added "persistence.deadline" attributes to OTEL persistence span.

## Why?
<!-- Tell your future self why have you made these changes -->

Add more details for debugging.

## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->

## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->

## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->

## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
2025-02-05 19:16:08 +00:00

276 lines
9.3 KiB
Go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
// Code generated by gowrap. DO NOT EDIT.
// template: gowrap_template
// gowrap: http://github.com/hexdigest/gowrap
package telemetry
//go:generate gowrap gen -p go.temporal.io/server/common/persistence -i QueueV2 -t gowrap_template -o queue_v2_gen.go -l ""
import (
"context"
"encoding/json"
"time"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/log/tag"
_sourcePersistence "go.temporal.io/server/common/persistence"
"go.temporal.io/server/common/telemetry"
)
// telemetryQueueV2 implements QueueV2 interface instrumented with OpenTelemetry.
type telemetryQueueV2 struct {
_sourcePersistence.QueueV2
tracer trace.Tracer
logger log.Logger
debugMode bool
}
// newTelemetryQueueV2 returns telemetryQueueV2.
func newTelemetryQueueV2(
base _sourcePersistence.QueueV2,
logger log.Logger,
tracer trace.Tracer,
) telemetryQueueV2 {
return telemetryQueueV2{
QueueV2: base,
tracer: tracer,
debugMode: telemetry.DebugMode(),
}
}
// CreateQueue wraps QueueV2.CreateQueue.
func (d telemetryQueueV2) CreateQueue(ctx context.Context, request *_sourcePersistence.InternalCreateQueueRequest) (ip1 *_sourcePersistence.InternalCreateQueueResponse, err error) {
ctx, span := d.tracer.Start(
ctx,
"persistence.QueueV2/CreateQueue",
trace.WithAttributes(
attribute.Key("persistence.store").String("QueueV2"),
attribute.Key("persistence.method").String("CreateQueue"),
))
defer span.End()
if deadline, ok := ctx.Deadline(); ok {
span.SetAttributes(attribute.String("deadline", deadline.Format(time.RFC3339Nano)))
span.SetAttributes(attribute.String("timeout", time.Until(deadline).String()))
}
ip1, err = d.QueueV2.CreateQueue(ctx, request)
if err != nil {
span.RecordError(err)
}
if d.debugMode {
requestPayload, err := json.MarshalIndent(request, "", " ")
if err != nil {
d.logger.Error("failed to serialize *_sourcePersistence.InternalCreateQueueRequest for OTEL span", tag.Error(err))
} else {
span.SetAttributes(attribute.Key("persistence.request.payload").String(string(requestPayload)))
}
responsePayload, err := json.MarshalIndent(ip1, "", " ")
if err != nil {
d.logger.Error("failed to serialize *_sourcePersistence.InternalCreateQueueResponse for OTEL span", tag.Error(err))
} else {
span.SetAttributes(attribute.Key("persistence.response.payload").String(string(responsePayload)))
}
}
return
}
// EnqueueMessage wraps QueueV2.EnqueueMessage.
func (d telemetryQueueV2) EnqueueMessage(ctx context.Context, request *_sourcePersistence.InternalEnqueueMessageRequest) (ip1 *_sourcePersistence.InternalEnqueueMessageResponse, err error) {
ctx, span := d.tracer.Start(
ctx,
"persistence.QueueV2/EnqueueMessage",
trace.WithAttributes(
attribute.Key("persistence.store").String("QueueV2"),
attribute.Key("persistence.method").String("EnqueueMessage"),
))
defer span.End()
if deadline, ok := ctx.Deadline(); ok {
span.SetAttributes(attribute.String("deadline", deadline.Format(time.RFC3339Nano)))
span.SetAttributes(attribute.String("timeout", time.Until(deadline).String()))
}
ip1, err = d.QueueV2.EnqueueMessage(ctx, request)
if err != nil {
span.RecordError(err)
}
if d.debugMode {
requestPayload, err := json.MarshalIndent(request, "", " ")
if err != nil {
d.logger.Error("failed to serialize *_sourcePersistence.InternalEnqueueMessageRequest for OTEL span", tag.Error(err))
} else {
span.SetAttributes(attribute.Key("persistence.request.payload").String(string(requestPayload)))
}
responsePayload, err := json.MarshalIndent(ip1, "", " ")
if err != nil {
d.logger.Error("failed to serialize *_sourcePersistence.InternalEnqueueMessageResponse for OTEL span", tag.Error(err))
} else {
span.SetAttributes(attribute.Key("persistence.response.payload").String(string(responsePayload)))
}
}
return
}
// ListQueues wraps QueueV2.ListQueues.
func (d telemetryQueueV2) ListQueues(ctx context.Context, request *_sourcePersistence.InternalListQueuesRequest) (ip1 *_sourcePersistence.InternalListQueuesResponse, err error) {
ctx, span := d.tracer.Start(
ctx,
"persistence.QueueV2/ListQueues",
trace.WithAttributes(
attribute.Key("persistence.store").String("QueueV2"),
attribute.Key("persistence.method").String("ListQueues"),
))
defer span.End()
if deadline, ok := ctx.Deadline(); ok {
span.SetAttributes(attribute.String("deadline", deadline.Format(time.RFC3339Nano)))
span.SetAttributes(attribute.String("timeout", time.Until(deadline).String()))
}
ip1, err = d.QueueV2.ListQueues(ctx, request)
if err != nil {
span.RecordError(err)
}
if d.debugMode {
requestPayload, err := json.MarshalIndent(request, "", " ")
if err != nil {
d.logger.Error("failed to serialize *_sourcePersistence.InternalListQueuesRequest for OTEL span", tag.Error(err))
} else {
span.SetAttributes(attribute.Key("persistence.request.payload").String(string(requestPayload)))
}
responsePayload, err := json.MarshalIndent(ip1, "", " ")
if err != nil {
d.logger.Error("failed to serialize *_sourcePersistence.InternalListQueuesResponse for OTEL span", tag.Error(err))
} else {
span.SetAttributes(attribute.Key("persistence.response.payload").String(string(responsePayload)))
}
}
return
}
// RangeDeleteMessages wraps QueueV2.RangeDeleteMessages.
func (d telemetryQueueV2) RangeDeleteMessages(ctx context.Context, request *_sourcePersistence.InternalRangeDeleteMessagesRequest) (ip1 *_sourcePersistence.InternalRangeDeleteMessagesResponse, err error) {
ctx, span := d.tracer.Start(
ctx,
"persistence.QueueV2/RangeDeleteMessages",
trace.WithAttributes(
attribute.Key("persistence.store").String("QueueV2"),
attribute.Key("persistence.method").String("RangeDeleteMessages"),
))
defer span.End()
if deadline, ok := ctx.Deadline(); ok {
span.SetAttributes(attribute.String("deadline", deadline.Format(time.RFC3339Nano)))
span.SetAttributes(attribute.String("timeout", time.Until(deadline).String()))
}
ip1, err = d.QueueV2.RangeDeleteMessages(ctx, request)
if err != nil {
span.RecordError(err)
}
if d.debugMode {
requestPayload, err := json.MarshalIndent(request, "", " ")
if err != nil {
d.logger.Error("failed to serialize *_sourcePersistence.InternalRangeDeleteMessagesRequest for OTEL span", tag.Error(err))
} else {
span.SetAttributes(attribute.Key("persistence.request.payload").String(string(requestPayload)))
}
responsePayload, err := json.MarshalIndent(ip1, "", " ")
if err != nil {
d.logger.Error("failed to serialize *_sourcePersistence.InternalRangeDeleteMessagesResponse for OTEL span", tag.Error(err))
} else {
span.SetAttributes(attribute.Key("persistence.response.payload").String(string(responsePayload)))
}
}
return
}
// ReadMessages wraps QueueV2.ReadMessages.
func (d telemetryQueueV2) ReadMessages(ctx context.Context, request *_sourcePersistence.InternalReadMessagesRequest) (ip1 *_sourcePersistence.InternalReadMessagesResponse, err error) {
ctx, span := d.tracer.Start(
ctx,
"persistence.QueueV2/ReadMessages",
trace.WithAttributes(
attribute.Key("persistence.store").String("QueueV2"),
attribute.Key("persistence.method").String("ReadMessages"),
))
defer span.End()
if deadline, ok := ctx.Deadline(); ok {
span.SetAttributes(attribute.String("deadline", deadline.Format(time.RFC3339Nano)))
span.SetAttributes(attribute.String("timeout", time.Until(deadline).String()))
}
ip1, err = d.QueueV2.ReadMessages(ctx, request)
if err != nil {
span.RecordError(err)
}
if d.debugMode {
requestPayload, err := json.MarshalIndent(request, "", " ")
if err != nil {
d.logger.Error("failed to serialize *_sourcePersistence.InternalReadMessagesRequest for OTEL span", tag.Error(err))
} else {
span.SetAttributes(attribute.Key("persistence.request.payload").String(string(requestPayload)))
}
responsePayload, err := json.MarshalIndent(ip1, "", " ")
if err != nil {
d.logger.Error("failed to serialize *_sourcePersistence.InternalReadMessagesResponse for OTEL span", tag.Error(err))
} else {
span.SetAttributes(attribute.Key("persistence.response.payload").String(string(responsePayload)))
}
}
return
}