mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-14 10:13:10 +02:00
1b55281859
* docs(typos): Run codespell to fix typos There were a lot of typos through the repository, so I ran [codespell][], a tool for automatically fixing typos, to fix them. ```console make codespell ``` There's already a tool called [misspell][] that's supposed to take care of this, but misspell hasn't been updated for 6 years, and it doesn't seem to be catching any of the typos that codespell can. [codespell]: https://github.com/codespell-project/codespell [misspell]: https://github.com/client9/misspell * Revert and ignore spelling for Consequentially * Add GH workflow for codespell * Revert GH Workflow and Makefile for codespell Per @pellared, since there's no instructions for setting up codespell, it was suggested that the changes for setting up a workflow and section in Makefile include instructions for setting up codespell as well. * Revert spelling on consequently --------- Co-authored-by: Chester Cheung <cheung.zhy.csu@gmail.com> Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
120 lines
2.7 KiB
Go
120 lines
2.7 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 stdouttrace // import "go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"sync"
|
|
"time"
|
|
|
|
"go.opentelemetry.io/otel/sdk/trace"
|
|
"go.opentelemetry.io/otel/sdk/trace/tracetest"
|
|
)
|
|
|
|
var zeroTime time.Time
|
|
|
|
var _ trace.SpanExporter = &Exporter{}
|
|
|
|
// New creates an Exporter with the passed options.
|
|
func New(options ...Option) (*Exporter, error) {
|
|
cfg, err := newConfig(options...)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
enc := json.NewEncoder(cfg.Writer)
|
|
if cfg.PrettyPrint {
|
|
enc.SetIndent("", "\t")
|
|
}
|
|
|
|
return &Exporter{
|
|
encoder: enc,
|
|
timestamps: cfg.Timestamps,
|
|
}, nil
|
|
}
|
|
|
|
// Exporter is an implementation of trace.SpanSyncer that writes spans to stdout.
|
|
type Exporter struct {
|
|
encoder *json.Encoder
|
|
encoderMu sync.Mutex
|
|
timestamps bool
|
|
|
|
stoppedMu sync.RWMutex
|
|
stopped bool
|
|
}
|
|
|
|
// ExportSpans writes spans in json format to stdout.
|
|
func (e *Exporter) ExportSpans(ctx context.Context, spans []trace.ReadOnlySpan) error {
|
|
e.stoppedMu.RLock()
|
|
stopped := e.stopped
|
|
e.stoppedMu.RUnlock()
|
|
if stopped {
|
|
return nil
|
|
}
|
|
|
|
if len(spans) == 0 {
|
|
return nil
|
|
}
|
|
|
|
stubs := tracetest.SpanStubsFromReadOnlySpans(spans)
|
|
|
|
e.encoderMu.Lock()
|
|
defer e.encoderMu.Unlock()
|
|
for i := range stubs {
|
|
stub := &stubs[i]
|
|
// Remove timestamps
|
|
if !e.timestamps {
|
|
stub.StartTime = zeroTime
|
|
stub.EndTime = zeroTime
|
|
for j := range stub.Events {
|
|
ev := &stub.Events[j]
|
|
ev.Time = zeroTime
|
|
}
|
|
}
|
|
|
|
// Encode span stubs, one by one
|
|
if err := e.encoder.Encode(stub); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Shutdown is called to stop the exporter, it performs no action.
|
|
func (e *Exporter) Shutdown(ctx context.Context) error {
|
|
e.stoppedMu.Lock()
|
|
e.stopped = true
|
|
e.stoppedMu.Unlock()
|
|
|
|
select {
|
|
case <-ctx.Done():
|
|
return ctx.Err()
|
|
default:
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// MarshalLog is the marshaling function used by the logging system to represent this exporter.
|
|
func (e *Exporter) MarshalLog() interface{} {
|
|
return struct {
|
|
Type string
|
|
WithTimestamps bool
|
|
}{
|
|
Type: "stdout",
|
|
WithTimestamps: e.timestamps,
|
|
}
|
|
}
|