mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-04-15 11:36:44 +02:00
46d9687a35
This implements specification requirement: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md#resource-creation - Changes `resource.NewWithAttributes` to require a schema URL. The old function is still available as `resource.NewSchemaless`. This is a breaking change. We want to encourage using schema URL and make it a conscious choice to have a resource without schema. - Merge schema URLs acccording to the spec in resource.Merge. - Several builtin resource detectors now correctly populate the schema URL. Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
127 lines
3.8 KiB
Go
127 lines
3.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 basic // import "go.opentelemetry.io/otel/sdk/metric/controller/basic"
|
|
|
|
import (
|
|
"time"
|
|
|
|
"go.opentelemetry.io/otel"
|
|
export "go.opentelemetry.io/otel/sdk/export/metric"
|
|
"go.opentelemetry.io/otel/sdk/resource"
|
|
)
|
|
|
|
// config contains configuration for a basic Controller.
|
|
type config struct {
|
|
// Resource is the OpenTelemetry resource associated with all Meters
|
|
// created by the Controller.
|
|
Resource *resource.Resource
|
|
|
|
// CollectPeriod is the interval between calls to Collect a
|
|
// checkpoint.
|
|
//
|
|
// When pulling metrics and not exporting, this is the minimum
|
|
// time between calls to Collect. In a pull-only
|
|
// configuration, collection is performed on demand; set
|
|
// CollectPeriod to 0 always recompute the export record set.
|
|
//
|
|
// When exporting metrics, this must be > 0.
|
|
//
|
|
// Default value is 10s.
|
|
CollectPeriod time.Duration
|
|
|
|
// CollectTimeout is the timeout of the Context passed to
|
|
// Collect() and subsequently to Observer instrument callbacks.
|
|
//
|
|
// Default value is 10s. If zero, no Collect timeout is applied.
|
|
CollectTimeout time.Duration
|
|
|
|
// Exporter is used for exporting metric data.
|
|
//
|
|
// Note: Exporters such as Prometheus that pull data do not implement
|
|
// export.Exporter. These will directly call Collect() and ForEach().
|
|
Exporter export.Exporter
|
|
|
|
// PushTimeout is the timeout of the Context when a exporter is configured.
|
|
//
|
|
// Default value is 10s. If zero, no Export timeout is applied.
|
|
PushTimeout 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)
|
|
}
|
|
|
|
// WithResource sets the Resource configuration option of a Config by merging it
|
|
// with the Resource configuration in the environment.
|
|
func WithResource(r *resource.Resource) Option {
|
|
res, err := resource.Merge(resource.Environment(), r)
|
|
if err != nil {
|
|
otel.Handle(err)
|
|
}
|
|
return resourceOption{res}
|
|
}
|
|
|
|
type resourceOption struct{ *resource.Resource }
|
|
|
|
func (o resourceOption) apply(cfg *config) {
|
|
cfg.Resource = o.Resource
|
|
}
|
|
|
|
// WithCollectPeriod sets the CollectPeriod configuration option of a Config.
|
|
func WithCollectPeriod(period time.Duration) Option {
|
|
return collectPeriodOption(period)
|
|
}
|
|
|
|
type collectPeriodOption time.Duration
|
|
|
|
func (o collectPeriodOption) apply(cfg *config) {
|
|
cfg.CollectPeriod = time.Duration(o)
|
|
}
|
|
|
|
// WithCollectTimeout sets the CollectTimeout configuration option of a Config.
|
|
func WithCollectTimeout(timeout time.Duration) Option {
|
|
return collectTimeoutOption(timeout)
|
|
}
|
|
|
|
type collectTimeoutOption time.Duration
|
|
|
|
func (o collectTimeoutOption) apply(cfg *config) {
|
|
cfg.CollectTimeout = time.Duration(o)
|
|
}
|
|
|
|
// WithExporter sets the exporter configuration option of a Config.
|
|
func WithExporter(exporter export.Exporter) Option {
|
|
return exporterOption{exporter}
|
|
}
|
|
|
|
type exporterOption struct{ exporter export.Exporter }
|
|
|
|
func (o exporterOption) apply(cfg *config) {
|
|
cfg.Exporter = o.exporter
|
|
}
|
|
|
|
// WithPushTimeout sets the PushTimeout configuration option of a Config.
|
|
func WithPushTimeout(timeout time.Duration) Option {
|
|
return pushTimeoutOption(timeout)
|
|
}
|
|
|
|
type pushTimeoutOption time.Duration
|
|
|
|
func (o pushTimeoutOption) apply(cfg *config) {
|
|
cfg.PushTimeout = time.Duration(o)
|
|
}
|