Fix an issue with the static to flow converter for blackbox exporter …

…modules (grafana#5476) config not being included in the river output. Signed-off-by: erikbaranowski <[email protected]>
tpaschalis · Oct 13, 2023 · 04b90c6 · 04b90c6
1 parent e4eed15
commit 04b90c6
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -32,6 +32,9 @@ Main (unreleased)
 
 - Fix the handling of the `--cluster.join-addresses` flag causing an invalid
   comparison with the mutually-exclusive `--cluster.discover-peers`. (@tpaschalis)
+
+- Fix an issue with the static to flow converter for blackbox exporter modules
+  config not being included in the river output. (@erikbaranowski)
 
 ### Enhancements
 

diff --git a/component/prometheus/exporter/blackbox/blackbox.go b/component/prometheus/exporter/blackbox/blackbox.go
@@ -13,6 +13,7 @@ import (
 	"github.com/grafana/agent/component/prometheus/exporter"
 	"github.com/grafana/agent/pkg/integrations"
 	"github.com/grafana/agent/pkg/integrations/blackbox_exporter"
+	"github.com/grafana/agent/pkg/util"
 	"github.com/grafana/river/rivertypes"
 )
 
@@ -92,7 +93,6 @@ type Arguments struct {
 	Config             rivertypes.OptionalSecret `river:"config,attr,optional"`
 	Targets            TargetBlock               `river:"target,block"`
 	ProbeTimeoutOffset time.Duration             `river:"probe_timeout_offset,attr,optional"`
-	ConfigStruct       blackbox_config.Config
 }
 
 // SetToDefault implements river.Defaulter.
@@ -106,7 +106,8 @@ func (a *Arguments) Validate() error {
 		return errors.New("config and config_file are mutually exclusive")
 	}
 
-	err := yaml.UnmarshalStrict([]byte(a.Config.Value), &a.ConfigStruct)
+	var blackboxConfig blackbox_config.Config
+	err := yaml.UnmarshalStrict([]byte(a.Config.Value), &blackboxConfig)
 	if err != nil {
 		return fmt.Errorf("invalid backbox_exporter config: %s", err)
 	}
@@ -118,7 +119,7 @@ func (a *Arguments) Validate() error {
 func (a *Arguments) Convert() *blackbox_exporter.Config {
 	return &blackbox_exporter.Config{
 		BlackboxConfigFile: a.ConfigFile,
-		BlackboxConfig:     a.ConfigStruct,
+		BlackboxConfig:     util.RawYAML(a.Config.Value),
 		BlackboxTargets:    a.Targets.Convert(),
 		ProbeTimeoutOffset: a.ProbeTimeoutOffset.Seconds(),
 	}

diff --git a/component/prometheus/exporter/blackbox/blackbox_test.go b/component/prometheus/exporter/blackbox/blackbox_test.go
@@ -7,8 +7,10 @@ import (
 	"github.com/grafana/agent/component"
 	"github.com/grafana/agent/component/discovery"
 	"github.com/grafana/river"
+	blackbox_config "github.com/prometheus/blackbox_exporter/config"
 	"github.com/prometheus/common/model"
 	"github.com/stretchr/testify/require"
+	"gopkg.in/yaml.v2"
 )
 
 func TestUnmarshalRiver(t *testing.T) {
@@ -56,8 +58,11 @@ func TestUnmarshalRiverWithInlineConfig(t *testing.T) {
 	err := river.Unmarshal([]byte(riverCfg), &args)
 	require.NoError(t, err)
 	require.Equal(t, "", args.ConfigFile)
-	require.Equal(t, args.ConfigStruct.Modules["http_2xx"].Prober, "http")
-	require.Equal(t, args.ConfigStruct.Modules["http_2xx"].Timeout, 5*time.Second)
+	var blackboxConfig blackbox_config.Config
+	err = yaml.UnmarshalStrict([]byte(args.Config.Value), &blackboxConfig)
+	require.NoError(t, err)
+	require.Equal(t, blackboxConfig.Modules["http_2xx"].Prober, "http")
+	require.Equal(t, blackboxConfig.Modules["http_2xx"].Timeout, 5*time.Second)
 	require.Equal(t, 2, len(args.Targets))
 	require.Equal(t, 500*time.Millisecond, args.ProbeTimeoutOffset)
 	require.Contains(t, "target_a", args.Targets[0].Name)
@@ -67,6 +72,40 @@ func TestUnmarshalRiverWithInlineConfig(t *testing.T) {
 	require.Contains(t, "http://grafana.com", args.Targets[1].Target)
 	require.Contains(t, "http_2xx", args.Targets[1].Module)
 }
+
+func TestUnmarshalRiverWithInlineConfigYaml(t *testing.T) {
+	riverCfg := `
+		config = "modules:\n  http_2xx:\n    prober: http\n    timeout: 5s\n"
+
+		target "target_a" {
+			address = "http://example.com"
+			module = "http_2xx"
+		}
+		target "target_b" {
+			address = "http://grafana.com"
+			module = "http_2xx"
+		}
+		probe_timeout_offset = "0.5s"
+`
+	var args Arguments
+	err := river.Unmarshal([]byte(riverCfg), &args)
+	require.NoError(t, err)
+	require.Equal(t, "", args.ConfigFile)
+	var blackboxConfig blackbox_config.Config
+	err = yaml.UnmarshalStrict([]byte(args.Config.Value), &blackboxConfig)
+	require.NoError(t, err)
+	require.Equal(t, blackboxConfig.Modules["http_2xx"].Prober, "http")
+	require.Equal(t, blackboxConfig.Modules["http_2xx"].Timeout, 5*time.Second)
+	require.Equal(t, 2, len(args.Targets))
+	require.Equal(t, 500*time.Millisecond, args.ProbeTimeoutOffset)
+	require.Contains(t, "target_a", args.Targets[0].Name)
+	require.Contains(t, "http://example.com", args.Targets[0].Target)
+	require.Contains(t, "http_2xx", args.Targets[0].Module)
+	require.Contains(t, "target_b", args.Targets[1].Name)
+	require.Contains(t, "http://grafana.com", args.Targets[1].Target)
+	require.Contains(t, "http_2xx", args.Targets[1].Module)
+}
+
 func TestUnmarshalRiverWithInvalidInlineConfig(t *testing.T) {
 	var tests = []struct {
 		testname      string

diff --git a/converter/internal/staticconvert/internal/build/blackbox_exporter.go b/converter/internal/staticconvert/internal/build/blackbox_exporter.go
@@ -26,11 +26,13 @@ func (b *IntegrationsV1ConfigBuilder) appendBlackboxExporter(config *blackbox_ex
 
 func toBlackboxExporter(config *blackbox_exporter.Config) *blackbox.Arguments {
 	return &blackbox.Arguments{
-		ConfigFile:         config.BlackboxConfigFile,
-		Config:             rivertypes.OptionalSecret{},
+		ConfigFile: config.BlackboxConfigFile,
+		Config: rivertypes.OptionalSecret{
+			IsSecret: false,
+			Value:    string(config.BlackboxConfig),
+		},
 		Targets:            toBlackboxTargets(config.BlackboxTargets),
 		ProbeTimeoutOffset: time.Duration(config.ProbeTimeoutOffset),
-		ConfigStruct:       config.BlackboxConfig,
 	}
 }
 

diff --git a/converter/internal/staticconvert/testdata/integrations.river b/converter/internal/staticconvert/testdata/integrations.river
@@ -25,6 +25,8 @@ prometheus.remote_write "integrations" {
 }
 
 prometheus.exporter.blackbox "integrations_blackbox" {
+	config = "modules:\n  http_2xx:\n    prober: http\n    timeout: 5s\n    http:\n      method: POST\n      headers:\n        Content-Type: application/json\n      body: '{}'\n      preferred_ip_protocol: ip4\n"
+
 	target "example" {
 		address = "http://example.com"
 		module  = "http_2xx"

diff --git a/pkg/integrations/blackbox_exporter/blackbox_exporter.go b/pkg/integrations/blackbox_exporter/blackbox_exporter.go
@@ -9,9 +9,11 @@ import (
 	"github.com/go-kit/log"
 	"github.com/grafana/agent/pkg/integrations"
 	"github.com/grafana/agent/pkg/integrations/config"
+	"github.com/grafana/agent/pkg/util"
 	blackbox_config "github.com/prometheus/blackbox_exporter/config"
 	"github.com/prometheus/blackbox_exporter/prober"
 	"github.com/prometheus/client_golang/prometheus"
+	"gopkg.in/yaml.v3"
 )
 
 // DefaultConfig holds the default settings for the blackbox_exporter integration.
@@ -39,18 +41,24 @@ type BlackboxTarget struct {
 
 // Config configures the Blackbox integration.
 type Config struct {
-	BlackboxConfigFile string                 `yaml:"config_file,omitempty"`
-	BlackboxTargets    []BlackboxTarget       `yaml:"blackbox_targets"`
-	BlackboxConfig     blackbox_config.Config `yaml:"blackbox_config,omitempty"`
-	ProbeTimeoutOffset float64                `yaml:"probe_timeout_offset,omitempty"`
+	BlackboxConfigFile string           `yaml:"config_file,omitempty"`
+	BlackboxTargets    []BlackboxTarget `yaml:"blackbox_targets"`
+	BlackboxConfig     util.RawYAML     `yaml:"blackbox_config,omitempty"`
+	ProbeTimeoutOffset float64          `yaml:"probe_timeout_offset,omitempty"`
 }
 
 // UnmarshalYAML implements yaml.Unmarshaler for Config.
 func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error {
 	*c = DefaultConfig
 
 	type plain Config
-	return unmarshal((*plain)(c))
+	err := unmarshal((*plain)(c))
+	if err != nil {
+		return err
+	}
+
+	var blackbox_config blackbox_config.Config
+	return yaml.Unmarshal(c.BlackboxConfig, &blackbox_config)
 }
 
 // Name returns the name of the integration.
@@ -96,7 +104,13 @@ func LoadBlackboxConfig(log log.Logger, configFile string, targets []BlackboxTar
 
 // New creates a new blackbox_exporter integration
 func New(log log.Logger, c *Config) (integrations.Integration, error) {
-	modules, err := LoadBlackboxConfig(log, c.BlackboxConfigFile, c.BlackboxTargets, &c.BlackboxConfig)
+	var blackbox_config blackbox_config.Config
+	err := yaml.Unmarshal(c.BlackboxConfig, &blackbox_config)
+	if err != nil {
+		return nil, err
+	}
+
+	modules, err := LoadBlackboxConfig(log, c.BlackboxConfigFile, c.BlackboxTargets, &blackbox_config)
 	if err != nil {
 		return nil, err
 	}