[exporter/opensearchexporter] add logstashFormat config to opensearch

Author: sw90lee

.chloggen/opensearch_logstashformat.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: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: opensearchexporter
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Adding logstashFormat config to opensearch
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [38595]
+
+# (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: []

exporter/opensearchexporter/config.go

@@ -58,7 +58,7 @@ var (
 	errNamespaceNoValue   = errors.New("namespace must be specified")
 	errBulkActionInvalid  = errors.New("bulk_action can either be `create` or `index`")
 	errMappingModeInvalid = errors.New("mapping.mode is invalid")
-	errIndexFormatInvalid = errors.New("When LogstashFormat.Enabled is set to true, the index_log field is required.")
+	errIndexFormatInvalid = errors.New("when LogstashFormat.Enabled is set to true, the index_log field is required")
 )
 
 type MappingsSettings struct {

exporter/opensearchexporter/config_test.go

@@ -75,6 +75,11 @@ func TestLoadConfig(t *testing.T) {
 					Multiplier:          1.5,
 					RandomizationFactor: 0.5,
 				},
+                                LogstashFormat: LogstashFormatSettings{
+					Enabled: false,
+					PrefixSeparator: "-",
+					DateFormat: "%Y.%m.%d",
+				},
 				BulkAction: defaultBulkAction,
 				MappingsSettings: MappingsSettings{
 					Mode: "ss4o",

exporter/opensearchexporter/factory_test.go

@@ -5,11 +5,12 @@ package opensearchexporter
 
 import (
 	"context"
+	"testing"
+
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"go.opentelemetry.io/collector/component/componenttest"
 	"go.opentelemetry.io/collector/exporter/exportertest"
-	"testing"
 
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/opensearchexporter/internal/metadata"
 )

exporter/opensearchexporter/utils.go

@@ -5,8 +5,9 @@ package opensearchexporter
 import (
 	"bytes"
 	"fmt"
-	"github.com/lestrrat-go/strftime"
 	"time"
+
+	"github.com/lestrrat-go/strftime"
 )
 
 func GenerateIndexWithLogstashFormat(index string, conf *LogstashFormatSettings, t time.Time) string {

exporter/opensearchexporter/utils_test.go

@@ -21,18 +21,18 @@ func TestGetSuffixTime(t *testing.T) {
 	defaultCfg.LogsIndex = "logstash"
 	defaultCfg.LogstashFormat.PrefixSeparator = "."
 	otelLogsIndex := GenerateIndexWithLogstashFormat(defaultCfg.LogsIndex, &defaultCfg.LogstashFormat, testTime)
-	//assert.NoError(t, err)
+	// assert.NoError(t, err)
 	assert.Equal(t, "logstash.2023.12.02", otelLogsIndex)
 
 	defaultCfg.LogstashFormat.DateFormat = "%Y-%m-%d"
-	//newOtelLogsIndex, err := GenerateIndexWithLogstashFormat(defaultCfg.LogsIndex, &defaultCfg.LogstashFormat, testTime)
-	//assert.NoError(t, err)
+	// newOtelLogsIndex, err := GenerateIndexWithLogstashFormat(defaultCfg.LogsIndex, &defaultCfg.LogstashFormat, testTime)
+	// assert.NoError(t, err)
 	newOtelLogsIndex := GenerateIndexWithLogstashFormat(defaultCfg.LogsIndex, &defaultCfg.LogstashFormat, testTime)
 	assert.Equal(t, "logstash.2023-12-02", newOtelLogsIndex)
 
 	defaultCfg.LogstashFormat.DateFormat = "%d/%m/%Y"
-	//newOtelLogsIndexWithSpecDataFormat, err := GenerateIndexWithLogstashFormat(defaultCfg.LogsIndex, &defaultCfg.LogstashFormat, testTime)
-	//assert.NoError(t, err)
+	// newOtelLogsIndexWithSpecDataFormat, err := GenerateIndexWithLogstashFormat(defaultCfg.LogsIndex, &defaultCfg.LogstashFormat, testTime)
+	// assert.NoError(t, err)
 	newOtelLogsIndexWithSpecDataFormat := GenerateIndexWithLogstashFormat(defaultCfg.LogsIndex, &defaultCfg.LogstashFormat, testTime)
 	assert.Equal(t, "logstash.02/12/2023", newOtelLogsIndexWithSpecDataFormat)
 }