This repository has been archived by the owner on May 25, 2022. It is now read-only.
Kv parser #307
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| ## `key_value_parser` operator | ||
|
|
||
| The `key_value_parser` operator parses the string-type field selected by `parse_from` into key value pairs. All values are of type string. | ||
|
|
||
| ### Configuration Fields | ||
|
|
||
| | Field | Default | Description | | ||
| | --- | --- | --- | | ||
| | `id` | `key_value_parser` | A unique identifier for the operator | | ||
| | `delimiter` | `=` | The delimiter used for splitting a value into a key value pair | | ||
| | `pair_delimiter` | | The delimiter used for seperating key value pairs, defaults to whitespace | | ||
| | `output` | Next in pipeline | The connected operator(s) that will receive all outbound entries | | ||
| | `parse_from` | $ | A [field](/docs/types/field.md) that indicates the field to be parsed into key value pairs | | ||
| | `parse_to` | $ | A [field](/docs/types/field.md) that indicates the field to be parsed as into key value pairs | | ||
|
There was a problem hiding this comment. The library technically still interprets |
||
| | `preserve_to` | | Preserves the unparsed value at the specified [field](/docs/types/field.md) | | ||
| | `on_error` | `send` | The behavior of the operator if it encounters an error. See [on_error](/docs/types/on_error.md) | | ||
| | `if` | | An [expression](/docs/types/expression.md) that, when set, will be evaluated to determine whether this operator should be used for the given entry. This allows you to do easy conditional parsing without branching logic with routers. | | ||
| | `timestamp` | `nil` | An optional [timestamp](/docs/types/timestamp.md) block which will parse a timestamp field before passing the entry to the output operator | | ||
| | `severity` | `nil` | An optional [severity](/docs/types/severity.md) block which will parse a severity field before passing the entry to the output operator | | ||
|
|
||
|
|
||
| ### Example Configurations | ||
|
|
||
| #### Parse the field `message` into key value pairs | ||
|
|
||
| Configuration: | ||
| ```yaml | ||
| - type: key_value_parser | ||
| parse_from: message | ||
| ``` | ||
|
|
||
| <table> | ||
| <tr><td> Input body </td> <td> Output body </td></tr> | ||
| <tr> | ||
| <td> | ||
|
|
||
| ```json | ||
| { | ||
| "timestamp": "", | ||
| "body": { | ||
| "message": "name=stanza" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </td> | ||
| <td> | ||
|
|
||
| ```json | ||
| { | ||
| "timestamp": "", | ||
| "body": { | ||
| "name": "stanza" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| #### Parse the field `message` into key value pairs, using a non default delimiter | ||
|
|
||
| Configuration: | ||
| ```yaml | ||
| - type: key_value_parser | ||
| parse_from: message | ||
| delimiter: ":" | ||
| ``` | ||
|
|
||
| <table> | ||
| <tr><td> Input body </td> <td> Output body </td></tr> | ||
| <tr> | ||
| <td> | ||
|
|
||
| ```json | ||
| { | ||
| "timestamp": "", | ||
| "body": { | ||
| "message": "name:stanza" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </td> | ||
| <td> | ||
|
|
||
| ```json | ||
| { | ||
| "timestamp": "", | ||
| "body": { | ||
| "name": "stanza" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| #### Parse the field `message` into key value pairs, using a non default pair delimiter | ||
|
|
||
| Configuration: | ||
| ```yaml | ||
| - type: key_value_parser | ||
| parse_from: message | ||
| pair_delimiter: "!" | ||
| ``` | ||
|
|
||
| <table> | ||
| <tr><td> Input body </td> <td> Output body </td></tr> | ||
| <tr> | ||
| <td> | ||
|
|
||
| ```json | ||
| { | ||
| "timestamp": "", | ||
| "body": { | ||
| "message": "name=stanza ! org=otel ! group=dev" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </td> | ||
| <td> | ||
|
|
||
| ```json | ||
| { | ||
| "timestamp": "", | ||
| "body": { | ||
| "name": "stanza", | ||
| "org": "otel", | ||
| "group": "dev" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| #### Parse the field `message` as key value pairs, and parse the timestamp | ||
|
|
||
| Configuration: | ||
| ```yaml | ||
| - type: key_value_parser | ||
| parse_from: message | ||
| timestamp: | ||
| parse_from: seconds_since_epoch | ||
| layout_type: epoch | ||
| layout: s | ||
| ``` | ||
|
|
||
| <table> | ||
| <tr><td> Input body </td> <td> Output body </td></tr> | ||
| <tr> | ||
| <td> | ||
|
|
||
| ```json | ||
| { | ||
| "timestamp": "", | ||
| "body": { | ||
| "message": "name=stanza seconds_since_epoch=1136214245" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </td> | ||
| <td> | ||
|
|
||
| ```json | ||
| { | ||
| "timestamp": "2006-01-02T15:04:05-07:00", | ||
| "body": { | ||
| "name": "stanza" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| </td> | ||
| </tr> | ||
| </table> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| package keyvalue | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/open-telemetry/opentelemetry-log-collection/entry" | ||
| "github.com/open-telemetry/opentelemetry-log-collection/operator/helper" | ||
| "github.com/open-telemetry/opentelemetry-log-collection/operator/helper/operatortest" | ||
| ) | ||
|
|
||
| func TestKVParserConfig(t *testing.T) { | ||
| cases := []operatortest.ConfigUnmarshalTest{ | ||
| { | ||
| Name: "default", | ||
| Expect: defaultCfg(), | ||
| }, | ||
| { | ||
| Name: "parse_from_simple", | ||
| Expect: func() *KVParserConfig { | ||
| cfg := defaultCfg() | ||
| cfg.ParseFrom = entry.NewBodyField("from") | ||
| return cfg | ||
| }(), | ||
| }, | ||
| { | ||
| Name: "parse_to_simple", | ||
| Expect: func() *KVParserConfig { | ||
| cfg := defaultCfg() | ||
| cfg.ParseTo = entry.NewBodyField("log") | ||
| return cfg | ||
| }(), | ||
| }, | ||
| { | ||
| Name: "on_error_drop", | ||
| Expect: func() *KVParserConfig { | ||
| cfg := defaultCfg() | ||
| cfg.OnError = "drop" | ||
| return cfg | ||
| }(), | ||
| }, | ||
| { | ||
| Name: "timestamp", | ||
| Expect: func() *KVParserConfig { | ||
| cfg := defaultCfg() | ||
| parseField := entry.NewBodyField("timestamp_field") | ||
| newTime := helper.TimeParser{ | ||
| LayoutType: "strptime", | ||
| Layout: "%Y-%m-%d", | ||
| ParseFrom: &parseField, | ||
| } | ||
| cfg.TimeParser = &newTime | ||
| return cfg | ||
| }(), | ||
| }, | ||
| { | ||
| Name: "severity", | ||
| Expect: func() *KVParserConfig { | ||
| cfg := defaultCfg() | ||
| parseField := entry.NewBodyField("severity_field") | ||
| severityField := helper.NewSeverityParserConfig() | ||
| severityField.ParseFrom = &parseField | ||
| mapping := map[interface{}]interface{}{ | ||
| "critical": "5xx", | ||
| "error": "4xx", | ||
| "info": "3xx", | ||
| "debug": "2xx", | ||
| } | ||
| severityField.Mapping = mapping | ||
| cfg.SeverityParserConfig = &severityField | ||
| return cfg | ||
| }(), | ||
| }, | ||
| { | ||
| Name: "preserve_to", | ||
| Expect: func() *KVParserConfig { | ||
| cfg := defaultCfg() | ||
| preserve := entry.NewBodyField("aField") | ||
| cfg.PreserveTo = &preserve | ||
| return cfg | ||
| }(), | ||
| }, | ||
| { | ||
| Name: "delimiter", | ||
| Expect: func() *KVParserConfig { | ||
| cfg := defaultCfg() | ||
| cfg.Delimiter = ";" | ||
| return cfg | ||
| }(), | ||
| }, | ||
| { | ||
| Name: "pair_delimiter", | ||
| Expect: func() *KVParserConfig { | ||
| cfg := defaultCfg() | ||
| cfg.PairDelimiter = ";" | ||
| return cfg | ||
| }(), | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range cases { | ||
| t.Run(tc.Name, func(t *testing.T) { | ||
| tc.Run(t, defaultCfg()) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func defaultCfg() *KVParserConfig { | ||
| return NewKVParserConfig("key_value_parser") | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: To be consistent with other docs, can you add punctuation to the descriptions.