-
Notifications
You must be signed in to change notification settings - Fork 25.7k
Improve docs and tests for convert processor
#133160
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
Changes from 6 commits
e7c3bac
3de1ec3
753e77d
9076d9d
1d89527
eaa39b3
49996aa
51d63db
7ec8b13
a591de8
4f4ff85
899f34f
061cedf
a603cb4
466ba40
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -6,16 +6,38 @@ mapped_pages: | |||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Convert processor [convert-processor] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Converts a field in the currently ingested document to a different type, such as converting a string to an integer. If the field value is an array, all members will be converted. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The supported types include: `integer`, `long`, `float`, `double`, `string`, `boolean`, `ip`, and `auto`. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The supported types are: `integer`, `long`, `float`, `double`, `string`, `boolean`, `ip`, and `auto`. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | Target `type` | Supported input values | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `integer` | `Integer` values, `Long` values in 32-bit signed integer range, or `String` values representing an integer in 32-bit signed integer range in either decimal format (without a decimal point) or hex format (e.g. `"123"` or `"0x7b"`) | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| | `integer` | `Integer` values, `Long` values in 32-bit signed integer range, or `String` values representing an integer in 32-bit signed integer range in either decimal format (without a decimal point) or hex format (e.g. `"123"` or `"0x7b"`) | | |
| | `integer` | `Integer` values<br><br>`Long` values in 32-bit signed integer range<br><br>`String` values representing an integer in 32-bit signed integer range in either decimal format (without a decimal point) or hex format (e.g. `"123"` or `"0x7b"`) | |
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.
Ah, yeah, that works. I would have used bullet lists here but I don't think you can do that in a table. Good old-fashioned line breaks are the next best thing.
Outdated
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.
breaking this out into its own section outside of the table is perfect. I was actually going to suggest it but then didn't for some reason, so you read my mind
this could be helped with a couple of bullets. could refine even more more but this is a lightweight way to make it easier to scan.
| Specifying `auto` will attempt to convert a string-valued `field` into the closest non-string, non-IP type. For example, | |
| a field whose value is `"true"` will be converted to its respective boolean type: `true`. A string representing an | |
| integer in decimal or hex format (e.g. `"123"` or `"0x7b"`) will be converted to an `Integer` if the number fits in a | |
| 32-bit signed integer, else to a `Long` if it fits in a 64-bit signed integer, else to a `Float` (in which case it may | |
| lose precision, and will give positive or negative infinity if out of range for a 32-bit floating point value). A string | |
| representing a floating point number in decimal, scientific, or hex format (e.g. `"123.0"`, `"123.45"`, `"1.23e2"`, or | |
| `"0x1.ecp6"`) will be converted to a `Float` (and may lose precision, and will give positive or negative infinity if out | |
| of range for a 32-bit floating point value). If a provided field is either not a `String` or a `String` which cannot be | |
| converted, the processor will still process successfully and leave the field value as-is. In such a case, `target_field` | |
| will be updated with the unconverted field value. | |
| Specifying `auto` will attempt to convert a string-valued `field` into the closest non-string, non-IP type. | |
| For example: | |
| * A field whose value is `"true"` will be converted to its respective boolean type: `true` | |
| * A string representing an | |
| integer in decimal or hex format (e.g. `"123"` or `"0x7b"`) will be converted to an `Integer` if the number fits in a | |
| 32-bit signed integer, else to a `Long` if it fits in a 64-bit signed integer, else to a `Float` (in which case it may | |
| lose precision, and will give positive or negative infinity if out of range for a 32-bit floating point value). | |
| * A string | |
| representing a floating point number in decimal, scientific, or hex format (e.g. `"123.0"`, `"123.45"`, `"1.23e2"`, or | |
| `"0x1.ecp6"`) will be converted to a `Float` (and may lose precision, and will give positive or negative infinity if out | |
| of range for a 32-bit floating point value). | |
| If a provided field is either not a `String` or a `String` which cannot be | |
| converted, the processor will still process successfully and leave the field value as-is. In such a case, `target_field` | |
| will be updated with the unconverted field value. |
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.
Good idea. I've pushed a commit with a version of this. I've reworded slightly to avoid the 'For example' since it's actually an exhaustive list.
Uh oh!
There was an error while loading. Please reload this page.