Add custom healthcheckextension

components/components.go

@@ -117,6 +117,7 @@ import (
  "github.com/SigNoz/signoz-otel-collector/exporter/clickhousemetricsexporter"
  "github.com/SigNoz/signoz-otel-collector/exporter/clickhousetracesexporter"
  "github.com/SigNoz/signoz-otel-collector/exporter/signozkafkaexporter"
+ signozhealthcheckextension "github.com/SigNoz/signoz-otel-collector/extension/healthcheckextension"
  _ "github.com/SigNoz/signoz-otel-collector/pkg/parser/grok"
  "github.com/SigNoz/signoz-otel-collector/processor/signozlogspipelineprocessor"
  "github.com/SigNoz/signoz-otel-collector/processor/signozspanmetricsprocessor"
@@ -304,6 +305,7 @@ func CoreComponents() (
  oidcauthextension.NewFactory(),
  healthcheckextension.NewFactory(),
  pprofextension.NewFactory(),
+ signozhealthcheckextension.NewFactory(),
  zpagesextension.NewFactory(),
  )
  errs = multierr.Append(errs, err)

extension/healthcheckextension/Makefile

@@ -0,0 +1,2 @@
+include ../../Makefile.Common
+

extension/healthcheckextension/README.md

@@ -0,0 +1,3 @@
+# Health Check
+
+This is a copy of upstream health check that always returns healthy.

extension/healthcheckextension/config.go

@@ -0,0 +1,74 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package healthcheckextension // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextension"
+
+import (
+ "errors"
+ "strings"
+ "time"
+
+ "go.opentelemetry.io/collector/component"
+ "go.opentelemetry.io/collector/config/confighttp"
+)
+
+type ResponseBodySettings struct {
+ // Healthy represents the body of the response returned when the collector is healthy.
+ // The default value is ""
+ Healthy string `mapstructure:"healthy"`
+
+ // Unhealthy represents the body of the response returned when the collector is unhealthy.
+ // The default value is ""
+ Unhealthy string `mapstructure:"unhealthy"`
+}
+
+// Config has the configuration for the extension enabling the health check
+// extension, used to report the health status of the service.
+type Config struct {
+ confighttp.ServerConfig `mapstructure:",squash"`
+
+ // Path represents the path the health check service will serve.
+ // The default path is "/".
+ Path string `mapstructure:"path"`
+
+ // ResponseBody represents the body of the response returned by the health check service.
+ // This overrides the default response that it would return.
+ ResponseBody *ResponseBodySettings `mapstructure:"response_body"`
+
+ // CheckCollectorPipeline contains the list of settings of collector pipeline health check
+ CheckCollectorPipeline checkCollectorPipelineSettings `mapstructure:"check_collector_pipeline"`
+}
+
+var _ component.Config = (*Config)(nil)
+var (
+ errNoEndpointProvided = errors.New("bad config: endpoint must be specified")
+ errInvalidExporterFailureThresholdProvided = errors.New("bad config: exporter_failure_threshold expects a positive number")
+ errInvalidPath = errors.New("bad config: path must start with /")
+)
+
+// Validate checks if the extension configuration is valid
+func (cfg *Config) Validate() error {
+ _, err := time.ParseDuration(cfg.CheckCollectorPipeline.Interval)
+ if err != nil {
+ return err
+ }
+ if cfg.Endpoint == "" {
+ return errNoEndpointProvided
+ }
+ if cfg.CheckCollectorPipeline.ExporterFailureThreshold <= 0 {
+ return errInvalidExporterFailureThresholdProvided
+ }
+ if !strings.HasPrefix(cfg.Path, "/") {
+ return errInvalidPath
+ }
+ return nil
+}
+
+type checkCollectorPipelineSettings struct {
+ // Enabled indicates whether to not enable collector pipeline check.
+ Enabled bool `mapstructure:"enabled"`
+ // Interval the time range to check healthy status of collector pipeline
+ Interval string `mapstructure:"interval"`
+ // ExporterFailureThreshold is the threshold of exporter failure numbers during the Interval
+ ExporterFailureThreshold int `mapstructure:"exporter_failure_threshold"`
+}

extension/healthcheckextension/config_test.go

@@ -0,0 +1,80 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package healthcheckextension
+
+import (
+ "path/filepath"
+ "testing"
+
+ "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/configtls"
+ "go.opentelemetry.io/collector/confmap/confmaptest"
+
+ "github.com/SigNoz/signoz-otel-collector/extension/healthcheckextension/internal/metadata"
+)
+
+func TestLoadConfig(t *testing.T) {
+ t.Parallel()
+
+ tests := []struct {
+ id component.ID
+ expected component.Config
+ expectedErr error
+ }{
+ {
+ id: component.NewID(metadata.Type),
+ expected: NewFactory().CreateDefaultConfig(),
+ },
+ {
+ id: component.NewIDWithName(metadata.Type, "1"),
+ expected: &Config{
+ ServerConfig: confighttp.ServerConfig{
+ Endpoint: "localhost:13",
+ TLSSetting: &configtls.ServerConfig{
+ Config: configtls.Config{
+ CAFile: "/path/to/ca",
+ CertFile: "/path/to/cert",
+ KeyFile: "/path/to/key",
+ },
+ },
+ },
+ CheckCollectorPipeline: defaultCheckCollectorPipelineSettings(),
+ Path: "/",
+ ResponseBody: nil,
+ },
+ },
+ {
+ id: component.NewIDWithName(metadata.Type, "missingendpoint"),
+ expectedErr: errNoEndpointProvided,
+ },
+ {
+ id: component.NewIDWithName(metadata.Type, "invalidthreshold"),
+ expectedErr: errInvalidExporterFailureThresholdProvided,
+ },
+ {
+ id: component.NewIDWithName(metadata.Type, "invalidpath"),
+ expectedErr: errInvalidPath,
+ },
+ }
+ for _, tt := range tests {
+ t.Run(tt.id.String(), func(t *testing.T) {
+ cm, err := confmaptest.LoadConf(filepath.Join("testdata", "config.yaml"))
+ require.NoError(t, err)
+ factory := NewFactory()
+ cfg := factory.CreateDefaultConfig()
+ sub, err := cm.Sub(tt.id.String())
+ require.NoError(t, err)
+ require.NoError(t, component.UnmarshalConfig(sub, cfg))
+ if tt.expectedErr != nil {
+ assert.ErrorIs(t, component.ValidateConfig(cfg), tt.expectedErr)
+ return
+ }
+ assert.NoError(t, component.ValidateConfig(cfg))
+ assert.Equal(t, tt.expected, cfg)
+ })
+ }
+}

extension/healthcheckextension/doc.go

@@ -0,0 +1,9 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:generate mdatagen metadata.yaml
+
+// Package healthcheckextension implements an extension that enables an HTTP
+// endpoint that can be used to check the overall health and status of the
+// service.
+package healthcheckextension // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextension"

extension/healthcheckextension/factory.go

@@ -0,0 +1,52 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package healthcheckextension // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextension"
+
+import (
+ "context"
+ "fmt"
+
+ "go.opentelemetry.io/collector/component"
+ "go.opentelemetry.io/collector/config/confighttp"
+ "go.opentelemetry.io/collector/extension"
+
+ "github.com/SigNoz/signoz-otel-collector/extension/healthcheckextension/internal/metadata"
+)
+
+const defaultPort = 13133
+
+// NewFactory creates a factory for HealthCheck extension.
+func NewFactory() extension.Factory {
+ return extension.NewFactory(
+ metadata.Type,
+ createDefaultConfig,
+ createExtension,
+ metadata.ExtensionStability,
+ )
+}
+
+func createDefaultConfig() component.Config {
+ return &Config{
+ ServerConfig: confighttp.ServerConfig{
+ Endpoint: fmt.Sprintf("0.0.0.0:%d", defaultPort),
+ },
+ CheckCollectorPipeline: defaultCheckCollectorPipelineSettings(),
+ Path: "/",
+ }
+}
+
+func createExtension(_ context.Context, set extension.CreateSettings, cfg component.Config) (extension.Extension, error) {
+ config := cfg.(*Config)
+
+ return newServer(*config, set.TelemetrySettings), nil
+}
+
+// defaultCheckCollectorPipelineSettings returns the default settings for CheckCollectorPipeline.
+func defaultCheckCollectorPipelineSettings() checkCollectorPipelineSettings {
+ return checkCollectorPipelineSettings{
+ Enabled: false,
+ Interval: "5m",
+ ExporterFailureThreshold: 5,
+ }
+}

extension/healthcheckextension/factory_test.go

@@ -0,0 +1,42 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package healthcheckextension
+
+import (
+ "context"
+ "testing"
+
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+ "go.opentelemetry.io/collector/component/componenttest"
+ "go.opentelemetry.io/collector/config/confighttp"
+ "go.opentelemetry.io/collector/extension/extensiontest"
+
+ "github.com/SigNoz/signoz-otel-collector/internal/common/testutil"
+)
+
+func TestFactory_CreateDefaultConfig(t *testing.T) {
+ cfg := createDefaultConfig()
+ assert.Equal(t, &Config{
+ ServerConfig: confighttp.ServerConfig{
+ Endpoint: "0.0.0.0:13133",
+ },
+ CheckCollectorPipeline: defaultCheckCollectorPipelineSettings(),
+ Path: "/",
+ }, cfg)
+
+ assert.NoError(t, componenttest.CheckConfigStruct(cfg))
+ ext, err := createExtension(context.Background(), extensiontest.NewNopCreateSettings(), cfg)
+ require.NoError(t, err)
+ require.NotNil(t, ext)
+}
+
+func TestFactory_CreateExtension(t *testing.T) {
+ cfg := createDefaultConfig().(*Config)
+ cfg.Endpoint = testutil.GetAvailableLocalAddress(t)
+
+ ext, err := createExtension(context.Background(), extensiontest.NewNopCreateSettings(), cfg)
+ require.NoError(t, err)
+ require.NotNil(t, ext)
+}