Skip to content
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

Add a headerless jarray parser operator #30643

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
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
1 change: 1 addition & 0 deletions pkg/stanza/adapter/register.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
_ "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/output/file" // Register parsers and transformers for stanza-based log receivers
_ "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/output/stdout"
_ "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/parser/csv"
_ "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/parser/headerless_jarray"
_ "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/parser/json"
_ "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/parser/keyvalue"
_ "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/parser/regex"
Expand Down
71 changes: 71 additions & 0 deletions pkg/stanza/operator/parser/headerless_jarray/config_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package headerless_jarray

import (
"path/filepath"
"testing"

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

func TestConfig(t *testing.T) {
operatortest.ConfigUnmarshalTests{
DefaultConfig: NewConfig(),
TestsFile: filepath.Join(".", "testdata", "config.yaml"),
Tests: []operatortest.ConfigUnmarshalTest{
{
Name: "basic",
Expect: func() *Config {
p := NewConfig()
p.Header = "id,severity,message"
p.ParseFrom = entry.NewBodyField("message")
return p
}(),
},
{
Name: "header_delimiter",
Expect: func() *Config {
p := NewConfig()
p.Header = "id\tseverity\tmessage"
p.HeaderDelimiter = "\t"
return p
}(),
},
{
Name: "header_attribute",
Expect: func() *Config {
p := NewConfig()
p.HeaderAttribute = "header_field"
p.ParseFrom = entry.NewBodyField("message")
return p
}(),
},
{
Name: "parse_to_attributes",
Expect: func() *Config {
p := NewConfig()
p.ParseTo = entry.RootableField{Field: entry.NewAttributeField()}
return p
}(),
},
{
Name: "parse_to_body",
Expect: func() *Config {
p := NewConfig()
p.ParseTo = entry.RootableField{Field: entry.NewBodyField()}
return p
}(),
},
{
Name: "parse_to_resource",
Expect: func() *Config {
p := NewConfig()
p.ParseTo = entry.RootableField{Field: entry.NewResourceField()}
return p
}(),
},
},
}.Run(t)
}
181 changes: 181 additions & 0 deletions pkg/stanza/operator/parser/headerless_jarray/headerless_jarray.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
package headerless_jarray // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/parser/jarray"

import (
"context"
"errors"
"fmt"
"strings"

"go.uber.org/zap"

"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/helper"

"github.com/valyala/fastjson"
)

const operatorType = "headerless_jarray_parser"

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

// NewConfig creates a new jarray parser config with default values
func NewConfig() *Config {
return NewConfigWithID(operatorType)
}

// NewConfigWithID creates a new jarray parser config with default values
func NewConfigWithID(operatorID string) *Config {
return &Config{
ParserConfig: helper.NewParserConfig(operatorID, operatorType),
}
}

// Config is the configuration of a jarray parser operator.
type Config struct {
helper.ParserConfig `mapstructure:",squash"`

Header string `mapstructure:"header"`
HeaderDelimiter string `mapstructure:"header_delimiter"`
HeaderAttribute string `mapstructure:"header_attribute"`
}

// Build will build a jarray parser operator.
func (c Config) Build(logger *zap.SugaredLogger) (operator.Operator, error) {
parserOperator, err := c.ParserConfig.Build(logger)
if err != nil {
return nil, err
}

if c.HeaderDelimiter == "" {
c.HeaderDelimiter = ","
}

headerDelimiter := []rune(c.HeaderDelimiter)[0]

if len([]rune(c.HeaderDelimiter)) != 1 {
return nil, fmt.Errorf("invalid 'header_delimiter': '%s'", c.HeaderDelimiter)
}

var headers []string
switch {
case c.Header == "" && c.HeaderAttribute == "":
return nil, errors.New("missing required field 'header' or 'header_attribute'")
case c.Header != "" && c.HeaderAttribute != "":
return nil, errors.New("only one header parameter can be set: 'header' or 'header_attribute'")
case c.Header != "" && !strings.Contains(c.Header, c.HeaderDelimiter):
return nil, errors.New("missing field delimiter in header")
case c.Header != "":
headers = strings.Split(c.Header, c.HeaderDelimiter)
}

pp := &fastjson.ParserPool{}

return &Parser{
ParserOperator: parserOperator,
header: headers,
headerAttribute: c.HeaderAttribute,
headerDelimiter: headerDelimiter,
parse: generateJarrayParseFunc(headers, pp),
pp: pp,
}, nil
}

// Parser is an operator that parses jarray in an entry.
type Parser struct {
helper.ParserOperator
headerDelimiter rune
header []string
headerAttribute string
parse parseFunc
pp *fastjson.ParserPool
}

type parseFunc func(any) (any, error)

// Process will parse an entry for jarray.
func (r *Parser) Process(ctx context.Context, e *entry.Entry) error {
parse := r.parse

// If we have a headerAttribute set we need to dynamically generate our parser function
if r.headerAttribute != "" {
h, ok := e.Attributes[r.headerAttribute]
if !ok {
err := fmt.Errorf("failed to read dynamic header attribute %s", r.headerAttribute)
r.Error(err)
return err
}
headerString, ok := h.(string)
if !ok {
err := fmt.Errorf("header is expected to be a string but is %T", h)
r.Error(err)
return err
}
headers := strings.Split(headerString, string([]rune{r.headerDelimiter}))
parse = generateJarrayParseFunc(headers, r.pp)
}

return r.ParserOperator.ProcessWith(ctx, e, parse)
}

func generateJarrayParseFunc(headers []string, pp *fastjson.ParserPool) parseFunc {
return func(value any) (any, error) {
jArrayLine, err := valueAsString(value)
if err != nil {
return nil, err
}

p := pp.Get()
v, err := p.Parse(jArrayLine)
pp.Put(p)
if err != nil {
return nil, errors.New("failed to parse entry")
}

jArray := v.GetArray() // a is a []*Value slice
if len(jArray) != len(headers) {
return nil, fmt.Errorf("wrong number of fields: expected %d, found %d", len(headers), len(jArray))
}
parsedValues := make(map[string]any)
for i := range jArray {
switch jArray[i].Type() {
case fastjson.TypeNumber:
parsedValues[headers[i]] = jArray[i].GetInt64()
case fastjson.TypeString:
parsedValues[headers[i]] = string(jArray[i].GetStringBytes())
case fastjson.TypeTrue:
parsedValues[headers[i]] = true
case fastjson.TypeFalse:
parsedValues[headers[i]] = false
case fastjson.TypeNull:
parsedValues[headers[i]] = nil
case fastjson.TypeObject:
// Nested objects handled as a string since this parser doesn't support nested headers
parsedValues[headers[i]] = jArray[i].String()
default:
return nil, errors.New("failed to parse entry: " + string(jArray[i].MarshalTo(nil)))
}
}

return parsedValues, nil
}
}

// valueAsString interprets the given value as a string.
func valueAsString(value any) (string, error) {
var s string
switch t := value.(type) {
case string:
s += t
case []byte:
s += string(t)
default:
return s, fmt.Errorf("type '%T' cannot be parsed as jarray", value)
}

return s, nil
}
Loading