feat: add honeycomb marker exporter structure

.chloggen/feat_marker-exporter.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: 'honeycombmarkerexporter'
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: "This component will export markers to be consumed by the Honeycomb Markers API to highlight user events"
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [26653]
+
+# (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: []

.github/CODEOWNERS

@@ -61,6 +61,7 @@ exporter/fileexporter/                                                  @open-te
 exporter/googlecloudexporter/                                           @open-telemetry/collector-contrib-approvers @aabmass @dashpole @jsuereth @punya @damemi @psx95
 exporter/googlecloudpubsubexporter/                                     @open-telemetry/collector-contrib-approvers @alexvanboxel
 exporter/googlemanagedprometheusexporter/                               @open-telemetry/collector-contrib-approvers @aabmass @dashpole @jsuereth @punya @damemi @psx95
+exporter/honeycombmarkerexporter/                                             @open-telemetry/collector-contrib-approvers @fchikwekwe @TylerHelmuth
 exporter/influxdbexporter/                                              @open-telemetry/collector-contrib-approvers @jacobmarble
 exporter/instanaexporter/                                               @open-telemetry/collector-contrib-approvers @jpkrohling @hickeyma
 exporter/kafkaexporter/                                                 @open-telemetry/collector-contrib-approvers @pavolloffay @MovieStoreGuy

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -54,6 +54,7 @@ body:
       - exporter/googlecloud
       - exporter/googlecloudpubsub
       - exporter/googlemanagedprometheus
+      - exporter/honeycombmarkerexporter
       - exporter/influxdb
       - exporter/instana
       - exporter/kafka

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -48,6 +48,7 @@ body:
       - exporter/googlecloud
       - exporter/googlecloudpubsub
       - exporter/googlemanagedprometheus
+      - exporter/honeycombmarkerexporter
       - exporter/influxdb
       - exporter/instana
       - exporter/kafka

.github/ISSUE_TEMPLATE/other.yaml

@@ -48,6 +48,7 @@ body:
       - exporter/googlecloud
       - exporter/googlecloudpubsub
       - exporter/googlemanagedprometheus
+      - exporter/honeycombmarkerexporter
       - exporter/influxdb
       - exporter/instana
       - exporter/kafka

exporter/honeycombmarkerexporter/Makefile

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

exporter/honeycombmarkerexporter/README.md

@@ -0,0 +1,46 @@
+@@ -0,0 +1,18 @@
+# Honeycomb Marker Exporter
+
+This exporter allows creating markers, via the Honeycomb Markers API, based on the look of incoming telemetry. 
+
+The following configuration options are supported:
+
+* `api_key` (Required): This is the API key (also called Write Key) for your Honeycomb account.
+* `api_url` (Required): You can set the hostname to send marker data to.
+* `markers` (Required): This specifies the exact configuration to create an event marker. 
+  * `markertype`: Specifies the marker type. Markers with the same type will appear in the same color in Honeycomb. MarkerType or MarkerColor should be set.  
+  * `markercolor`: Specifies the marker color. Will only be used if MarkerType is not set.
+  * `messagefield`: This is the attribute that will be used as the message. If necessary the value will be converted to a string.
+  * `urlfield`: This is the attribute that will be used as the url. If necessary the value will be converted to a string.
+  * `rules`: This is a list of OTTL rules that determine when to create an event marker. 
+    * `resourceconditions`: A list of ottlresource conditions that determine a match
+    * `logconditions`: A list of ottllog conditions that determine a match
+  Example:
+
+```yaml
+exporters:
+  honeycomb:
+    api_key: "my-api-key"
+    api_url: "https://api.testhost.io"
+    markers:
+      - markertype: "fooType",
+        messagefield: "test message",
+        urlfield: "https://api.testhost.io",
+        rules:
+          - resourceconditions:
+              - "ResourceCondition1"
+              - "ResourceCondition2"
+          - logconditions:
+              - "LogCondition1"
+              - "LogCondition2"
+      - markertype: "barType",
+        messagefield: "another test message",
+        urlfield: "https://api.testhost.io",
+        rules:
+          - resourceconditions:
+              - "ResourceCondition1"
+              - "ResourceCondition2"
+          - logconditions:
+              - "LogCondition1"
+              - "LogCondition2"
+```

exporter/honeycombmarkerexporter/config.go

@@ -0,0 +1,88 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package honeycombmarkerexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/honeycombmarkerexporter"
+
+import (
+	"fmt"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/filter/filterottl"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl"
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/config/configopaque"
+	"go.uber.org/zap"
+)
+
+// Config defines configuration for the Honeycomb Marker exporter.
+type Config struct {
+	// APIKey is the authentication token associated with the Honeycomb account.
+	APIKey configopaque.String `mapstructure:"api_key"`
+
+	// API URL to use (defaults to https://api.honeycomb.io)
+	APIURL string `mapstructure:"api_url"`
+
+	// Markers is the list of markers to create
+	Markers []marker `mapstructure:"markers"`
+}
+
+type marker struct {
+	// MarkerType defines the type of marker.  Markers with the same type appear in Honeycomb with the same color
+	MarkerType string `mapstructure:"type"`
+
+	// MarkerColor is the color of the marker. Will only be used if the MarkerType does not already exist.
+	MarkerColor string `mapstructure:"color"`
+
+	// MessageField is the attribute that will be used as the message.
+	// If necessary the value will be converted to a string.
+	MessageField string `mapstructure:"message_field"`
+
+	// URLField is the attribute that will be used as the url.
+	// If necessary the value will be converted to a string.
+	URLField string `mapstructure:"url_field"`
+
+	// Rules are the OTTL rules that determine when a piece of telemetry should be turned into a Marker
+	Rules Rules `mapstructure:"rules"`
+}
+
+type Rules struct {
+	// ResourceConditions is the list of ottlresource conditions that determine a match
+	ResourceConditions []string `mapstructure:"resource_conditions"`
+
+	// LogConditions is the list of ottllog conditions that determine a match
+	LogConditions []string `mapstructure:"log_conditions"`
+}
+
+var defaultCfg = CreateDefaultConfig().(*Config)
+
+func (cfg *Config) Validate() error {
+	if cfg == nil {
+		cfg = defaultCfg
+	}
+
+	if cfg.APIKey == "" {
+		return fmt.Errorf("invalid API Key")
+	}
+
+	if len(cfg.Markers) != 0 {
+		for _, m := range cfg.Markers {
+			if len(m.Rules.ResourceConditions) == 0 && len(m.Rules.LogConditions) == 0 {
+				return fmt.Errorf("no rules supplied for marker %v", m)
+			}
+
+			_, err := filterottl.NewBoolExprForResource(m.Rules.ResourceConditions, filterottl.StandardResourceFuncs(), ottl.PropagateError, component.TelemetrySettings{Logger: zap.NewNop()})
+			if err != nil {
+				return err
+			}
+
+			_, err = filterottl.NewBoolExprForLog(m.Rules.LogConditions, filterottl.StandardLogFuncs(), ottl.PropagateError, component.TelemetrySettings{Logger: zap.NewNop()})
+			if err != nil {
+				return err
+			}
+		}
+	} else {
+		return fmt.Errorf("no markers supplied")
+	}
+
+	return nil
+}
+
+var _ component.Config = (*Config)(nil)

exporter/honeycombmarkerexporter/config_test.go

@@ -0,0 +1,112 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package honeycombmarkerexporter
+
+import (
+	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/honeycombmarkerexporter/internal/metadata"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/confmap/confmaptest"
+)
+
+func TestLoadConfig(t *testing.T) {
+	t.Parallel()
+
+	cm, err := confmaptest.LoadConf(filepath.Join("testdata", "config.yaml"))
+	require.NoError(t, err)
+
+	tests := []struct {
+		id       component.ID
+		expected component.Config
+	}{
+		{
+			id: component.NewIDWithName("honeycomb", ""),
+			expected: &Config{
+				APIKey: "test-apikey",
+				APIURL: "https://api.testhost.io",
+				Markers: []marker{
+					{
+						MarkerType:   "fooType",
+						MessageField: "test message",
+						URLField:     "https://api.testhost.io",
+						Rules: Rules{
+							ResourceConditions: []string{
+								`IsMatch(attributes["test"], ".*")`,
+							},
+							LogConditions: []string{
+								`body == "test"`,
+							},
+						},
+					},
+				},
+			},
+		},
+		{
+			id: component.NewIDWithName("honeycomb", "color_no_type"),
+			expected: &Config{
+				APIKey: "test-apikey",
+				APIURL: "https://api.testhost.io",
+				Markers: []marker{
+					{
+						MarkerColor:  "green",
+						MessageField: "test message",
+						URLField:     "https://api.testhost.io",
+						Rules: Rules{
+							ResourceConditions: []string{
+								`IsMatch(attributes["test"], ".*")`,
+							},
+							LogConditions: []string{
+								`body == "test"`,
+							},
+						},
+					},
+				},
+			},
+		},
+		{
+			id: component.NewIDWithName(metadata.Type, "bad_syntax_log"),
+		},
+		{
+			id: component.NewIDWithName(metadata.Type, "no_conditions"),
+		},
+		{
+			id: component.NewIDWithName(metadata.Type, "no_api_key"),
+		},
+		{
+			id: component.NewIDWithName(metadata.Type, "no_markers_supplied"),
+		},
+	}
+
+	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, component.UnmarshalConfig(sub, cfg))
+
+			if tt.expected == nil {
+				err = component.ValidateConfig(cfg)
+				assert.Error(t, err)
+				return
+			}
+
+			assert.NoError(t, component.ValidateConfig(cfg))
+			assert.Equal(t, tt.expected, cfg)
+		})
+	}
+}
+
+func withDefaultConfig(fns ...func(*Config)) *Config {
+	cfg := CreateDefaultConfig().(*Config)
+	for _, fn := range fns {
+		fn(cfg)
+	}
+	return cfg
+}

exporter/honeycombmarkerexporter/doc.go

@@ -0,0 +1,7 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+//go:generate mdatagen metadata.yaml
+
+// Package honeycombmarkerexporter exports marker data to Honeycomb.
+package honeycombmarkerexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/honeycombmarkerexporter"

exporter/honeycombmarkerexporter/factory.go

@@ -0,0 +1,47 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package honeycombmarkerexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/honeycombmarkerexporter"
+
+import (
+	"context"
+
+	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/exporter"
+	"go.opentelemetry.io/collector/exporter/exporterhelper"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/honeycombmarkerexporter/internal/metadata"
+)
+
+func NewFactory() exporter.Factory {
+	return exporter.NewFactory(
+		metadata.Type,
+		CreateDefaultConfig,
+		exporter.WithLogs(createLogsExporter, metadata.LogsStability),
+	)
+}
+
+func CreateDefaultConfig() component.Config {
+	return &Config{
+		APIKey:  "",
+		APIURL:  "api.honeycomb.io:443",
+		Markers: []marker{},
+	}
+}
+
+func createLogsExporter(
+	ctx context.Context,
+	set exporter.CreateSettings,
+	cfg component.Config,
+) (exporter.Logs, error) {
+	cf := cfg.(*Config)
+
+	exporter := newLogsExporter(set.Logger, cf)
+
+	return exporterhelper.NewLogsExporter(
+		ctx,
+		set,
+		cfg,
+		exporter.exportLogs,
+	)
+}