1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-03-05 15:05:51 +02:00
Krzesimir Nowak a776e95c61 Consolidate AddEvent and Event methods, add FinishOptions (#99)
* Merge two event methods in span API

There was an agreement to get rid of the Event interface and
consolidate the two methods for adding events into one. See #57.

* Eliminate the use of the Event interface

There is no need for the SDK to provide the implementation of the
Event interface - it is used nowhere.

* Drop the Event interface

It's dead code now.

* Make it possible to override a finish timestamp through options

Opentracing to opentelemetry bridge will certainly use this feature.

* Obey the start time option

* Add tests for events and custom start/end times
2019-09-03 11:03:51 -07:00

131 lines
3.1 KiB
Go

// Copyright 2019, 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 sdk
import (
"context"
"time"
"google.golang.org/grpc/codes"
"go.opentelemetry.io/api/core"
"go.opentelemetry.io/api/tag"
apitrace "go.opentelemetry.io/api/trace"
"go.opentelemetry.io/experimental/streaming/exporter/observer"
)
type span struct {
tracer *tracer
initial observer.ScopeID
}
// SpancContext returns span context of the span. Return SpanContext is usable
// even after the span is finished.
func (sp *span) SpanContext() core.SpanContext {
return sp.initial.SpanContext
}
// IsRecordingEvents returns true is the span is active and recording events is enabled.
func (sp *span) IsRecordingEvents() bool {
return false
}
// SetStatus sets the status of the span.
func (sp *span) SetStatus(status codes.Code) {
observer.Record(observer.Event{
Type: observer.SET_STATUS,
Scope: sp.ScopeID(),
Status: status,
})
}
func (sp *span) ScopeID() observer.ScopeID {
return sp.initial
}
func (sp *span) SetAttribute(attribute core.KeyValue) {
observer.Record(observer.Event{
Type: observer.MODIFY_ATTR,
Scope: sp.ScopeID(),
Attribute: attribute,
})
}
func (sp *span) SetAttributes(attributes ...core.KeyValue) {
observer.Record(observer.Event{
Type: observer.MODIFY_ATTR,
Scope: sp.ScopeID(),
Attributes: attributes,
})
}
func (sp *span) ModifyAttribute(mutator tag.Mutator) {
observer.Record(observer.Event{
Type: observer.MODIFY_ATTR,
Scope: sp.ScopeID(),
Mutator: mutator,
})
}
func (sp *span) ModifyAttributes(mutators ...tag.Mutator) {
observer.Record(observer.Event{
Type: observer.MODIFY_ATTR,
Scope: sp.ScopeID(),
Mutators: mutators,
})
}
func (sp *span) Finish(options ...apitrace.FinishOption) {
recovered := recover()
opts := apitrace.FinishOptions{}
for _, opt := range options {
opt(&opts)
}
observer.Record(observer.Event{
Time: opts.FinishTime,
Type: observer.FINISH_SPAN,
Scope: sp.ScopeID(),
Recovered: recovered,
})
if recovered != nil {
panic(recovered)
}
}
func (sp *span) Tracer() apitrace.Tracer {
return sp.tracer
}
func (sp *span) AddEvent(ctx context.Context, msg string, attrs ...core.KeyValue) {
sp.addEventWithTime(ctx, time.Time{}, msg, attrs...)
}
func (sp *span) addEventWithTime(ctx context.Context, timestamp time.Time, msg string, attrs ...core.KeyValue) {
observer.Record(observer.Event{
Time: timestamp,
Type: observer.ADD_EVENT,
String: msg,
Attributes: attrs,
Context: ctx,
})
}
func (sp *span) SetName(name string) {
observer.Record(observer.Event{
Type: observer.SET_NAME,
String: name,
})
}