github.com/waldiirawan/apm-agent-go/v2@v2.2.2/apmtest/withtransaction.go (about)

     1  // Licensed to Elasticsearch B.V. under one or more contributor
     2  // license agreements. See the NOTICE file distributed with
     3  // this work for additional information regarding copyright
     4  // ownership. Elasticsearch B.V. licenses this file to you under
     5  // the Apache License, Version 2.0 (the "License"); you may
     6  // not use this file except in compliance with the License.
     7  // You may obtain a copy of the License at
     8  //
     9  //     http://www.apache.org/licenses/LICENSE-2.0
    10  //
    11  // Unless required by applicable law or agreed to in writing,
    12  // software distributed under the License is distributed on an
    13  // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    14  // KIND, either express or implied.  See the License for the
    15  // specific language governing permissions and limitations
    16  // under the License.
    17  
    18  package apmtest // import "github.com/waldiirawan/apm-agent-go/v2/apmtest"
    19  
    20  import (
    21  	"context"
    22  
    23  	"github.com/waldiirawan/apm-agent-go/v2"
    24  	"github.com/waldiirawan/apm-agent-go/v2/model"
    25  )
    26  
    27  // WithTransaction is equivalent to calling WithTransactionOptions with a zero TransactionOptions.
    28  func WithTransaction(f func(ctx context.Context)) (model.Transaction, []model.Span, []model.Error) {
    29  	return WithTransactionOptions(apm.TransactionOptions{}, f)
    30  }
    31  
    32  // WithUncompressedTransaction is equivalent to calling WithTransactionOptions with compression disabled.
    33  func WithUncompressedTransaction(f func(ctx context.Context)) (model.Transaction, []model.Span, []model.Error) {
    34  	tracer := NewRecordingTracer()
    35  	// Do not drop short exit spans by default.
    36  	tracer.SetExitSpanMinDuration(0)
    37  	tracer.SetSpanCompressionEnabled(false)
    38  	defer tracer.Close()
    39  	return tracer.WithTransactionOptions(apm.TransactionOptions{}, f)
    40  }
    41  
    42  // WithTransactionOptions calls f with a new context containing a transaction
    43  // and transaction options, flushes the transaction to a test server, and returns
    44  // the decoded transaction and any associated spans and errors.
    45  func WithTransactionOptions(opts apm.TransactionOptions, f func(ctx context.Context)) (model.Transaction, []model.Span, []model.Error) {
    46  	tracer := NewRecordingTracer()
    47  	// Do not drop short exit spans by default.
    48  	tracer.SetExitSpanMinDuration(0)
    49  	defer tracer.Close()
    50  	return tracer.WithTransactionOptions(opts, f)
    51  }