mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-12 10:04:29 +02:00
d143b8fbf8
* Unify API Span Start/End Options Replace both with `SpanOption`. Add a unified `SpanConfig` to match and a `SpanConfigure` function to parse a `SpanConfig` from `SpanOption`s. Update all the related options to use new `SpanOption`s. * No non-zero SpanConfig defaults The SDK uses an internal clock for the current time that cannot be use if it does not know the time has not been set. * Append attributes for WithAttributes This preserves existing behavior. * Add unit test for SpanConfigure * Propagate changes * Update append option documentation * Update testing comments * Move comments on guarantees to appropriate function * Add documentation for SDK methods Include SDK implementation specific information in the Tracer Start method and Span End method. * Add changes to Changelog * Apply suggestions from code review Co-authored-by: ET <evantorrie@users.noreply.github.com> * Update the SpanKind comment in the SpanConfig Try for a less tautological comment. Co-authored-by: ET <evantorrie@users.noreply.github.com>
94 lines
2.4 KiB
Go
94 lines
2.4 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package tracetest
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
apitrace "go.opentelemetry.io/otel/api/trace"
|
|
"go.opentelemetry.io/otel/codes"
|
|
"go.opentelemetry.io/otel/label"
|
|
)
|
|
|
|
// MockSpan is a mock span used in association with MockTracer for testing purpose only.
|
|
type MockSpan struct {
|
|
StatusMsg string
|
|
Name string
|
|
Status codes.Code
|
|
sc apitrace.SpanContext
|
|
tracer apitrace.Tracer
|
|
}
|
|
|
|
var _ apitrace.Span = (*MockSpan)(nil)
|
|
|
|
// SpanContext returns associated label.SpanContext. If the receiver is nil it returns
|
|
// an empty label.SpanContext
|
|
func (ms *MockSpan) SpanContext() apitrace.SpanContext {
|
|
if ms == nil {
|
|
return apitrace.EmptySpanContext()
|
|
}
|
|
return ms.sc
|
|
}
|
|
|
|
// IsRecording always returns false for MockSpan.
|
|
func (ms *MockSpan) IsRecording() bool {
|
|
return false
|
|
}
|
|
|
|
// SetStatus does nothing.
|
|
func (ms *MockSpan) SetStatus(status codes.Code, msg string) {
|
|
ms.Status = status
|
|
ms.StatusMsg = msg
|
|
}
|
|
|
|
// SetError does nothing.
|
|
func (ms *MockSpan) SetError(v bool) {
|
|
}
|
|
|
|
// SetAttributes does nothing.
|
|
func (ms *MockSpan) SetAttributes(attributes ...label.KeyValue) {
|
|
}
|
|
|
|
// SetAttribute does nothing.
|
|
func (ms *MockSpan) SetAttribute(k string, v interface{}) {
|
|
}
|
|
|
|
// End does nothing.
|
|
func (ms *MockSpan) End(options ...apitrace.SpanOption) {
|
|
}
|
|
|
|
// RecordError does nothing.
|
|
func (ms *MockSpan) RecordError(ctx context.Context, err error, opts ...apitrace.ErrorOption) {
|
|
}
|
|
|
|
// SetName sets the span name.
|
|
func (ms *MockSpan) SetName(name string) {
|
|
ms.Name = name
|
|
}
|
|
|
|
// Tracer returns MockTracer implementation of Tracer.
|
|
func (ms *MockSpan) Tracer() apitrace.Tracer {
|
|
return ms.tracer
|
|
}
|
|
|
|
// AddEvent does nothing.
|
|
func (ms *MockSpan) AddEvent(ctx context.Context, name string, attrs ...label.KeyValue) {
|
|
}
|
|
|
|
// AddEvent does nothing.
|
|
func (ms *MockSpan) AddEventWithTimestamp(ctx context.Context, timestamp time.Time, name string, attrs ...label.KeyValue) {
|
|
}
|