mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-18 16:47:18 +02:00
bd817df68c
* Change trace options to accept type not pointer Add benchmark to show allocation improvement. * Update CONTRIBUTING.md guidelines * Update all Option iface * Fix grammar in CONTRIBUTING
119 lines
2.8 KiB
Go
119 lines
2.8 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 stdoutmetric // import "go.opentelemetry.io/otel/exporters/stdout/stdoutmetric"
|
|
|
|
import (
|
|
"io"
|
|
"os"
|
|
|
|
"go.opentelemetry.io/otel/attribute"
|
|
)
|
|
|
|
var (
|
|
defaultWriter = os.Stdout
|
|
defaultPrettyPrint = false
|
|
defaultTimestamps = true
|
|
defaultLabelEncoder = attribute.DefaultEncoder()
|
|
)
|
|
|
|
// config contains options for the STDOUT exporter.
|
|
type config struct {
|
|
// Writer is the destination. If not set, os.Stdout is used.
|
|
Writer io.Writer
|
|
|
|
// PrettyPrint will encode the output into readable JSON. Default is
|
|
// false.
|
|
PrettyPrint bool
|
|
|
|
// Timestamps specifies if timestamps should be printed. Default is
|
|
// true.
|
|
Timestamps bool
|
|
|
|
// LabelEncoder encodes the labels.
|
|
LabelEncoder attribute.Encoder
|
|
}
|
|
|
|
// newConfig creates a validated Config configured with options.
|
|
func newConfig(options ...Option) (config, error) {
|
|
cfg := config{
|
|
Writer: defaultWriter,
|
|
PrettyPrint: defaultPrettyPrint,
|
|
Timestamps: defaultTimestamps,
|
|
LabelEncoder: defaultLabelEncoder,
|
|
}
|
|
for _, opt := range options {
|
|
cfg = opt.apply(cfg)
|
|
|
|
}
|
|
return cfg, nil
|
|
}
|
|
|
|
// Option sets the value of an option for a Config.
|
|
type Option interface {
|
|
apply(config) config
|
|
}
|
|
|
|
// WithWriter sets the export stream destination.
|
|
func WithWriter(w io.Writer) Option {
|
|
return writerOption{w}
|
|
}
|
|
|
|
type writerOption struct {
|
|
W io.Writer
|
|
}
|
|
|
|
func (o writerOption) apply(cfg config) config {
|
|
cfg.Writer = o.W
|
|
return cfg
|
|
}
|
|
|
|
// WithPrettyPrint sets the export stream format to use JSON.
|
|
func WithPrettyPrint() Option {
|
|
return prettyPrintOption(true)
|
|
}
|
|
|
|
type prettyPrintOption bool
|
|
|
|
func (o prettyPrintOption) apply(cfg config) config {
|
|
cfg.PrettyPrint = bool(o)
|
|
return cfg
|
|
}
|
|
|
|
// WithoutTimestamps sets the export stream to not include timestamps.
|
|
func WithoutTimestamps() Option {
|
|
return timestampsOption(false)
|
|
}
|
|
|
|
type timestampsOption bool
|
|
|
|
func (o timestampsOption) apply(cfg config) config {
|
|
cfg.Timestamps = bool(o)
|
|
return cfg
|
|
}
|
|
|
|
// WithLabelEncoder sets the label encoder used in export.
|
|
func WithLabelEncoder(enc attribute.Encoder) Option {
|
|
return labelEncoderOption{enc}
|
|
}
|
|
|
|
type labelEncoderOption struct {
|
|
LabelEncoder attribute.Encoder
|
|
}
|
|
|
|
func (o labelEncoderOption) apply(cfg config) config {
|
|
cfg.LabelEncoder = o.LabelEncoder
|
|
return cfg
|
|
}
|