mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-16 10:19:23 +02:00
067aa9e142
* Introduce simplified export pipeline setup for stdout * Standardize dogstatsd,stdout,prometheus calling. * Creates NewRawExporter, NewExportPipeline, InstallNewPipeline methods. * Uses Options rather than Config throughout for options. * fix merge conflicts. Co-authored-by: Liz Fong-Jones <elizabeth@ctyalcove.org>
121 lines
3.6 KiB
Go
121 lines
3.6 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 dogstatsd // import "go.opentelemetry.io/otel/exporter/metric/dogstatsd"
|
|
|
|
import (
|
|
"bytes"
|
|
"time"
|
|
|
|
"go.opentelemetry.io/otel/api/global"
|
|
"go.opentelemetry.io/otel/exporter/metric/internal/statsd"
|
|
|
|
export "go.opentelemetry.io/otel/sdk/export/metric"
|
|
"go.opentelemetry.io/otel/sdk/metric/batcher/ungrouped"
|
|
"go.opentelemetry.io/otel/sdk/metric/controller/push"
|
|
"go.opentelemetry.io/otel/sdk/metric/selector/simple"
|
|
)
|
|
|
|
type (
|
|
Options = statsd.Options
|
|
|
|
// Exporter implements a dogstatsd-format statsd exporter,
|
|
// which encodes label sets as independent fields in the
|
|
// output.
|
|
//
|
|
// TODO: find a link for this syntax. It's been copied out of
|
|
// code, not a specification:
|
|
//
|
|
// https://github.com/stripe/veneur/blob/master/sinks/datadog/datadog.go
|
|
Exporter struct {
|
|
*statsd.Exporter
|
|
*statsd.LabelEncoder
|
|
|
|
ReencodedLabelsCount int
|
|
}
|
|
)
|
|
|
|
var (
|
|
_ export.Exporter = &Exporter{}
|
|
_ export.LabelEncoder = &Exporter{}
|
|
)
|
|
|
|
// NewRawExporter returns a new Dogstatsd-syntax exporter for use in a pipeline.
|
|
// This type implements the metric.LabelEncoder interface,
|
|
// allowing the SDK's unique label encoding to be pre-computed
|
|
// for the exporter and stored in the LabelSet.
|
|
func NewRawExporter(options Options) (*Exporter, error) {
|
|
exp := &Exporter{
|
|
LabelEncoder: statsd.NewLabelEncoder(),
|
|
}
|
|
|
|
var err error
|
|
exp.Exporter, err = statsd.NewExporter(options, exp)
|
|
return exp, err
|
|
}
|
|
|
|
// InstallNewPipeline instantiates a NewExportPipeline and registers it globally.
|
|
// Typically called as:
|
|
// pipeline, err := dogstatsd.InstallNewPipeline(dogstatsd.Options{...})
|
|
// if err != nil {
|
|
// ...
|
|
// }
|
|
// defer pipeline.Stop()
|
|
// ... Done
|
|
func InstallNewPipeline(options Options) (*push.Controller, error) {
|
|
controller, err := NewExportPipeline(options)
|
|
if err != nil {
|
|
return controller, err
|
|
}
|
|
global.SetMeterProvider(controller)
|
|
return controller, err
|
|
}
|
|
|
|
// NewExportPipeline sets up a complete export pipeline with the recommended setup,
|
|
// chaining a NewRawExporter into the recommended selectors and batchers.
|
|
func NewExportPipeline(options Options) (*push.Controller, error) {
|
|
selector := simple.NewWithExactMeasure()
|
|
exporter, err := NewRawExporter(options)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// The ungrouped batcher ensures that the export sees the full
|
|
// set of labels as dogstatsd tags.
|
|
batcher := ungrouped.New(selector, false)
|
|
|
|
// The pusher automatically recognizes that the exporter
|
|
// implements the LabelEncoder interface, which ensures the
|
|
// export encoding for labels is encoded in the LabelSet.
|
|
pusher := push.New(batcher, exporter, time.Hour)
|
|
pusher.Start()
|
|
|
|
return pusher, nil
|
|
}
|
|
|
|
// AppendName is part of the stats-internal adapter interface.
|
|
func (*Exporter) AppendName(rec export.Record, buf *bytes.Buffer) {
|
|
_, _ = buf.WriteString(rec.Descriptor().Name())
|
|
}
|
|
|
|
// AppendTags is part of the stats-internal adapter interface.
|
|
func (e *Exporter) AppendTags(rec export.Record, buf *bytes.Buffer) {
|
|
encoded, inefficient := e.LabelEncoder.ForceEncode(rec.Labels())
|
|
_, _ = buf.WriteString(encoded)
|
|
|
|
if inefficient {
|
|
e.ReencodedLabelsCount++
|
|
}
|
|
}
|