-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[libbeat]: add uppercase processor (#41535)
* [libbeat]: add uppercase processor * add PR number in changelog
- Loading branch information
1 parent
882c854
commit 92ed683
Showing
5 changed files
with
360 additions
and
27 deletions.
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
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,119 @@ | ||
| [[uppercase]] | ||
| === Uppercase fields in events | ||
|
|
||
| ++++ | ||
| <titleabbrev>uppercase</titleabbrev> | ||
| ++++ | ||
|
|
||
| The `uppercase` processor specifies a list of `fields` and `values` to be converted to uppercase. Keys listed in `fields` will be matched case-insensitively and converted to uppercase. For `values`, only exact, case-sensitive matches are transformed to uppercase. This way, keys and values can be selectively converted based on the specified criteria. | ||
|
|
||
|
|
||
| ==== Examples: | ||
|
|
||
| 1. Default scenario | ||
|
|
||
| [source,yaml] | ||
| ---- | ||
| processors: | ||
| - rename: | ||
| fields: | ||
| - "ab.cd" | ||
| values: | ||
| - "testKey" | ||
| ignore_missing: false | ||
| fail_on_error: true | ||
| alter_full_field: true | ||
| ---- | ||
| [source,json] | ||
| ---- | ||
| // Input | ||
| { | ||
| "ab": {"cd":"data"}, | ||
| "CD": {"ef":"data"}, | ||
| "testKey": {"testvalue"} | ||
| } | ||
| // output | ||
| { | ||
| "ab": {"cd":"data"}, // `ab.cd` -> `AB.CD` | ||
| "CD": {"ef":"data"}, | ||
| "testKey": {"TESTVALUE"} // `testvalue` -> `TESTVALUE` is uppercased | ||
| } | ||
| ---- | ||
|
|
||
| [start=2] | ||
| 2. When `alter_full_field` is false (applicable only for fields) | ||
|
|
||
| [source,yaml] | ||
| ---- | ||
| processors: | ||
| - rename: | ||
| fields: | ||
| - "ab.cd" | ||
| ignore_missing: false | ||
| fail_on_error: true | ||
| alter_full_field: false | ||
| ---- | ||
|
|
||
| [source,json] | ||
| ---- | ||
| // Input | ||
| { | ||
| "ab": {"cd":"data"}, | ||
| "CD": {"ef":"data"}, | ||
| } | ||
| // output | ||
| { | ||
| "ab": {"CD":"data"}, // `ab.cd` -> `ab.CD` (only `cd` is uppercased) | ||
| "CD": {"ef":"data"}, | ||
| } | ||
| ---- | ||
|
|
||
| [start=2] | ||
| 2. In case of non unique path to the key | ||
|
|
||
| [source,yaml] | ||
| ---- | ||
| processors: | ||
| - rename: | ||
| fields: | ||
| - "ab" | ||
| ignore_missing: false | ||
| fail_on_error: true | ||
| alter_full_field: true | ||
| ---- | ||
|
|
||
| [source,json] | ||
| ---- | ||
| // Input | ||
| { | ||
| "ab": "first", | ||
| "aB": "second" | ||
| } | ||
| // Output | ||
| { | ||
| "ab": "first", | ||
| "aB": "second", | ||
| "err": "... Error: key collision" | ||
| } | ||
| ---- | ||
|
|
||
| ==== Configuration: | ||
|
|
||
| The `uppercase` processor has the following configuration settings: | ||
|
|
||
| `fields`:: The field names to uppercase. The match is case-insensitive, e.g. `a.b.c.d` would match `A.b.C.d` or `A.B.C.D`. | ||
| `values`:: (Optional) Specifies the exact values to be converted to uppercase. Each entry should include the full path to the value. Key matching is case-sensitive. If the target value is not a string, an error is triggered (`fail_on_error: true`) or the value is skipped (`fail_on_error: false`). | ||
| `ignore_missing`:: (Optional) Indicates whether to ignore events that lack the source field. | ||
| The default is `false`, which will fail processing of an event if a field is missing. | ||
| `fail_on_error`:: (Optional) If set to `true` and an error occurs, the changes are reverted and the original event is returned. | ||
| If set to `false`, processing continues if an error occurs. Default is `true`. | ||
| `alter_full_field`:: (Optional) If set to `true`, the entire key path is uppercased. If set to `false` only the final part of the key path is uppercased. Default is true | ||
|
|
||
|
|
||
|
|
||
| See <<conditions>> for a list of supported conditions. |
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,47 @@ | ||
| // Licensed to Elasticsearch B.V. under one or more contributor | ||
| // license agreements. See the NOTICE file distributed with | ||
| // this work for additional information regarding copyright | ||
| // ownership. Elasticsearch B.V. licenses this file to you 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 actions | ||
|
|
||
| import ( | ||
| "strings" | ||
|
|
||
| "github.com/elastic/beats/v7/libbeat/beat" | ||
| "github.com/elastic/beats/v7/libbeat/processors" | ||
| "github.com/elastic/beats/v7/libbeat/processors/checks" | ||
| conf "github.com/elastic/elastic-agent-libs/config" | ||
| ) | ||
|
|
||
| func init() { | ||
| processors.RegisterPlugin( | ||
| "uppercase", | ||
| checks.ConfigChecked( | ||
| NewUpperCaseProcessor, | ||
| checks.RequireFields("fields"), | ||
| checks.AllowedFields("fields", "ignore_missing", "fail_on_error", "alter_full_field", "values"), | ||
| ), | ||
| ) | ||
| } | ||
|
|
||
| // NewUpperCaseProcessor converts event keys matching the provided fields to uppercase | ||
| func NewUpperCaseProcessor(c *conf.C) (beat.Processor, error) { | ||
| return NewAlterFieldProcessor(c, "uppercase", upperCase) | ||
| } | ||
|
|
||
| func upperCase(field string) (string, error) { | ||
| return strings.ToUpper(field), nil | ||
| } |
Oops, something went wrong.