Skip to content

[exporter/Sematext] Second PR of New component: Sematext Exporter #37642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 34 commits into from
Mar 6, 2025
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
40ef42e
Add metrics support for Config
AkhigbeEromo Feb 3, 2025
689d903
Add test for config
AkhigbeEromo Feb 3, 2025
df50493
Add basic metrics support
AkhigbeEromo Feb 3, 2025
0bcde39
Add changelog
AkhigbeEromo Feb 3, 2025
ad0cdd6
Fix lint and Unit tests
AkhigbeEromo Feb 3, 2025
2880243
Correct collector module version
AkhigbeEromo Feb 3, 2025
78cc7c0
Merge branch 'main' into Otel-Contrib-Second-PR
AkhigbeEromo Feb 4, 2025
dc30f2e
Update collector module version
AkhigbeEromo Feb 4, 2025
3a4c43e
Merge branch 'main' into Otel-Contrib-Second-PR
AkhigbeEromo Feb 4, 2025
8f3d2f7
Merge branch 'main' into Otel-Contrib-Second-PR
AkhigbeEromo Feb 5, 2025
f40edcf
Merge branch 'main' into Otel-Contrib-Second-PR
AkhigbeEromo Feb 11, 2025
66f5869
Merge branch 'main' into Otel-Contrib-Second-PR
AkhigbeEromo Feb 13, 2025
c3b0fc3
Update collector module version
AkhigbeEromo Feb 13, 2025
2d4a90c
Remove deprecated component
AkhigbeEromo Feb 13, 2025
59a0b09
Update Collector Module Version
AkhigbeEromo Feb 13, 2025
dc4098d
Merge branch 'main' into Otel-Contrib-Second-PR
AkhigbeEromo Feb 13, 2025
d41025c
Remove default metrics endpoint and app token
AkhigbeEromo Feb 18, 2025
05a1524
Move Queue Settings to cover both metrics and logs
AkhigbeEromo Feb 18, 2025
fdb3910
Update exporter/sematextexporter/config.go
AkhigbeEromo Feb 18, 2025
532ae2e
Update README.md
AkhigbeEromo Feb 18, 2025
aeced5d
Remove default for region
AkhigbeEromo Feb 18, 2025
5c3960e
Fix lint issues
AkhigbeEromo Feb 18, 2025
3af5124
Merge branch 'main' into Otel-Contrib-Second-PR
AkhigbeEromo Feb 18, 2025
475e5ce
Update module version
AkhigbeEromo Feb 18, 2025
0a35131
Update README.md
AkhigbeEromo Feb 18, 2025
44ad551
Update config.go
AkhigbeEromo Feb 18, 2025
ca70f1d
Update module version
AkhigbeEromo Feb 18, 2025
2d1396d
Merge branch 'main' into Otel-Contrib-Second-PR
AkhigbeEromo Mar 5, 2025
5ada085
Merge branch 'main' into Otel-Contrib-Second-PR
AkhigbeEromo Mar 5, 2025
40a1ece
Update go.mod
AkhigbeEromo Mar 6, 2025
2253617
Update go.sum
AkhigbeEromo Mar 6, 2025
3c1ee0c
Merge branch 'main' into Otel-Contrib-Second-PR
AkhigbeEromo Mar 6, 2025
c0a9896
Update exporter/sematextexporter/go.sum
AkhigbeEromo Mar 6, 2025
3ecbc2a
Update exporter/sematextexporter/go.mod
AkhigbeEromo Mar 6, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .chloggen/sematext-metrics.yaml
Original file line number Diff line number Diff line change
@@ -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: sematextexporter

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: basic metrics implementation

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [36465]

# (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]
67 changes: 66 additions & 1 deletion exporter/sematextexporter/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,69 @@

package sematextexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/sematextexporter"

type Config struct{}
import (
"fmt"
"regexp"
"strings"

"go.opentelemetry.io/collector/config/confighttp"
"go.opentelemetry.io/collector/config/configretry"
"go.opentelemetry.io/collector/exporter/exporterhelper"
)

const (
euRegion = "eu"
usRegion = "us"
euMetricsEndpoint = "https://spm-receiver.eu.sematext.com"
usMetricsEndpoint = "https://spm-receiver.sematext.com"
)

type Config struct {
confighttp.ClientConfig `mapstructure:",squash"`
configretry.BackOffConfig `mapstructure:"retry_on_failure"`
// Region specifies the Sematext region the user is operating in
// Options:
// - EU
// - US
Region string `mapstructure:"region"`
// MetricsConfig defines the configuration specific to metrics
MetricsConfig `mapstructure:"metrics"`
}
type MetricsConfig struct {
// App token is the token of Sematext Monitoring App to which you want to send the metrics.
AppToken string `mapstructure:"app_token"`
// MetricsEndpoint specifies the endpoint for receiving metrics in Sematext
MetricsEndpoint string `mapstructure:"metrics_endpoint"`
QueueSettings exporterhelper.QueueConfig `mapstructure:"sending_queue"`
// MetricsSchema indicates the metrics schema to emit to line protocol.
// Default: telegraf-prometheus-v2
MetricsSchema string `mapstructure:"metrics_schema"`
// PayloadMaxLines is the maximum number of line protocol lines to POST in a single request.
PayloadMaxLines int `mapstructure:"payload_max_lines"`
// PayloadMaxBytes is the maximum number of line protocol bytes to POST in a single request.
PayloadMaxBytes int `mapstructure:"payload_max_bytes"`
}

// Validate checks for invalid or missing entries in the configuration.
func (cfg *Config) Validate() error {
if strings.ToLower(cfg.Region) != euRegion && strings.ToLower(cfg.Region) != usRegion {
return fmt.Errorf("invalid region: %s. please use either 'EU' or 'US'", cfg.Region)
}
if !isValidUUID(cfg.MetricsConfig.AppToken) {
return fmt.Errorf("invalid metrics app_token: %s. app_token is not a valid UUID", cfg.MetricsConfig.AppToken)
}

if strings.ToLower(cfg.Region) == euRegion {
cfg.MetricsEndpoint = euMetricsEndpoint
}
if strings.ToLower(cfg.Region) == usRegion {
cfg.MetricsEndpoint = usMetricsEndpoint
}

return nil
}

func isValidUUID(uuid string) bool {
const uuidPattern = `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`
return regexp.MustCompile(uuidPattern).MatchString(strings.ToLower(uuid))
}
155 changes: 155 additions & 0 deletions exporter/sematextexporter/config_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

package sematextexporter

import (
"os"
"path/filepath"
"strings"
"testing"
"time"

"github.com/cenkalti/backoff/v4"
"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/configopaque"
"go.opentelemetry.io/collector/config/configretry"
"go.opentelemetry.io/collector/confmap/confmaptest"
"go.opentelemetry.io/collector/confmap/xconfmap"
"go.opentelemetry.io/collector/exporter/exporterhelper"

"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/sematextexporter/internal/metadata"
)

func TestLoadConfig(t *testing.T) {
t.Parallel()

content, err := os.ReadFile(filepath.Join("testdata", "config.yaml"))
require.NoError(t, err)

contentStr := strings.ReplaceAll(string(content), "<METRICS_APP_TOKEN>", metricsAppToken)

tmpConfigPath := filepath.Join("testdata", "config_tmp.yaml")
err = os.WriteFile(tmpConfigPath, []byte(contentStr), 0o600)
require.NoError(t, err)
defer os.Remove(tmpConfigPath)
cm, err := confmaptest.LoadConf(tmpConfigPath)
require.NoError(t, err)
tests := []struct {
id component.ID
expected component.Config
}{
{
id: component.NewIDWithName(metadata.Type, "default-config"),
expected: createDefaultConfig(),
},
{
id: component.NewIDWithName(metadata.Type, "override-config"),
expected: &Config{
ClientConfig: confighttp.ClientConfig{
Timeout: 500 * time.Millisecond,
Headers: map[string]configopaque.String{"User-Agent": "OpenTelemetry -> Sematext"},
},
MetricsConfig: MetricsConfig{
MetricsEndpoint: usMetricsEndpoint,
QueueSettings: exporterhelper.QueueConfig{
Enabled: true,
NumConsumers: 3,
QueueSize: 10,
},
AppToken: metricsAppToken,
MetricsSchema: "telegraf-prometheus-v2",
PayloadMaxLines: 72,
PayloadMaxBytes: 27,
},

BackOffConfig: configretry.BackOffConfig{
Enabled: true,
InitialInterval: 1 * time.Second,
MaxInterval: 3 * time.Second,
MaxElapsedTime: 10 * time.Second,
RandomizationFactor: backoff.DefaultRandomizationFactor,
Multiplier: backoff.DefaultMultiplier,
},
Region: usRegion,
},
},
}

for _, tt := range tests {
t.Run(tt.id.String(), func(t *testing.T) {
factory := NewFactory()
cfg := factory.CreateDefaultConfig()

sub, err := cm.Sub(tt.id.String())
require.NoError(t, err)
require.NoError(t, sub.Unmarshal(cfg))

assert.NoError(t, xconfmap.Validate(cfg))
assert.Equal(t, tt.expected, cfg)
})
}
}

func TestConfigValidation(t *testing.T) {
tests := []struct {
name string
config *Config
expectError bool
}{
{
name: "Valid configuration 1",
config: &Config{
Region: usRegion,
MetricsConfig: MetricsConfig{
AppToken: metricsAppToken,
},
},
expectError: false,
},
{
name: "Valid configuration 2",
config: &Config{
Region: euRegion,
MetricsConfig: MetricsConfig{
AppToken: metricsAppToken,
},
},
expectError: false,
},
{
name: "Invalid region",
config: &Config{
Region: "ASIA",
MetricsConfig: MetricsConfig{
AppToken: metricsAppToken,
},
},
expectError: true,
},
{
name: "Invalid metrics AppToken",
config: &Config{
Region: usRegion,
MetricsConfig: MetricsConfig{
AppToken: "short-token",
},
},
expectError: true,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := tt.config.Validate()
if tt.expectError {
assert.Error(t, err, "Expected an error for invalid configuration")
} else {
assert.NoError(t, err, "Expected no error for valid configuration")
}
})
}
}
27 changes: 26 additions & 1 deletion exporter/sematextexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,14 @@ package sematextexporter // import "github.com/open-telemetry/opentelemetry-coll

import (
"context"
"time"

"github.com/google/uuid"
"github.com/influxdata/influxdb-observability/common"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/config/confighttp"
"go.opentelemetry.io/collector/config/configopaque"
"go.opentelemetry.io/collector/config/configretry"
"go.opentelemetry.io/collector/exporter"
"go.opentelemetry.io/collector/exporter/exporterhelper"
"go.opentelemetry.io/collector/pdata/plog"
Expand All @@ -17,6 +23,8 @@ import (
"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/sematextexporter/internal/metadata"
)

var metricsAppToken = uuid.NewString()

// NewFactory creates a factory for the Sematext metrics exporter.
func NewFactory() exporter.Factory {
return exporter.NewFactory(
Expand All @@ -28,7 +36,24 @@ func NewFactory() exporter.Factory {
}

func createDefaultConfig() component.Config {
cfg := &Config{}
cfg := &Config{
ClientConfig: confighttp.ClientConfig{
Timeout: 5 * time.Second,
Headers: map[string]configopaque.String{
"User-Agent": "OpenTelemetry -> Sematext",
},
},
MetricsConfig: MetricsConfig{
MetricsEndpoint: usMetricsEndpoint,
MetricsSchema: common.MetricsSchemaTelegrafPrometheusV2.String(),
AppToken: metricsAppToken,
QueueSettings: exporterhelper.NewDefaultQueueConfig(),
PayloadMaxLines: 1_000,
PayloadMaxBytes: 300_000,
},
BackOffConfig: configretry.NewDefaultBackOffConfig(),
Region: usRegion,
}
return cfg
}

Expand Down
24 changes: 21 additions & 3 deletions exporter/sematextexporter/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,49 +3,67 @@ module github.com/open-telemetry/opentelemetry-collector-contrib/exporter/semate
go 1.23.0

require (
github.com/cenkalti/backoff/v4 v4.3.0
github.com/google/uuid v1.6.0
github.com/influxdata/influxdb-observability/common v0.5.12
github.com/stretchr/testify v1.10.0
go.opentelemetry.io/collector/component v0.119.1-0.20250210123122-44b3eeda354c
go.opentelemetry.io/collector/component/componenttest v0.119.1-0.20250210123122-44b3eeda354c
go.opentelemetry.io/collector/config/confighttp v0.119.1-0.20250210123122-44b3eeda354c
go.opentelemetry.io/collector/config/configopaque v1.25.1-0.20250210123122-44b3eeda354c
go.opentelemetry.io/collector/config/configretry v1.25.1-0.20250210123122-44b3eeda354c
go.opentelemetry.io/collector/confmap v1.25.1-0.20250210123122-44b3eeda354c
go.opentelemetry.io/collector/confmap/xconfmap v0.0.0-20250212224258-3c6ce2bb5b70
go.opentelemetry.io/collector/exporter v0.119.1-0.20250210123122-44b3eeda354c
go.opentelemetry.io/collector/exporter/exportertest v0.119.1-0.20250210123122-44b3eeda354c
go.opentelemetry.io/collector/pdata v1.25.1-0.20250210123122-44b3eeda354c
go.uber.org/goleak v1.3.0
)

require go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.59.0 // indirect

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/google/uuid v1.6.0 // indirect
github.com/golang/snappy v0.0.4 // 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/config/configretry v1.25.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/client v1.25.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/config/configauth v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/config/configcompression v1.25.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/config/configtls v1.25.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/consumer v1.25.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/consumer/consumererror v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/consumer/consumertest v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/consumer/xconsumer v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/exporter/xexporter v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/extension v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/extension/auth v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/extension/xextension v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/featuregate v1.25.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/pdata/pprofile v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/pipeline v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/receiver v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/receiver/receivertest v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/receiver/xreceiver v0.119.1-0.20250210123122-44b3eeda354c // indirect
go.opentelemetry.io/collector/semconv v0.119.1-0.20250210123122-44b3eeda354c // indirect; 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
Expand Down
Loading