diff --git a/.changeset/beholder-telemetry-metric-export-batch-size.md b/.changeset/beholder-telemetry-metric-export-batch-size.md new file mode 100644 index 00000000000..7f67eb594cd --- /dev/null +++ b/.changeset/beholder-telemetry-metric-export-batch-size.md @@ -0,0 +1,5 @@ +--- +"chainlink": patch +--- + +#added `Telemetry.MetricExportBatchSize` config limiting metric data points per OTLP export request (0 disables batching); passed to the Beholder client and LOOP plugins diff --git a/core/cmd/shell.go b/core/cmd/shell.go index 9f2f36fed74..9358503fb63 100644 --- a/core/cmd/shell.go +++ b/core/cmd/shell.go @@ -180,6 +180,7 @@ func newBeholderClient( MetricViews: metricViews(), MetricViewsDenyAttributes: cfgTelemetry.MetricViewsDenyAttributes(), MetricCardinalityLimit: cfgTelemetry.MetricCardinalityLimit(), + MetricExportBatchSize: cfgTelemetry.MetricExportBatchSize(), } if cfgTracing.Enabled() { diff --git a/core/config/docs/core.toml b/core/config/docs/core.toml index 80f81e5efb2..b6795ae06c4 100644 --- a/core/config/docs/core.toml +++ b/core/config/docs/core.toml @@ -913,6 +913,8 @@ LogMaxQueueSize = 2048 # Default MetricViewsDenyAttributes = ['event_id'] # Default # MetricCardinalityLimit sets the OTel SDK per-instrument attribute-set limit (0 disables). MetricCardinalityLimit = 100000 # Default +# MetricExportBatchSize limits metric data points per OTLP export request. 0 disables SDK-side batching. +MetricExportBatchSize = 0 # Default # ResourceAttributes are global metadata to include with all telemetry. [Telemetry.ResourceAttributes] diff --git a/core/config/telemetry_config.go b/core/config/telemetry_config.go index 108786f0cb4..834fdd34842 100644 --- a/core/config/telemetry_config.go +++ b/core/config/telemetry_config.go @@ -41,6 +41,7 @@ type Telemetry interface { LogMaxQueueSize() int MetricViewsDenyAttributes() []string MetricCardinalityLimit() int + MetricExportBatchSize() int PrometheusBridge() PrometheusBridge } diff --git a/core/config/toml/types.go b/core/config/toml/types.go index 460d9512c7e..8ac9551b995 100644 --- a/core/config/toml/types.go +++ b/core/config/toml/types.go @@ -3047,6 +3047,7 @@ type Telemetry struct { LogMaxQueueSize *int MetricViewsDenyAttributes []string MetricCardinalityLimit *int + MetricExportBatchSize *int PrometheusBridge PrometheusBridge `toml:",omitempty"` } @@ -3154,6 +3155,9 @@ func (b *Telemetry) setFrom(f *Telemetry) { if v := f.MetricCardinalityLimit; v != nil { b.MetricCardinalityLimit = v } + if v := f.MetricExportBatchSize; v != nil { + b.MetricExportBatchSize = v + } b.PrometheusBridge.setFrom(&f.PrometheusBridge) } diff --git a/core/services/chainlink/config_telemetry.go b/core/services/chainlink/config_telemetry.go index 548c2c5b098..377eeea89d8 100644 --- a/core/services/chainlink/config_telemetry.go +++ b/core/services/chainlink/config_telemetry.go @@ -288,6 +288,13 @@ func (b *telemetryConfig) MetricCardinalityLimit() int { return *b.s.MetricCardinalityLimit } +func (b *telemetryConfig) MetricExportBatchSize() int { + if b.s.MetricExportBatchSize == nil || *b.s.MetricExportBatchSize <= 0 { + return 0 + } + return *b.s.MetricExportBatchSize +} + func (b *telemetryConfig) PrometheusBridge() config.PrometheusBridge { return &prometheusBridgeConfig{b.s.PrometheusBridge} } diff --git a/core/services/chainlink/config_telemetry_test.go b/core/services/chainlink/config_telemetry_test.go index 94b25466db3..6e39deba492 100644 --- a/core/services/chainlink/config_telemetry_test.go +++ b/core/services/chainlink/config_telemetry_test.go @@ -623,3 +623,26 @@ func TestTelemetryConfig_MetricCardinalityLimit(t *testing.T) { assert.Equal(t, 100000, tc.MetricCardinalityLimit()) }) } + +func TestTelemetryConfig_MetricExportBatchSize(t *testing.T) { + t.Parallel() + + tests := []struct { + name string + telemetry toml.Telemetry + expected int + }{ + {"ExplicitPositive", toml.Telemetry{MetricExportBatchSize: new(500)}, 500}, + {"NilDisables", toml.Telemetry{}, 0}, + {"ZeroDisables", toml.Telemetry{MetricExportBatchSize: new(0)}, 0}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + t.Parallel() + + tc := telemetryConfig{s: tt.telemetry} + assert.Equal(t, tt.expected, tc.MetricExportBatchSize()) + }) + } +} diff --git a/core/services/chainlink/config_test.go b/core/services/chainlink/config_test.go index 0d9219aa82b..871e2409d1b 100644 --- a/core/services/chainlink/config_test.go +++ b/core/services/chainlink/config_test.go @@ -558,6 +558,7 @@ func TestConfig_Marshal(t *testing.T) { LogMaxQueueSize: new(2048), MetricViewsDenyAttributes: []string{"event_id"}, MetricCardinalityLimit: new(100000), + MetricExportBatchSize: new(0), PrometheusBridge: toml.PrometheusBridge{ Enabled: new(true), diff --git a/core/services/chainlink/testdata/config-empty-effective.toml b/core/services/chainlink/testdata/config-empty-effective.toml index 3e6fb0dd366..2b7f909fb1d 100644 --- a/core/services/chainlink/testdata/config-empty-effective.toml +++ b/core/services/chainlink/testdata/config-empty-effective.toml @@ -358,6 +358,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/core/services/chainlink/testdata/config-full.toml b/core/services/chainlink/testdata/config-full.toml index 06a9b4c014f..9e6105e0180 100644 --- a/core/services/chainlink/testdata/config-full.toml +++ b/core/services/chainlink/testdata/config-full.toml @@ -377,6 +377,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.ResourceAttributes] Baz = 'test' diff --git a/core/services/chainlink/testdata/config-multi-chain-effective.toml b/core/services/chainlink/testdata/config-multi-chain-effective.toml index 98600eeaa73..6c811059afc 100644 --- a/core/services/chainlink/testdata/config-multi-chain-effective.toml +++ b/core/services/chainlink/testdata/config-multi-chain-effective.toml @@ -358,6 +358,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/core/web/resolver/testdata/config-empty-effective.toml b/core/web/resolver/testdata/config-empty-effective.toml index 3e6fb0dd366..2b7f909fb1d 100644 --- a/core/web/resolver/testdata/config-empty-effective.toml +++ b/core/web/resolver/testdata/config-empty-effective.toml @@ -358,6 +358,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/core/web/resolver/testdata/config-full.toml b/core/web/resolver/testdata/config-full.toml index 8735192c3ca..0c0fd70c46d 100644 --- a/core/web/resolver/testdata/config-full.toml +++ b/core/web/resolver/testdata/config-full.toml @@ -372,6 +372,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.ResourceAttributes] Baz = 'test' diff --git a/core/web/resolver/testdata/config-multi-chain-effective.toml b/core/web/resolver/testdata/config-multi-chain-effective.toml index d031ee10283..f64d319458f 100644 --- a/core/web/resolver/testdata/config-multi-chain-effective.toml +++ b/core/web/resolver/testdata/config-multi-chain-effective.toml @@ -358,6 +358,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/docs/CONFIG.md b/docs/CONFIG.md index 8919ca2c7ad..753331d1fab 100644 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -2324,6 +2324,7 @@ LogExportInterval = '1s' # Default LogMaxQueueSize = 2048 # Default MetricViewsDenyAttributes = ['event_id'] # Default MetricCardinalityLimit = 100000 # Default +MetricExportBatchSize = 0 # Default ``` Telemetry holds OTEL settings. This data includes open telemetry metrics, traces, & logs. @@ -2534,6 +2535,12 @@ MetricCardinalityLimit = 100000 # Default ``` MetricCardinalityLimit sets the OTel SDK per-instrument attribute-set limit (0 disables). +### MetricExportBatchSize +```toml +MetricExportBatchSize = 0 # Default +``` +MetricExportBatchSize limits metric data points per OTLP export request. 0 disables SDK-side batching. + ## Telemetry.ResourceAttributes ```toml [Telemetry.ResourceAttributes] diff --git a/plugins/loop_registry.go b/plugins/loop_registry.go index 1af64cbfef0..8388f604ec8 100644 --- a/plugins/loop_registry.go +++ b/plugins/loop_registry.go @@ -177,6 +177,7 @@ func (m *LoopRegistry) Register(id string) (*RegisteredLoop, error) { envCfg.TelemetryMetricViewsDenyAttributes = m.cfgTelemetry.MetricViewsDenyAttributes() limit := m.cfgTelemetry.MetricCardinalityLimit() envCfg.TelemetryMetricCardinalityLimit = &limit + envCfg.TelemetryMetricExportBatchSize = m.cfgTelemetry.MetricExportBatchSize() envCfg.TelemetryPrometheusBridgeEnabled = m.cfgTelemetry.PrometheusBridge().Enabled() envCfg.TelemetryPrometheusBridgePrefixes = m.cfgTelemetry.PrometheusBridge().Prefixes() } diff --git a/plugins/loop_registry_test.go b/plugins/loop_registry_test.go index 544ba45deed..8c5537a372b 100644 --- a/plugins/loop_registry_test.go +++ b/plugins/loop_registry_test.go @@ -124,6 +124,7 @@ func (m mockCfgTelemetry) MetricViewsDenyAttributes() []string { return []string{"event_id"} } func (m mockCfgTelemetry) MetricCardinalityLimit() int { return 100000 } +func (m mockCfgTelemetry) MetricExportBatchSize() int { return 0 } func (m mockCfgTelemetry) PrometheusBridge() coreconfig.PrometheusBridge { return mockPrometheusBridge{} @@ -312,6 +313,7 @@ func TestLoopRegistry_Register(t *testing.T) { require.Equal(t, []string{"event_id"}, envCfg.TelemetryMetricViewsDenyAttributes) require.NotNil(t, envCfg.TelemetryMetricCardinalityLimit) require.Equal(t, 100000, *envCfg.TelemetryMetricCardinalityLimit) + require.Equal(t, 0, envCfg.TelemetryMetricExportBatchSize) require.Equal(t, "example.com/chip-ingress", envCfg.ChipIngressEndpoint) require.False(t, envCfg.ChipIngressBatchEmitterEnabled) diff --git a/testdata/scripts/config/merge_raw_configs.txtar b/testdata/scripts/config/merge_raw_configs.txtar index 1463970ca35..0b74ec8ee88 100644 --- a/testdata/scripts/config/merge_raw_configs.txtar +++ b/testdata/scripts/config/merge_raw_configs.txtar @@ -505,6 +505,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/testdata/scripts/node/validate/default.txtar b/testdata/scripts/node/validate/default.txtar index e423ec523f9..9fed818f480 100644 --- a/testdata/scripts/node/validate/default.txtar +++ b/testdata/scripts/node/validate/default.txtar @@ -370,6 +370,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/testdata/scripts/node/validate/defaults-override.txtar b/testdata/scripts/node/validate/defaults-override.txtar index 20f3b565be0..4e1f9cb18ce 100644 --- a/testdata/scripts/node/validate/defaults-override.txtar +++ b/testdata/scripts/node/validate/defaults-override.txtar @@ -431,6 +431,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/testdata/scripts/node/validate/disk-based-logging-disabled.txtar b/testdata/scripts/node/validate/disk-based-logging-disabled.txtar index 721d1701c82..bb54d9ae9d3 100644 --- a/testdata/scripts/node/validate/disk-based-logging-disabled.txtar +++ b/testdata/scripts/node/validate/disk-based-logging-disabled.txtar @@ -414,6 +414,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/testdata/scripts/node/validate/disk-based-logging-no-dir.txtar b/testdata/scripts/node/validate/disk-based-logging-no-dir.txtar index d5337a40c9a..d6d5369e4c8 100644 --- a/testdata/scripts/node/validate/disk-based-logging-no-dir.txtar +++ b/testdata/scripts/node/validate/disk-based-logging-no-dir.txtar @@ -414,6 +414,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/testdata/scripts/node/validate/disk-based-logging.txtar b/testdata/scripts/node/validate/disk-based-logging.txtar index 7ff4cbf59b5..a5a565ad912 100644 --- a/testdata/scripts/node/validate/disk-based-logging.txtar +++ b/testdata/scripts/node/validate/disk-based-logging.txtar @@ -414,6 +414,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/testdata/scripts/node/validate/fallback-override.txtar b/testdata/scripts/node/validate/fallback-override.txtar index e34c251e4de..8d6f145d702 100644 --- a/testdata/scripts/node/validate/fallback-override.txtar +++ b/testdata/scripts/node/validate/fallback-override.txtar @@ -513,6 +513,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/testdata/scripts/node/validate/invalid-ocr-p2p.txtar b/testdata/scripts/node/validate/invalid-ocr-p2p.txtar index 3ed1117dd42..7f85555dd6e 100644 --- a/testdata/scripts/node/validate/invalid-ocr-p2p.txtar +++ b/testdata/scripts/node/validate/invalid-ocr-p2p.txtar @@ -399,6 +399,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/testdata/scripts/node/validate/invalid.txtar b/testdata/scripts/node/validate/invalid.txtar index 1c27e505de9..b62aa46dbee 100644 --- a/testdata/scripts/node/validate/invalid.txtar +++ b/testdata/scripts/node/validate/invalid.txtar @@ -410,6 +410,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/testdata/scripts/node/validate/valid.txtar b/testdata/scripts/node/validate/valid.txtar index cfdb2cae79b..50c633cf950 100644 --- a/testdata/scripts/node/validate/valid.txtar +++ b/testdata/scripts/node/validate/valid.txtar @@ -411,6 +411,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false diff --git a/testdata/scripts/node/validate/warnings.txtar b/testdata/scripts/node/validate/warnings.txtar index 9e15d037a5b..781e1b44923 100644 --- a/testdata/scripts/node/validate/warnings.txtar +++ b/testdata/scripts/node/validate/warnings.txtar @@ -393,6 +393,7 @@ LogExportInterval = '1s' LogMaxQueueSize = 2048 MetricViewsDenyAttributes = ['event_id'] MetricCardinalityLimit = 100000 +MetricExportBatchSize = 0 [Telemetry.PrometheusBridge] Enabled = false