-
Notifications
You must be signed in to change notification settings - Fork 27
Expand file tree
/
Copy pathclient.go
More file actions
696 lines (630 loc) · 23 KB
/
Copy pathclient.go
File metadata and controls
696 lines (630 loc) · 23 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
package beholder
import (
"context"
"errors"
"fmt"
"io"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc"
"go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp"
"go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc"
"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
otellog "go.opentelemetry.io/otel/log"
otelmetric "go.opentelemetry.io/otel/metric"
sdklog "go.opentelemetry.io/otel/sdk/log"
sdkmetric "go.opentelemetry.io/otel/sdk/metric"
sdkresource "go.opentelemetry.io/otel/sdk/resource"
sdktrace "go.opentelemetry.io/otel/sdk/trace"
oteltrace "go.opentelemetry.io/otel/trace"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/credentials/insecure"
"github.com/smartcontractkit/chainlink-common/pkg/chipingress"
pkglogger "github.com/smartcontractkit/chainlink-common/pkg/logger"
"github.com/smartcontractkit/chainlink-common/pkg/services"
)
const defaultGRPCCompressor = "gzip"
type Emitter interface {
// Sends message with bytes and attributes to OTel Collector
Emit(ctx context.Context, body []byte, attrKVs ...any) error
io.Closer
}
type Client struct {
services.Service
eng *services.Engine
Config Config
// Logger
Logger otellog.Logger
// Tracer
Tracer oteltrace.Tracer
// Meter
Meter otelmetric.Meter
// Message Emitter
Emitter Emitter
// Chip
Chip chipingress.Client
// Providers
LoggerProvider otellog.LoggerProvider
TracerProvider oteltrace.TracerProvider
MeterProvider otelmetric.MeterProvider
MessageLoggerProvider otellog.LoggerProvider
// lazySigner allows updating the keystore after client initialization.
lazySigner *lazySigner
// OnClose
OnClose func() error
}
// initService wires up the services.Service lifecycle for the Client.
// Must be called exactly once after populating the Client fields.
func (c *Client) initService(lggr pkglogger.Logger, batchSvc *ChipIngressBatchEmitterService) {
c.Service, c.eng = services.Config{
Name: "BeholderClient",
Close: c.close,
NewSubServices: func(l pkglogger.Logger) []services.Service {
if batchSvc == nil {
return nil
}
return []services.Service{batchSvc}
},
}.NewServiceEngine(lggr)
}
// NewClient creates a new Client with initialized OpenTelemetry components
// To handle OpenTelemetry errors use [otel.SetErrorHandler](https://pkg.go.dev/go.opentelemetry.io/otel#SetErrorHandler)
func NewClient(cfg Config) (*Client, error) {
if cfg.OtelExporterGRPCEndpoint != "" && cfg.OtelExporterHTTPEndpoint != "" {
return nil, errors.New("only one exporter endpoint should be set")
}
if cfg.OtelExporterGRPCEndpoint == "" && cfg.OtelExporterHTTPEndpoint == "" {
return nil, errors.New("at least one exporter endpoint should be set")
}
if cfg.OtelExporterHTTPEndpoint != "" {
factory := func(options ...otlploghttp.Option) (sdklog.Exporter, error) {
// note: context is unused internally
return otlploghttp.New(context.Background(), options...) //nolint
}
return NewHTTPClient(cfg, factory)
}
factory := func(options ...otlploggrpc.Option) (sdklog.Exporter, error) {
// note: context is unused internally
return otlploggrpc.New(context.Background(), options...) //nolint
}
return NewGRPCClient(cfg, factory)
}
// Used for testing to override the default exporter
type otlploggrpcFactory func(options ...otlploggrpc.Option) (sdklog.Exporter, error)
// NewGRPCClient creates a GRPC based beholder Client. Use NewClient to create a client from a Config which will pick
// the best client type from the Config.
func NewGRPCClient(cfg Config, otlploggrpcNew otlploggrpcFactory) (*Client, error) {
baseResource, err := newOtelResource(cfg)
if err != nil {
return nil, err
}
creds := insecure.NewCredentials()
if !cfg.InsecureConnection && cfg.CACertFile != "" {
creds, err = credentials.NewClientTLSFromFile(cfg.CACertFile, "")
if err != nil {
return nil, err
}
}
// Initialize auth here for reuse with log, trace, and metric exporters
// Two modes are supported:
// 1. Static auth: If AuthHeadersTTL == 0, use AuthHeaders as-is and never change
// 2. Rotating auth: If AuthHeadersTTL > 0, create lazySigner for deferred keystore injection
auth, signer, err := buildRotatingAuth(cfg)
if err != nil {
return nil, err
}
// Tracer
tracerProvider, err := newTracerProvider(cfg, baseResource, auth, creds)
if err != nil {
return nil, err
}
tracer := tracerProvider.Tracer(defaultPackageName)
// Meter
meterProvider, err := newMeterProvider(cfg, baseResource, auth, creds)
if err != nil {
return nil, err
}
meter := meterProvider.Meter(defaultPackageName)
// Shared log exporter for both logger and message emitter
logOpts, err := newLoggerOpts(cfg, auth, creds, meterProvider, tracerProvider)
if err != nil {
return nil, err
}
sharedLogExporter, err := otlploggrpcNew(logOpts...)
if err != nil {
return nil, err
}
// Logger
var loggerProvider *sdklog.LoggerProvider
if !cfg.LogStreamingEnabled {
loggerProvider = BeholderNoopLoggerProvider()
} else {
loggerOpts, err := newLoggerProviderOpts(cfg, baseResource, sharedLogExporter)
if err != nil {
return nil, err
}
loggerProvider = sdklog.NewLoggerProvider(loggerOpts...)
}
logger := loggerProvider.Logger(defaultPackageName)
// Message emitter
messageLoggerOpts, err := newMessageLoggerProviderOpts(cfg, baseResource, sharedLogExporter)
if err != nil {
return nil, err
}
messageLoggerProvider := sdklog.NewLoggerProvider(messageLoggerOpts...)
messageLogger := messageLoggerProvider.Logger(defaultPackageName)
// Use the messageEmitter by default
// This will eventually be removed in favor of chip-ingress emitter
// and logs will be sent via OTLP using the regular Logger instead of calling Emit
emitter := NewMessageEmitter(messageLogger)
var batchEmitterService *ChipIngressBatchEmitterService
var chipIngressClient chipingress.Client = &chipingress.NoopClient{}
lggr := cfg.ChipIngressLogger
if lggr == nil {
lggr = pkglogger.Nop()
}
// if chip ingress is enabled, create dual source emitter that sends to both otel collector and chip ingress
// eventually we will remove the dual source emitter and just use chip ingress
if cfg.ChipIngressEmitterEnabled || cfg.ChipIngressEmitterGRPCEndpoint != "" {
var opts []chipingress.Opt
resourceAttrs := resourceAttributesToStringMap(cfg.ResourceAttributes)
if cfg.ChipIngressInsecureConnection {
opts = append(opts, chipingress.WithInsecureConnection())
} else {
opts = append(opts, chipingress.WithTLS())
}
// Chip ingress auth
switch {
// Rotating auth
case auth != nil:
opts = append(opts, chipingress.WithTokenAuth(auth))
// Static auth
case len(cfg.AuthHeaders) > 0:
opts = append(opts, chipingress.WithTokenAuth(
NewStaticAuth(cfg.AuthHeaders, !cfg.ChipIngressInsecureConnection),
))
// No auth
default:
}
// Set OpenTelemetry providers
opts = append(opts, chipingress.WithMeterProvider(meterProvider))
opts = append(opts, chipingress.WithTracerProvider(tracerProvider))
if len(resourceAttrs) > 0 {
opts = append(opts, chipingress.WithHeaderProvider(chipingress.NewStaticHeaderProvider(chipingress.SanitizeMetadataHeaders(resourceAttrs))))
}
chipIngressClient, err = chipingress.NewClient(cfg.ChipIngressEmitterGRPCEndpoint, opts...)
if err != nil {
return nil, err
}
var chipIngressEmitter Emitter
if cfg.ChipIngressBatchEmitterEnabled {
if cfg.ChipIngressLogger == nil {
return nil, fmt.Errorf("ChipIngressLogger is required when ChipIngressBatchEmitterEnabled is true")
}
batchEmitterService, err = NewChipIngressBatchEmitterService(chipIngressClient, cfg, cfg.ChipIngressLogger)
if err != nil {
return nil, fmt.Errorf("failed to create chip ingress batch emitter: %w", err)
}
// Batch emitter lifecycle is owned by Client's service-engine sub-service wiring.
// Wrap it with noCloseEmitter so DualSourceEmitter.Close() does not attempt to
// close it directly; the service engine closes batchEmitterService in sub-service
// teardown after parent close hook completes.
chipIngressEmitter = noCloseEmitter{Emitter: batchEmitterService}
} else {
chipIngressEmitter, err = ChipIngressEmitterConfig{Lggr: lggr}.NewWithResourceAttributes(chipIngressClient, resourceAttrs)
if err != nil {
return nil, fmt.Errorf("failed to create chip ingress emitter: %w", err)
}
}
emitter, err = DualSourceEmitterConfig{Lggr: lggr}.New(chipIngressEmitter, emitter)
if err != nil {
return nil, fmt.Errorf("failed to create dual source emitter: %w", err)
}
}
onClose := func() (err error) {
for _, provider := range []shutdowner{messageLoggerProvider, loggerProvider, tracerProvider, meterProvider} {
err = errors.Join(err, provider.Shutdown(context.Background()))
}
return
}
c := &Client{
Config: cfg,
Logger: logger,
Tracer: tracer,
Meter: meter,
Emitter: emitter,
Chip: chipIngressClient,
LoggerProvider: loggerProvider,
TracerProvider: tracerProvider,
MeterProvider: meterProvider,
MessageLoggerProvider: messageLoggerProvider,
lazySigner: signer,
OnClose: onClose,
}
c.initService(lggr, batchEmitterService)
return c, nil
}
// close is the lifecycle Close hook: OTel/message shutdown and CHIP close.
func (c *Client) close() (err error) {
if c.Emitter != nil {
err = errors.Join(err, c.Emitter.Close())
}
if c.OnClose != nil {
err = errors.Join(err, c.OnClose())
}
return err
}
// noCloseEmitter delegates Emit to the wrapped emitter but makes Close a no-op.
// Use this when lifecycle ownership is external (e.g. service engine sub-service).
type noCloseEmitter struct{ Emitter }
func (n noCloseEmitter) Close() error { return nil }
// Returns a new Client with the same configuration but with a different package name
// Deprecated: Use ForName
func (c Client) ForPackage(name string) Client {
return c.ForName(name)
}
// ForName returns a new Client with the same configuration but with a different name.
// For global package-scoped telemetry, use the package name.
// For injected component-scoped telemetry, use a fully qualified name that uniquely identifies this instance.
func (c Client) ForName(name string) Client {
// Logger
logger := c.LoggerProvider.Logger(name)
// Tracer
tracer := c.TracerProvider.Tracer(name)
// Meter
meter := c.MeterProvider.Meter(name)
// Message Emitter
messageLogger := c.MessageLoggerProvider.Logger(name)
messageEmitter := &messageEmitter{messageLogger: messageLogger}
newClient := c // copy
newClient.Logger = logger
newClient.Tracer = tracer
newClient.Meter = meter
newClient.Emitter = messageEmitter
return newClient
}
// SetSigner updates the signer in the lazy signer.
// This method enables setting the signer after the beholder client has been created, which is useful
// when the signer is not available at client initialization time but the client needs to be configured
// with rotating auth. The underlying lazy signer is thread-safe.
func (c *Client) SetSigner(signer Signer) {
if c.lazySigner != nil {
c.lazySigner.Set(signer)
}
}
// IsSignerSet returns true if a signer has been set in the lazy signer.
func (c *Client) IsSignerSet() bool {
return c.lazySigner != nil && c.lazySigner.IsSet()
}
func newOtelResource(cfg Config) (resource *sdkresource.Resource, err error) {
extraResources, err := sdkresource.New(
context.Background(),
sdkresource.WithOS(),
sdkresource.WithContainer(),
sdkresource.WithHost(),
)
if err != nil {
return nil, err
}
resource, err = sdkresource.Merge(
sdkresource.Default(),
extraResources,
)
if err != nil {
return nil, err
}
// Add csa public key resource attribute
csaPublicKeyHex := "not-configured"
if len(cfg.AuthPublicKeyHex) > 0 {
csaPublicKeyHex = cfg.AuthPublicKeyHex
}
csaPublicKeyAttr := attribute.String("csa_public_key", csaPublicKeyHex)
resource, err = sdkresource.Merge(
sdkresource.NewSchemaless(csaPublicKeyAttr),
resource,
)
if err != nil {
return nil, err
}
// Add custom resource attributes
resource, err = sdkresource.Merge(
sdkresource.NewSchemaless(cfg.ResourceAttributes...),
resource,
)
if err != nil {
return nil, err
}
return
}
// RecordConfig records the beholder config as a metric.
func (c *Client) RecordConfigMetric(ctx context.Context) error {
configGauge, configAttrs, err := createConfigMetric(c.Meter, c.Config)
if err != nil {
return err
}
configGauge.Record(ctx, 1, otelmetric.WithAttributes(configAttrs...))
return nil
}
// createConfigMetric creates a configuration info metric with Beholder settings as attributes.
func createConfigMetric(meter otelmetric.Meter, cfg Config) (otelmetric.Int64Gauge, []attribute.KeyValue, error) {
configGauge, err := meter.Int64Gauge(
"beholder.config.info",
otelmetric.WithDescription("Beholder config info metric"),
otelmetric.WithUnit("{info}"),
)
if err != nil {
return nil, nil, fmt.Errorf("failed to create beholder config info metric: %w", err)
}
configAttrs := []attribute.KeyValue{
// Logging config
attribute.Bool(
"log_streaming_enabled", cfg.LogStreamingEnabled),
attribute.String(
"log_level", cfg.LogLevel.String()),
attribute.Bool(
"log_batch_processor", cfg.LogBatchProcessor),
attribute.String(
"log_export_interval", cfg.LogExportInterval.String()),
attribute.Int(
"log_export_max_batch_size", cfg.LogExportMaxBatchSize),
attribute.Int(
"log_max_queue_size", cfg.LogMaxQueueSize),
attribute.String(
"log_compressor", cfg.LogCompressor),
// Message emitter config
attribute.Bool(
"chip_ingress_enabled", cfg.ChipIngressEmitterEnabled),
attribute.Bool(
"emitter_batch_processor", cfg.EmitterBatchProcessor),
attribute.String(
"emitter_export_interval", cfg.EmitterExportInterval.String()),
attribute.Int(
"emitter_export_max_batch_size", cfg.EmitterExportMaxBatchSize),
attribute.Int(
"emitter_max_queue_size", cfg.EmitterMaxQueueSize),
// Tracing config
attribute.Float64(
"trace_sample_ratio", cfg.TraceSampleRatio),
attribute.String(
"trace_batch_timeout", cfg.TraceBatchTimeout.String()),
attribute.String(
"trace_compressor", cfg.TraceCompressor),
// Metrics config
attribute.String(
"metric_reader_interval", cfg.MetricReaderInterval.String()),
attribute.String(
"metric_compressor", cfg.MetricCompressor),
}
return configGauge, configAttrs, nil
}
type shutdowner interface {
Shutdown(ctx context.Context) error
}
func newTracerProvider(config Config, resource *sdkresource.Resource, auth Auth, creds credentials.TransportCredentials) (*sdktrace.TracerProvider, error) {
ctx := context.Background()
exporterOpts := []otlptracegrpc.Option{
otlptracegrpc.WithTLSCredentials(creds),
otlptracegrpc.WithEndpoint(config.OtelExporterGRPCEndpoint),
}
switch {
// Rotating auth
case auth != nil:
exporterOpts = append(exporterOpts, otlptracegrpc.WithDialOption(authDialOpt(auth)))
// Static auth
case len(config.AuthHeaders) > 0:
exporterOpts = append(exporterOpts, otlptracegrpc.WithHeaders(config.AuthHeaders))
// No auth
default:
}
switch compressor := config.TraceCompressor; compressor {
case "none":
case "":
exporterOpts = append(exporterOpts, otlptracegrpc.WithCompressor(defaultGRPCCompressor))
default:
exporterOpts = append(exporterOpts, otlptracegrpc.WithCompressor(compressor))
}
if config.TraceRetryConfig != nil {
// NOTE: By default, the retry is enabled in the OTel SDK
exporterOpts = append(exporterOpts, otlptracegrpc.WithRetry(otlptracegrpc.RetryConfig{
Enabled: config.TraceRetryConfig.Enabled(),
InitialInterval: config.TraceRetryConfig.GetInitialInterval(),
MaxInterval: config.TraceRetryConfig.GetMaxInterval(),
MaxElapsedTime: config.TraceRetryConfig.GetMaxElapsedTime(),
}))
}
// note: context is used internally
exporter, err := otlptracegrpc.New(ctx, exporterOpts...)
if err != nil {
return nil, err
}
batcherOpts := []sdktrace.BatchSpanProcessorOption{}
if config.TraceBatchTimeout > 0 {
batcherOpts = append(batcherOpts, sdktrace.WithBatchTimeout(config.TraceBatchTimeout)) // Default is 5s
}
opts := []sdktrace.TracerProviderOption{
sdktrace.WithBatcher(exporter, batcherOpts...),
sdktrace.WithResource(resource),
sdktrace.WithSampler(
sdktrace.ParentBased(
sdktrace.TraceIDRatioBased(config.TraceSampleRatio),
),
),
}
if config.TraceSpanExporter != nil {
opts = append(opts, sdktrace.WithBatcher(config.TraceSpanExporter))
}
return sdktrace.NewTracerProvider(opts...), nil
}
func newMeterProvider(cfg Config, resource *sdkresource.Resource, auth Auth, creds credentials.TransportCredentials) (*sdkmetric.MeterProvider, error) {
ctx := context.Background()
opts := []otlpmetricgrpc.Option{
otlpmetricgrpc.WithTLSCredentials(creds),
otlpmetricgrpc.WithEndpoint(cfg.OtelExporterGRPCEndpoint),
}
switch compressor := cfg.MetricCompressor; compressor {
case "none":
case "":
opts = append(opts, otlpmetricgrpc.WithCompressor(defaultGRPCCompressor))
default:
opts = append(opts, otlpmetricgrpc.WithCompressor(compressor))
}
switch {
// Rotating auth
case auth != nil:
opts = append(opts, otlpmetricgrpc.WithDialOption(authDialOpt(auth)))
// Static auth
case len(cfg.AuthHeaders) > 0:
opts = append(opts, otlpmetricgrpc.WithHeaders(cfg.AuthHeaders))
// No auth
default:
}
if cfg.MetricRetryConfig != nil {
// NOTE: By default, the retry is enabled in the OTel SDK
opts = append(opts, otlpmetricgrpc.WithRetry(otlpmetricgrpc.RetryConfig{
Enabled: cfg.MetricRetryConfig.Enabled(),
InitialInterval: cfg.MetricRetryConfig.GetInitialInterval(),
MaxInterval: cfg.MetricRetryConfig.GetMaxInterval(),
MaxElapsedTime: cfg.MetricRetryConfig.GetMaxElapsedTime(),
}))
}
// note: context is unused internally
exporter, err := otlpmetricgrpc.New(ctx, opts...)
if err != nil {
return nil, err
}
readerOpts := []sdkmetric.PeriodicReaderOption{
sdkmetric.WithInterval(cfg.MetricReaderInterval), // Default is 10s
}
for _, p := range cfg.MetricProducers {
readerOpts = append(readerOpts, sdkmetric.WithProducer(p))
}
return sdkmetric.NewMeterProvider(
sdkmetric.WithReader(sdkmetric.NewPeriodicReader(exporter, readerOpts...)),
sdkmetric.WithResource(resource),
sdkmetric.WithView(cfg.MetricViews...),
), nil
}
// newLoggerOpts creates options for a logger exporter
func newLoggerOpts(cfg Config, auth Auth, creds credentials.TransportCredentials, meter *sdkmetric.MeterProvider, tracer *sdktrace.TracerProvider) ([]otlploggrpc.Option, error) {
otelOpts := []otelgrpc.Option{
otelgrpc.WithMeterProvider(meter),
otelgrpc.WithTracerProvider(tracer),
}
dialOpts := []grpc.DialOption{
grpc.WithStatsHandler(otelgrpc.NewClientHandler(otelOpts...)),
}
opts := []otlploggrpc.Option{
otlploggrpc.WithTLSCredentials(creds),
otlploggrpc.WithEndpoint(cfg.OtelExporterGRPCEndpoint),
}
switch compressor := cfg.LogCompressor; compressor {
case "none":
case "":
opts = append(opts, otlploggrpc.WithCompressor(defaultGRPCCompressor))
default:
opts = append(opts, otlploggrpc.WithCompressor(compressor))
}
// Log exporter auth
switch {
// Rotating auth
case auth != nil:
dialOpts = append(dialOpts, authDialOpt(auth))
// Static auth
case len(cfg.AuthHeaders) > 0:
opts = append(opts, otlploggrpc.WithHeaders(cfg.AuthHeaders))
// No auth
default:
}
opts = append(opts, otlploggrpc.WithDialOption(dialOpts...))
if cfg.LogRetryConfig != nil {
// NOTE: By default, the retry is enabled in the OTel SDK
opts = append(opts, otlploggrpc.WithRetry(otlploggrpc.RetryConfig{
Enabled: cfg.LogRetryConfig.Enabled(),
InitialInterval: cfg.LogRetryConfig.GetInitialInterval(),
MaxInterval: cfg.LogRetryConfig.GetMaxInterval(),
MaxElapsedTime: cfg.LogRetryConfig.GetMaxElapsedTime(),
}))
}
return opts, nil
}
// newLoggerProviderOpts creates logger provider options for application logs
func newLoggerProviderOpts(cfg Config, baseResource *sdkresource.Resource, sharedLogExporter sdklog.Exporter) ([]sdklog.LoggerProviderOption, error) {
var loggerProcessor sdklog.Processor
if cfg.LogBatchProcessor {
batchProcessorOpts := []sdklog.BatchProcessorOption{}
if cfg.LogExportTimeout > 0 {
batchProcessorOpts = append(batchProcessorOpts, sdklog.WithExportTimeout(cfg.LogExportTimeout)) // Default is 30s
}
if cfg.LogExportMaxBatchSize > 0 {
batchProcessorOpts = append(batchProcessorOpts, sdklog.WithExportMaxBatchSize(cfg.LogExportMaxBatchSize)) // Default is 512, must be <= maxQueueSize
}
if cfg.LogExportInterval > 0 {
batchProcessorOpts = append(batchProcessorOpts, sdklog.WithExportInterval(cfg.LogExportInterval)) // Default is 1s
}
if cfg.LogMaxQueueSize > 0 {
batchProcessorOpts = append(batchProcessorOpts, sdklog.WithMaxQueueSize(cfg.LogMaxQueueSize)) // Default is 2048
}
loggerProcessor = sdklog.NewBatchProcessor(
sharedLogExporter,
batchProcessorOpts...,
)
} else {
loggerProcessor = sdklog.NewSimpleProcessor(sharedLogExporter)
}
loggerAttributes := []attribute.KeyValue{
attribute.String(AttrKeyDataType, "zap_log_message"),
}
loggerResource, err := sdkresource.Merge(
sdkresource.NewSchemaless(loggerAttributes...),
baseResource,
)
if err != nil {
return nil, err
}
return []sdklog.LoggerProviderOption{
sdklog.WithResource(loggerResource),
sdklog.WithProcessor(loggerProcessor),
}, nil
}
// newMessageLoggerProviderOpts creates logger provider options for custom message emitter
func newMessageLoggerProviderOpts(cfg Config, baseResource *sdkresource.Resource, sharedLogExporter sdklog.Exporter) ([]sdklog.LoggerProviderOption, error) {
var messageLogProcessor sdklog.Processor
// EmitterBatchProcessor=true uses async batching for custom-message logs;
// false uses a simple processor that exports each record immediately.
if cfg.EmitterBatchProcessor {
batchProcessorOpts := []sdklog.BatchProcessorOption{}
if cfg.EmitterExportTimeout > 0 {
batchProcessorOpts = append(batchProcessorOpts, sdklog.WithExportTimeout(cfg.EmitterExportTimeout)) // Default is 30s
}
if cfg.EmitterExportMaxBatchSize > 0 {
batchProcessorOpts = append(batchProcessorOpts, sdklog.WithExportMaxBatchSize(cfg.EmitterExportMaxBatchSize)) // Default is 512, must be <= maxQueueSize
}
if cfg.EmitterExportInterval > 0 {
batchProcessorOpts = append(batchProcessorOpts, sdklog.WithExportInterval(cfg.EmitterExportInterval)) // Default is 1s
}
if cfg.EmitterMaxQueueSize > 0 {
batchProcessorOpts = append(batchProcessorOpts, sdklog.WithMaxQueueSize(cfg.EmitterMaxQueueSize)) // Default is 2048
}
messageLogProcessor = sdklog.NewBatchProcessor(
sharedLogExporter,
batchProcessorOpts...,
)
} else {
messageLogProcessor = sdklog.NewSimpleProcessor(sharedLogExporter)
}
messageAttributes := []attribute.KeyValue{
attribute.String(AttrKeyDataType, "custom_message"),
}
messageLoggerResource, err := sdkresource.Merge(
sdkresource.NewSchemaless(messageAttributes...),
baseResource,
)
if err != nil {
return nil, err
}
return []sdklog.LoggerProviderOption{
sdklog.WithResource(messageLoggerResource),
sdklog.WithProcessor(messageLogProcessor),
}, nil
}