[exporter/bmchelix] Second PR of New component: BMC Helix Exporter (#…

…37350)

* Implemented core functionality in `exporter.go` to handle metric
transformation and payload dispatch to BMC Helix.
* Added `metrics_client.go` with HTTP client configuration.
* Added `metrics_producer.go` to produce BMC Helix-compatible payloads.
* Added unit tests.

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
This pull request introduces the BMC Helix Exporter, which is
responsible for exporting metrics to BMC Helix Operations Management.
The most important changes include the implementation of the exporter,
configuration adjustments, and the addition of unit tests.

##### Implementation of BMC Helix Exporter:

*
[`exporter/bmchelixexporter/exporter.go`](diffhunk://#diff-4a430330ea5f9e90bc37821ca52351bc66219d4da8a1da11299b049cd4864214R1-R84):
Introduced `BmcHelixExporter` class with methods to start the exporter
and push metrics to BMC Helix.
* Developed `metrics_producer.go` to build the BMC Helix Operations
Management expected metric payloads.
*
[`exporter/bmchelixexporter/metrics_client.go`](diffhunk://#diff-9a8d71b75da3d5cc679440769fae03014ae601d122e65e5797ea9866cb9cf341R1-R93):
Added `MetricsClient` class responsible for sending metrics payloads to
BMC Helix.

##### Configuration Adjustments:

*
[`exporter/bmchelixexporter/config.go`](diffhunk://#diff-4b576c9fd2cd87cecaf1fd1182f88283e38a6e2f4c6c28549f98f22ad60949dcL8-L17):
Replaced `Endpoint` and `Timeout` fields with `confighttp.ClientConfig`
to handle HTTP client configuration.
*
[`exporter/bmchelixexporter/factory.go`](diffhunk://#diff-f69eea4d007085533aa8bb35cc91f6c41f1783a87998eaa3ddefd1730ea2d0fbR30-R54):
Updated `createDefaultConfig` to use `confighttp.NewDefaultClientConfig`
and adjusted the `createMetricsExporter` function to initialize the
exporter properly.

##### Unit Tests:

*
[`exporter/bmchelixexporter/config_test.go`](diffhunk://#diff-b79eedb9dda64716aecd4902019fc29dc3ade40d26b5b32081d60d5c43d6fd4bL34-L45):
Modified tests to accommodate changes in configuration structure and
added helper function `createDefaultClientConfig`.
*
[`exporter/bmchelixexporter/exporter_test.go`](diffhunk://#diff-ed008fa0f26264e77c8516b3334f98fdc7f9bbac4fd7bc09719033c57331ad5fR1-R28):
Added unit tests for `newBmcHelixExporter` function to ensure proper
initialization.
* `exporter/bmchelixexporter/metrics_producer.go`:  Added unit tests.
* `exporter/bmchelixexporter/metrics_client.go`:  Added unit tests.

##### Changelog Entry:

*
[`.chloggen/bmchelixexporter-metrics-implementation.yaml`](diffhunk://#diff-e86aa08891f9688ad1995e82d398c481bedbbdea3903847c853585869c2feb65R1-R27):
Added a new changelog entry for the BMC Helix Exporter metrics
implementation.
<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes #36773

<!--Describe what testing was performed and which tests were added.
#### Testing-->

<!--Describe the documentation added.-
#### Documentation->

<!--Please delete paragraphs that you did not use before submitting.-->

.chloggen/bmchelixexporter-metrics-implementation.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: new_component
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: bmchelixexporter
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: metrics implementation
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [36773]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: 
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: [user]

exporter/bmchelixexporter/config.go

@@ -5,17 +5,17 @@ package bmchelixexporter // import "github.com/open-telemetry/opentelemetry-coll
 
 import (
 	"errors"
-	"time"
 
+	"go.opentelemetry.io/collector/config/confighttp"
+	"go.opentelemetry.io/collector/config/configopaque"
 	"go.opentelemetry.io/collector/config/configretry"
 )
 
 // Config struct is used to store the configuration of the exporter
 type Config struct {
-	Endpoint    string                    `mapstructure:"endpoint"`
-	APIKey      string                    `mapstructure:"api_key"`
-	Timeout     time.Duration             `mapstructure:"timeout"`
-	RetryConfig configretry.BackOffConfig `mapstructure:"retry_on_failure"`
+	confighttp.ClientConfig `mapstructure:",squash"`
+	APIKey                  configopaque.String       `mapstructure:"api_key"`
+	RetryConfig             configretry.BackOffConfig `mapstructure:"retry_on_failure"`
 }
 
 // validate the configuration

exporter/bmchelixexporter/config_test.go

@@ -11,6 +11,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/config/confighttp"
 	"go.opentelemetry.io/collector/config/configretry"
 	"go.opentelemetry.io/collector/confmap/confmaptest"
 
@@ -31,18 +32,16 @@ func TestLoadConfig(t *testing.T) {
 		{
 			id: component.NewIDWithName(metadata.Type, "helix1"),
 			expected: &Config{
-				Endpoint:    "https://helix1:8080",
-				APIKey:      "api_key",
-				Timeout:     10 * time.Second,
-				RetryConfig: configretry.NewDefaultBackOffConfig(),
+				ClientConfig: createDefaultClientConfig("https://helix1:8080", 10*time.Second),
+				APIKey:       "api_key",
+				RetryConfig:  configretry.NewDefaultBackOffConfig(),
 			},
 		},
 		{
 			id: component.NewIDWithName(metadata.Type, "helix2"),
 			expected: &Config{
-				Endpoint: "https://helix2:8080",
-				APIKey:   "api_key",
-				Timeout:  20 * time.Second,
+				ClientConfig: createDefaultClientConfig("https://helix2:8080", 20*time.Second),
+				APIKey:       "api_key",
 				RetryConfig: configretry.BackOffConfig{
 					Enabled:             true,
 					InitialInterval:     5 * time.Second,
@@ -79,9 +78,8 @@ func TestValidateConfig(t *testing.T) {
 		{
 			name: "valid_config",
 			config: &Config{
-				Endpoint: "https://helix:8080",
-				APIKey:   "api_key",
-				Timeout:  10 * time.Second,
+				ClientConfig: createDefaultClientConfig("https://helix:8080", 10*time.Second),
+				APIKey:       "api_key",
 			},
 		},
 		{
@@ -94,25 +92,23 @@ func TestValidateConfig(t *testing.T) {
 		{
 			name: "invalid_config2",
 			config: &Config{
-				Endpoint: "https://helix:8080",
+				ClientConfig: createDefaultClientConfig("https://helix:8080", 10*time.Second),
 			},
 			err: "api key is required",
 		},
 		{
 			name: "invalid_config3",
 			config: &Config{
-				Endpoint: "https://helix:8080",
-				APIKey:   "api_key",
-				Timeout:  -1,
+				ClientConfig: createDefaultClientConfig("https://helix:8080", -1),
+				APIKey:       "api_key",
 			},
 			err: "timeout must be a positive integer",
 		},
 		{
 			name: "invalid_config4",
 			config: &Config{
-				Endpoint: "https://helix:8080",
-				APIKey:   "api_key",
-				Timeout:  0,
+				ClientConfig: createDefaultClientConfig("https://helix:8080", 0),
+				APIKey:       "api_key",
 			},
 			err: "timeout must be a positive integer",
 		},
@@ -130,3 +126,11 @@ func TestValidateConfig(t *testing.T) {
 		})
 	}
 }
+
+// createDefaultClientConfig creates a default client config for testing
+func createDefaultClientConfig(endpoint string, timeout time.Duration) confighttp.ClientConfig {
+	cfg := confighttp.NewDefaultClientConfig()
+	cfg.Endpoint = endpoint
+	cfg.Timeout = timeout
+	return cfg
+}

exporter/bmchelixexporter/exporter_metrics.go

@@ -0,0 +1,76 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package bmchelixexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/bmchelixexporter"
+
+import (
+	"context"
+	"errors"
+
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/exporter"
+	"go.opentelemetry.io/collector/pdata/pmetric"
+	"go.uber.org/zap"
+
+	om "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/bmchelixexporter/internal/operationsmanagement"
+)
+
+// metricsExporter is responsible for exporting metrics to BMC Helix
+type metricsExporter struct {
+	config            *Config
+	logger            *zap.Logger
+	version           string
+	telemetrySettings component.TelemetrySettings
+	producer          *om.MetricsProducer
+	client            *om.MetricsClient
+}
+
+// newMetricsExporter instantiates a new metrics exporter for BMC Helix
+func newMetricsExporter(config *Config, createSettings exporter.Settings) (*metricsExporter, error) {
+	if config == nil {
+		return nil, errors.New("nil config")
+	}
+
+	return &metricsExporter{
+		config:            config,
+		version:           createSettings.BuildInfo.Version,
+		logger:            createSettings.Logger,
+		telemetrySettings: createSettings.TelemetrySettings,
+	}, nil
+}
+
+// pushMetrics is invoked by the OpenTelemetry Collector to push metrics to BMC Helix
+func (me *metricsExporter) pushMetrics(ctx context.Context, md pmetric.Metrics) error {
+	helixMetrics, err := me.producer.ProduceHelixPayload(md)
+	if err != nil {
+		me.logger.Error("Failed to build BMC Helix Metrics payload", zap.Error(err))
+		return err
+	}
+
+	err = me.client.SendHelixPayload(ctx, helixMetrics)
+	if err != nil {
+		me.logger.Error("Failed to send BMC Helix Metrics payload", zap.Error(err))
+		return err
+	}
+
+	return nil
+}
+
+// start is invoked during service start
+func (me *metricsExporter) start(ctx context.Context, host component.Host) error {
+	me.logger.Info("Starting BMC Helix Metrics Exporter")
+
+	// Initialize and store the MetricsProducer
+	me.producer = om.NewMetricsProducer(me.logger)
+
+	// Initialize and store the MetricsClient
+	client, err := om.NewMetricsClient(ctx, me.config.ClientConfig, me.config.APIKey, host, me.telemetrySettings, me.logger)
+	if err != nil {
+		me.logger.Error("Failed to create MetricsClient", zap.Error(err))
+		return err
+	}
+	me.client = client
+
+	me.logger.Info("Initialized BMC Helix Metrics Exporter")
+	return nil
+}

exporter/bmchelixexporter/exporter_metrics_test.go

@@ -0,0 +1,28 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package bmchelixexporter
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"go.opentelemetry.io/collector/exporter/exportertest"
+)
+
+func TestNewMetricsExporterWithNilConfig(t *testing.T) {
+	t.Parallel()
+
+	exp, err := newMetricsExporter(nil, exportertest.NewNopSettings())
+	assert.Nil(t, exp)
+	assert.Error(t, err)
+}
+
+func TestNewMetricsExporterWithDefaultConfig(t *testing.T) {
+	t.Parallel()
+
+	cfg := createDefaultConfig().(*Config)
+	exp, err := newMetricsExporter(cfg, exportertest.NewNopSettings())
+	assert.NotNil(t, exp)
+	assert.NoError(t, err)
+}

exporter/bmchelixexporter/factory.go

@@ -8,10 +8,10 @@ import (
 	"time"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/config/confighttp"
 	"go.opentelemetry.io/collector/config/configretry"
 	"go.opentelemetry.io/collector/exporter"
 	"go.opentelemetry.io/collector/exporter/exporterhelper"
-	"go.opentelemetry.io/collector/pdata/pmetric"
 
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/bmchelixexporter/internal/metadata"
 )
@@ -27,20 +27,30 @@ func NewFactory() exporter.Factory {
 
 // creates the default configuration for the BMC Helix exporter
 func createDefaultConfig() component.Config {
+	httpClientConfig := confighttp.NewDefaultClientConfig()
+	httpClientConfig.Timeout = 10 * time.Second
+
 	return &Config{
-		Timeout:     10 * time.Second,
-		RetryConfig: configretry.NewDefaultBackOffConfig(),
+		ClientConfig: httpClientConfig,
+		RetryConfig:  configretry.NewDefaultBackOffConfig(),
 	}
 }
 
 // creates an exporter.Metrics that records observability metrics for BMC Helix
 func createMetricsExporter(ctx context.Context, set exporter.Settings, cfg component.Config) (exporter.Metrics, error) {
+	config := cfg.(*Config)
+	exporter, err := newMetricsExporter(config, set)
+	if err != nil {
+		return nil, err
+	}
+
 	return exporterhelper.NewMetrics(
 		ctx,
 		set,
-		cfg,
-		func(_ context.Context, _ pmetric.Metrics) error {
-			return nil
-		},
+		config,
+		exporter.pushMetrics,
+		exporterhelper.WithTimeout(exporterhelper.TimeoutConfig{Timeout: 0}),
+		exporterhelper.WithRetry(config.RetryConfig),
+		exporterhelper.WithStart(exporter.start),
 	)
 }

exporter/bmchelixexporter/go.mod

@@ -6,55 +6,70 @@ require (
 	github.com/stretchr/testify v1.10.0
 	go.opentelemetry.io/collector/component v0.119.0
 	go.opentelemetry.io/collector/component/componenttest v0.119.0
+	go.opentelemetry.io/collector/config/confighttp v0.119.0
+	go.opentelemetry.io/collector/config/configopaque v1.25.0
 	go.opentelemetry.io/collector/config/configretry v1.25.0
 	go.opentelemetry.io/collector/confmap v1.25.0
 	go.opentelemetry.io/collector/exporter v0.119.0
 	go.opentelemetry.io/collector/exporter/exportertest v0.119.0
 	go.opentelemetry.io/collector/pdata v1.25.0
+	go.opentelemetry.io/collector/semconv v0.119.0
 	go.uber.org/goleak v1.3.0
+	go.uber.org/zap v1.27.0
 )
 
 require (
 	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/felixge/httpsnoop v1.0.4 // indirect
+	github.com/fsnotify/fsnotify v1.8.0 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-viper/mapstructure/v2 v2.2.1 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/hashicorp/go-version v1.7.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/compress v1.17.11 // indirect
 	github.com/knadh/koanf/maps v0.1.1 // indirect
 	github.com/knadh/koanf/providers/confmap v0.1.0 // indirect
 	github.com/knadh/koanf/v2 v2.1.2 // indirect
 	github.com/mitchellh/copystructure v1.2.0 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/pierrec/lz4/v4 v4.1.22 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/rs/cors v1.11.1 // indirect
 	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
+	go.opentelemetry.io/collector/client v1.25.0 // indirect
+	go.opentelemetry.io/collector/config/configauth v0.119.0 // indirect
+	go.opentelemetry.io/collector/config/configcompression v1.25.0 // indirect
 	go.opentelemetry.io/collector/config/configtelemetry v0.119.0 // indirect
+	go.opentelemetry.io/collector/config/configtls v1.25.0 // indirect
 	go.opentelemetry.io/collector/consumer v1.25.0 // indirect
 	go.opentelemetry.io/collector/consumer/consumererror v0.119.0 // indirect
 	go.opentelemetry.io/collector/consumer/consumertest v0.119.0 // indirect
 	go.opentelemetry.io/collector/consumer/xconsumer v0.119.0 // indirect
 	go.opentelemetry.io/collector/exporter/xexporter v0.119.0 // indirect
 	go.opentelemetry.io/collector/extension v0.119.0 // indirect
+	go.opentelemetry.io/collector/extension/auth v0.119.0 // indirect
 	go.opentelemetry.io/collector/extension/xextension v0.119.0 // indirect
 	go.opentelemetry.io/collector/featuregate v1.25.0 // indirect
 	go.opentelemetry.io/collector/pdata/pprofile v0.119.0 // indirect
 	go.opentelemetry.io/collector/pipeline v0.119.0 // indirect
 	go.opentelemetry.io/collector/receiver v0.119.0 // indirect
 	go.opentelemetry.io/collector/receiver/receivertest v0.119.0 // indirect
 	go.opentelemetry.io/collector/receiver/xreceiver v0.119.0 // indirect
+	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.59.0 // indirect
 	go.opentelemetry.io/otel v1.34.0 // indirect
 	go.opentelemetry.io/otel/metric v1.34.0 // indirect
 	go.opentelemetry.io/otel/sdk v1.34.0 // indirect
 	go.opentelemetry.io/otel/sdk/metric v1.34.0 // indirect
 	go.opentelemetry.io/otel/trace v1.34.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
-	go.uber.org/zap v1.27.0 // indirect
-	golang.org/x/net v0.33.0 // indirect
+	golang.org/x/net v0.34.0 // indirect
 	golang.org/x/sys v0.29.0 // indirect
 	golang.org/x/text v0.21.0 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20241202173237-19429a94021a // indirect