Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Start moving telemetry initialization to service/telemetry (#6275)
Signed-off-by: Bogdan <bogdandrutu@gmail.com> Signed-off-by: Bogdan <bogdandrutu@gmail.com>
- Loading branch information
1 parent
f24a6ac
commit dfb21cf
Showing
9 changed files
with
166 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
change_type: enhancement | ||
|
||
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver) | ||
component: service/telemetry | ||
|
||
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
note: "Move logging and tracing initialization to service/telemetry" | ||
|
||
# One or more tracking issues or pull requests related to the change | ||
issues: [5564] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
// 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 telemetry // import "go.opentelemetry.io/collector/service/telemetry" | ||
|
||
import ( | ||
"context" | ||
|
||
sdktrace "go.opentelemetry.io/otel/sdk/trace" | ||
"go.opentelemetry.io/otel/trace" | ||
"go.uber.org/multierr" | ||
"go.uber.org/zap" | ||
"go.uber.org/zap/zapcore" | ||
) | ||
|
||
type Telemetry struct { | ||
logger *zap.Logger | ||
tracerProvider *sdktrace.TracerProvider | ||
} | ||
|
||
func (t *Telemetry) TracerProvider() trace.TracerProvider { | ||
return t.tracerProvider | ||
} | ||
|
||
func (t *Telemetry) Logger() *zap.Logger { | ||
return t.logger | ||
} | ||
|
||
func (t *Telemetry) Shutdown(ctx context.Context) error { | ||
// TODO: Sync logger. | ||
return multierr.Combine( | ||
t.tracerProvider.Shutdown(ctx), | ||
) | ||
} | ||
|
||
// Settings holds configuration for building Telemetry. | ||
type Settings struct { | ||
ZapOptions []zap.Option | ||
} | ||
|
||
// New creates a new Telemetry from Config. | ||
func New(_ context.Context, set Settings, cfg Config) (*Telemetry, error) { | ||
logger, err := newLogger(cfg.Logs, set.ZapOptions) | ||
if err != nil { | ||
return nil, err | ||
} | ||
tp := sdktrace.NewTracerProvider( | ||
// needed for supporting the zpages extension | ||
sdktrace.WithSampler(alwaysRecord()), | ||
) | ||
// TODO: Remove when https://github.com/open-telemetry/opentelemetry-go/pull/3268 released. | ||
// For the moment, register and unregister so shutdown does not fail. | ||
sp := &nopSpanProcessor{} | ||
tp.RegisterSpanProcessor(sp) | ||
tp.UnregisterSpanProcessor(sp) | ||
return &Telemetry{ | ||
logger: logger, | ||
tracerProvider: tp, | ||
}, nil | ||
} | ||
|
||
func newLogger(cfg LogsConfig, options []zap.Option) (*zap.Logger, error) { | ||
// Copied from NewProductionConfig. | ||
zapCfg := &zap.Config{ | ||
Level: zap.NewAtomicLevelAt(cfg.Level), | ||
Development: cfg.Development, | ||
Sampling: &zap.SamplingConfig{ | ||
Initial: 100, | ||
Thereafter: 100, | ||
}, | ||
Encoding: cfg.Encoding, | ||
EncoderConfig: zap.NewProductionEncoderConfig(), | ||
OutputPaths: cfg.OutputPaths, | ||
ErrorOutputPaths: cfg.ErrorOutputPaths, | ||
DisableCaller: cfg.DisableCaller, | ||
DisableStacktrace: cfg.DisableStacktrace, | ||
InitialFields: cfg.InitialFields, | ||
} | ||
|
||
if zapCfg.Encoding == "console" { | ||
// Human-readable timestamps for console format of logs. | ||
zapCfg.EncoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder | ||
} | ||
|
||
logger, err := zapCfg.Build(options...) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
return logger, nil | ||
} | ||
|
||
type nopSpanProcessor struct { | ||
} | ||
|
||
func (n nopSpanProcessor) OnStart(context.Context, sdktrace.ReadWriteSpan) {} | ||
|
||
func (n nopSpanProcessor) OnEnd(sdktrace.ReadOnlySpan) {} | ||
|
||
func (n nopSpanProcessor) Shutdown(context.Context) error { | ||
return nil | ||
} | ||
|
||
func (n nopSpanProcessor) ForceFlush(context.Context) error { | ||
return nil | ||
} |