Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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/fix-jsonarrayparser-build.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: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: pkg/stanza

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "When the `jsonArrayParserFeatureGate` is disabled, the func `Build` returns an error."

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

# (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: []
9 changes: 6 additions & 3 deletions pkg/stanza/operator/parser/jsonarray/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
package jsonarray // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/parser/jsonarray"

import (
"fmt"
"strings"

"github.com/valyala/fastjson"
Expand All @@ -26,9 +27,7 @@ var jsonArrayParserFeatureGate = featuregate.GlobalRegistry().MustRegister(
)

func init() {
if jsonArrayParserFeatureGate.IsEnabled() {
operator.Register(operatorType, func() operator.Builder { return NewConfig() })
}
operator.Register(operatorType, func() operator.Builder { return NewConfig() })
}

// NewConfig creates a new json array parser config with default values
Expand All @@ -51,6 +50,10 @@ type Config struct {

// Build will build a json array parser operator.
func (c Config) Build(logger *zap.SugaredLogger) (operator.Operator, error) {
if !jsonArrayParserFeatureGate.IsEnabled() {
return nil, fmt.Errorf("%s operator disabled", operatorType)
}

parserOperator, err := c.ParserConfig.Build(logger)
if err != nil {
return nil, err
Expand Down
33 changes: 33 additions & 0 deletions pkg/stanza/operator/parser/jsonarray/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@ import (
"path/filepath"
"testing"

"github.com/stretchr/testify/require"
"go.opentelemetry.io/collector/featuregate"

"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/operatortest"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/testutil"
)

func TestConfig(t *testing.T) {
Expand Down Expand Up @@ -65,3 +69,32 @@ func TestConfig(t *testing.T) {
},
}.Run(t)
}

func TestBuildWithFeatureGate(t *testing.T) {
cases := []struct {
name string
isFeatureGateEnable bool
onErr string
}{
{"jsonarray_enabled", true, ""},
{"jsonarray_disabled", false, "operator disabled"},
}

for _, c := range cases {
t.Run(c.name, func(t *testing.T) {
if c.isFeatureGateEnable {
err := featuregate.GlobalRegistry().Set("logs.jsonParserArray", true)
require.Nil(t, err)
}

buildFunc, ok := operator.Lookup(operatorType)
require.True(t, ok)

_, err := buildFunc().Build(testutil.Logger(t))
if err != nil {
require.Contains(t, err.Error(), c.onErr)
}
})
}

}
15 changes: 14 additions & 1 deletion pkg/stanza/operator/parser/jsonarray/parser_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,30 @@ import (
"time"

"github.com/stretchr/testify/require"
"go.opentelemetry.io/collector/featuregate"

"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/entry"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator"
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/testutil"
)

func newTestParser(t *testing.T) *Parser {
err := featuregate.GlobalRegistry().Set("logs.jsonParserArray", true)
require.Nil(t, err)

cfg := NewConfigWithID("test")
op, err := cfg.Build(testutil.Logger(t))
require.NoError(t, err)
return op.(*Parser)
}

func TestParserBuildFailure(t *testing.T) {
err := featuregate.GlobalRegistry().Set("logs.jsonParserArray", true)
require.Nil(t, err)

cfg := NewConfigWithID("test")
cfg.OnError = "invalid_on_error"
_, err := cfg.Build(testutil.Logger(t))
_, err = cfg.Build(testutil.Logger(t))
require.Error(t, err)
require.Contains(t, err.Error(), "invalid `on_error` field")
}
Expand All @@ -37,6 +44,9 @@ func TestParserInvalidType(t *testing.T) {
}

func TestParserByteFailureHeadersMismatch(t *testing.T) {
err := featuregate.GlobalRegistry().Set("logs.jsonParserArray", true)
require.Nil(t, err)

cfg := NewConfigWithID("test")
cfg.Header = "name,sev,msg"
op, err := cfg.Build(testutil.Logger(t))
Expand All @@ -48,6 +58,9 @@ func TestParserByteFailureHeadersMismatch(t *testing.T) {
}

func TestParserJarray(t *testing.T) {
err := featuregate.GlobalRegistry().Set("logs.jsonParserArray", true)
require.Nil(t, err)

cases := []struct {
name string
configure func(*Config)
Expand Down