mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-03-29 21:47:00 +02:00
51ff97e534
Addresses existing TODO in the push `tick` function by added a context timeout set to a configurable Controller timeout. This ensures that hung collections or exports do not have runaway resource usage. Defaults to the length of a collector period.
110 lines
3.1 KiB
Go
110 lines
3.1 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 push
|
|
|
|
import (
|
|
"time"
|
|
|
|
sdk "go.opentelemetry.io/otel/sdk/metric"
|
|
"go.opentelemetry.io/otel/sdk/resource"
|
|
)
|
|
|
|
// Config contains configuration for a push Controller.
|
|
type Config struct {
|
|
// ErrorHandler is the function called when the Controller encounters an error.
|
|
//
|
|
// This option can be overridden after instantiation of the Controller
|
|
// with the `SetErrorHandler` method.
|
|
ErrorHandler sdk.ErrorHandler
|
|
|
|
// Resource is the OpenTelemetry resource associated with all Meters
|
|
// created by the Controller.
|
|
Resource *resource.Resource
|
|
|
|
// Stateful causes the controller to maintain state across
|
|
// collection events, so that records in the exported
|
|
// checkpoint set are cumulative.
|
|
Stateful bool
|
|
|
|
// Period is the interval between calls to Collect a checkpoint.
|
|
Period time.Duration
|
|
|
|
// Timeout is the duration a collection (i.e. collect, accumulate,
|
|
// integrate, and export) can last before it is canceled. Defaults to
|
|
// the controller push period.
|
|
Timeout time.Duration
|
|
}
|
|
|
|
// Option is the interface that applies the value to a configuration option.
|
|
type Option interface {
|
|
// Apply sets the Option value of a Config.
|
|
Apply(*Config)
|
|
}
|
|
|
|
// WithErrorHandler sets the ErrorHandler configuration option of a Config.
|
|
func WithErrorHandler(fn sdk.ErrorHandler) Option {
|
|
return errorHandlerOption(fn)
|
|
}
|
|
|
|
type errorHandlerOption sdk.ErrorHandler
|
|
|
|
func (o errorHandlerOption) Apply(config *Config) {
|
|
config.ErrorHandler = sdk.ErrorHandler(o)
|
|
}
|
|
|
|
// WithResource sets the Resource configuration option of a Config.
|
|
func WithResource(r *resource.Resource) Option {
|
|
return resourceOption{r}
|
|
}
|
|
|
|
type resourceOption struct{ *resource.Resource }
|
|
|
|
func (o resourceOption) Apply(config *Config) {
|
|
config.Resource = o.Resource
|
|
}
|
|
|
|
// WithStateful sets the Stateful configuration option of a Config.
|
|
func WithStateful(stateful bool) Option {
|
|
return statefulOption(stateful)
|
|
}
|
|
|
|
type statefulOption bool
|
|
|
|
func (o statefulOption) Apply(config *Config) {
|
|
config.Stateful = bool(o)
|
|
}
|
|
|
|
// WithPeriod sets the Period configuration option of a Config.
|
|
func WithPeriod(period time.Duration) Option {
|
|
return periodOption(period)
|
|
}
|
|
|
|
type periodOption time.Duration
|
|
|
|
func (o periodOption) Apply(config *Config) {
|
|
config.Period = time.Duration(o)
|
|
}
|
|
|
|
// WithTimeout sets the Timeout configuration option of a Config.
|
|
func WithTimeout(timeout time.Duration) Option {
|
|
return timeoutOption(timeout)
|
|
}
|
|
|
|
type timeoutOption time.Duration
|
|
|
|
func (o timeoutOption) Apply(config *Config) {
|
|
config.Timeout = time.Duration(o)
|
|
}
|