From 1da9005b00c04686ae768d173504b907cc6cb409 Mon Sep 17 00:00:00 2001 From: May Lee Date: Tue, 17 Oct 2023 08:05:18 -0400 Subject: [PATCH] chore(external docs): First batch of editorial edits for the Functions doc (#18780) * make edits * more edits * apply suggestions * Apply suggestions from code review Co-authored-by: cecilia saixue watt * cue fmt Signed-off-by: Jesse Szwedko --------- Signed-off-by: Jesse Szwedko Co-authored-by: cecilia saixue watt Co-authored-by: Jesse Szwedko --- website/cue/reference/remap/functions.cue | 14 +++++++------- website/cue/reference/remap/functions/append.cue | 4 ++-- website/cue/reference/remap/functions/assert.cue | 4 ++-- .../cue/reference/remap/functions/assert_eq.cue | 4 ++-- website/cue/reference/remap/functions/chunks.cue | 6 +++--- .../cue/reference/remap/functions/compact.cue | 2 +- .../cue/reference/remap/functions/decrypt.cue | 12 ++++++------ .../remap/functions/encode_key_value.cue | 10 +++++----- .../reference/remap/functions/encode_logfmt.cue | 4 ++-- .../reference/remap/functions/encode_percent.cue | 2 +- .../cue/reference/remap/functions/encrypt.cue | 10 +++++----- website/cue/reference/remap/functions/filter.cue | 14 ++++++-------- .../cue/reference/remap/functions/for_each.cue | 12 ++++-------- .../cue/reference/remap/functions/format_int.cue | 2 +- .../remap/functions/from_unix_timestamp.cue | 3 +-- .../functions/get_enrichment_table_record.cue | 8 ++++---- .../cue/reference/remap/functions/get_secret.cue | 2 +- website/cue/reference/remap/functions/hmac.cue | 4 ++-- .../cue/reference/remap/functions/ip_aton.cue | 2 +- .../remap/functions/ip_cidr_contains.cue | 4 ++-- .../cue/reference/remap/functions/ip_ntoa.cue | 4 ++-- .../cue/reference/remap/functions/ip_ntop.cue | 2 +- .../cue/reference/remap/functions/ip_pton.cue | 2 +- .../cue/reference/remap/functions/ip_subnet.cue | 4 ++-- .../cue/reference/remap/functions/ip_to_ipv6.cue | 2 +- .../reference/remap/functions/ipv6_to_ipv4.cue | 4 ++-- website/cue/reference/remap/functions/keys.cue | 2 +- website/cue/reference/remap/functions/length.cue | 2 +- .../cue/reference/remap/functions/map_keys.cue | 14 +++++++------- .../cue/reference/remap/functions/map_values.cue | 2 +- .../reference/remap/functions/match_array.cue | 2 +- website/cue/reference/remap/functions/mod.cue | 6 +++--- .../remap/functions/parse_apache_log.cue | 16 ++++++++-------- .../remap/functions/parse_aws_alb_log.cue | 2 +- ...e_aws_cloudwatch_log_subscription_message.cue | 2 +- .../remap/functions/parse_aws_vpc_flow_log.cue | 8 ++++---- .../cue/reference/remap/functions/parse_cef.cue | 4 ++-- .../remap/functions/parse_common_log.cue | 10 +++++----- .../cue/reference/remap/functions/parse_csv.cue | 4 ++-- .../reference/remap/functions/parse_duration.cue | 2 +- .../cue/reference/remap/functions/parse_glog.cue | 4 ++-- .../cue/reference/remap/functions/parse_grok.cue | 4 ++-- .../reference/remap/functions/parse_groks.cue | 2 +- .../cue/reference/remap/functions/parse_int.cue | 8 ++++---- .../cue/reference/remap/functions/parse_json.cue | 4 ++-- .../remap/functions/parse_key_value.cue | 8 ++++---- .../cue/reference/remap/functions/parse_klog.cue | 4 ++-- .../functions/parse_linux_authorization.cue | 2 +- .../reference/remap/functions/parse_logfmt.cue | 2 +- .../remap/functions/parse_nginx_log.cue | 8 ++++---- .../reference/remap/functions/parse_regex.cue | 8 ++++---- .../remap/functions/parse_regex_all.cue | 6 +++--- .../remap/functions/parse_ruby_hash.cue | 2 +- .../reference/remap/functions/parse_syslog.cue | 2 +- .../remap/functions/parse_timestamp.cue | 2 +- .../reference/remap/functions/parse_tokens.cue | 4 ++-- .../cue/reference/remap/functions/parse_url.cue | 4 ++-- .../remap/functions/parse_user_agent.cue | 2 +- .../cue/reference/remap/functions/parse_xml.cue | 2 +- .../reference/remap/functions/remove_secret.cue | 2 +- .../cue/reference/remap/functions/seahash.cue | 2 +- .../cue/reference/remap/functions/set_secret.cue | 2 +- .../remap/functions/set_semantic_meaning.cue | 8 ++++---- website/cue/reference/remap/functions/strlen.cue | 8 ++++---- .../cue/reference/remap/functions/to_bool.cue | 2 +- .../cue/reference/remap/functions/to_float.cue | 2 +- website/cue/reference/remap/functions/to_int.cue | 4 ++-- .../cue/reference/remap/functions/to_string.cue | 2 +- .../remap/functions/to_syslog_facility.cue | 4 ++-- .../remap/functions/to_syslog_severity.cue | 2 +- .../remap/functions/to_unix_timestamp.cue | 5 ++--- website/cue/reference/remap/functions/unique.cue | 2 +- website/cue/reference/remap/functions/unnest.cue | 6 +++--- website/cue/reference/remap/functions/values.cue | 2 +- website/cue/reference/urls.cue | 2 +- 75 files changed, 171 insertions(+), 179 deletions(-) diff --git a/website/cue/reference/remap/functions.cue b/website/cue/reference/remap/functions.cue index fd98778968b0d..b802b4ef8dd56 100644 --- a/website/cue/reference/remap/functions.cue +++ b/website/cue/reference/remap/functions.cue @@ -59,10 +59,10 @@ remap: { // Reusable text _enrichment_table_explainer: """ - For `file` enrichment tables this condition needs to be a VRL object in which + For `file` enrichment tables, this condition needs to be a VRL object in which the key-value pairs indicate a field to search mapped to a value to search in that field. This function returns the rows that match the provided condition(s). _All_ fields need to - match for rows to be returned; if any fields don't match, no rows are returned. + match for rows to be returned; if any fields do not match, then no rows are returned. There are currently two forms of search criteria: @@ -72,15 +72,15 @@ remap: { performance perspective. 2. **Date range search**. The given field must be greater than or equal to the `from` date - and less than or equal to the `to` date. Note that a date range search involves - sequentially scanning through the rows that have been located via any exact match + and less than or equal to the `to` date. A date range search involves + sequentially scanning through the rows that have been located using any exact match criteria. This can be an expensive operation if there are many rows returned by any exact - match criteria. We recommend using date ranges as the _only_ criteria when the enrichment + match criteria. Therefore, use date ranges as the _only_ criteria when the enrichment data set is very small. - For `geoip` enrichment tables this condition needs to be a VRL object with a single key-value pair + For `geoip` enrichment tables, this condition needs to be a VRL object with a single key-value pair whose value needs to be a valid IP address. Example: `{"ip": .ip }`. If a return field is expected - and without a value, `null` will be used. This table can return following fields: + and without a value, `null` is used. This table can return the following fields: * ISP databases: * `autonomous_system_number` diff --git a/website/cue/reference/remap/functions/append.cue b/website/cue/reference/remap/functions/append.cue index 3bf32bf990a8a..289c62296cd40 100644 --- a/website/cue/reference/remap/functions/append.cue +++ b/website/cue/reference/remap/functions/append.cue @@ -9,13 +9,13 @@ remap: functions: append: { arguments: [ { name: "value" - description: "The initial array" + description: "The initial array." required: true type: ["array"] }, { name: "items" - description: "The items to append" + description: "The items to append." required: true type: ["array"] }, diff --git a/website/cue/reference/remap/functions/assert.cue b/website/cue/reference/remap/functions/assert.cue index ba6c505784d3c..01ede6c86de89 100644 --- a/website/cue/reference/remap/functions/assert.cue +++ b/website/cue/reference/remap/functions/assert.cue @@ -26,14 +26,14 @@ remap: functions: assert: { description: """ An optional custom error message. If the equality assertion fails, `message` is appended to the default message prefix. See the [examples](#assert-examples) below - for a sample fully formed log message. + for a fully formed log message sample. """ required: false type: ["string"] }, ] internal_failure_reasons: [ - "`condition` evaluates to `false`", + "`condition` evaluates to `false`.", ] return: types: ["null"] diff --git a/website/cue/reference/remap/functions/assert_eq.cue b/website/cue/reference/remap/functions/assert_eq.cue index 544d8256e15da..05ceb07f74a50 100644 --- a/website/cue/reference/remap/functions/assert_eq.cue +++ b/website/cue/reference/remap/functions/assert_eq.cue @@ -5,7 +5,7 @@ remap: functions: assert_eq: { description: """ Asserts that two expressions, `left` and `right`, have the same value. The program is - aborted with the `message` if they are unequal. + aborted with `message` if they do not have the same value. """ notices: [ @@ -34,7 +34,7 @@ remap: functions: assert_eq: { description: """ An optional custom error message. If the equality assertion fails, `message` is appended to the default message prefix. See the [examples](#assert_eq-examples) - below for a sample fully formed log message. + below for a fully formed log message sample. """ required: false type: ["string"] diff --git a/website/cue/reference/remap/functions/chunks.cue b/website/cue/reference/remap/functions/chunks.cue index c3c200053fb16..3ad4cf375badf 100644 --- a/website/cue/reference/remap/functions/chunks.cue +++ b/website/cue/reference/remap/functions/chunks.cue @@ -3,7 +3,7 @@ package metadata remap: functions: chunks: { category: "Array" description: """ - Chunks `value` into slices of length `chunk_size` bytes + Chunks `value` into slices of length `chunk_size` bytes. """ arguments: [ @@ -21,8 +21,8 @@ remap: functions: chunks: { }, ] internal_failure_reasons: [ - "`chunk_size` must be at least 1 byte", - "`chunk_size` is too large", + "`chunk_size` must be at least 1 byte.", + "`chunk_size` is too large.", ] return: { types: ["array"] diff --git a/website/cue/reference/remap/functions/compact.cue b/website/cue/reference/remap/functions/compact.cue index 845a35e82f236..d64f0104064bd 100644 --- a/website/cue/reference/remap/functions/compact.cue +++ b/website/cue/reference/remap/functions/compact.cue @@ -3,7 +3,7 @@ package metadata remap: functions: compact: { category: "Enumerate" description: """ - Compacts the `value` by removing "empty" values, where emptiness is defined using the + Compacts the `value` by removing empty values, where empty values are defined using the available parameters. """ diff --git a/website/cue/reference/remap/functions/decrypt.cue b/website/cue/reference/remap/functions/decrypt.cue index 9b7c61b92c519..eaaf967f9490a 100644 --- a/website/cue/reference/remap/functions/decrypt.cue +++ b/website/cue/reference/remap/functions/decrypt.cue @@ -33,7 +33,7 @@ remap: functions: decrypt: { arguments: [ { name: "ciphertext" - description: "The string to decrypt. The should be raw bytes (not encoded)." + description: "The string in raw bytes (not encoded) to decrypt." required: true type: ["string"] }, @@ -45,14 +45,14 @@ remap: functions: decrypt: { }, { name: "key" - description: "The key for decryption. The should be raw bytes of the key (not encoded). The length must match the algorithm requested." + description: "The key in raw bytes (not encoded) for decryption. The length must match the algorithm requested." required: true type: ["string"] }, { name: "iv" description: #""" - The IV for decryption. The should be raw bytes of the IV (not encoded). The length must match the algorithm requested. + The IV in raw bytes (not encoded) for decryption. The length must match the algorithm requested. A new IV should be generated for every message. You can use `random_bytes` to generate a cryptographically secure random value. The value should match the one used during encryption. """# @@ -61,9 +61,9 @@ remap: functions: decrypt: { }, ] internal_failure_reasons: [ - "`algorithm` isn't a supported algorithm", - "`key` length doesn't match the key size required for the algorithm specified", - "`iv` length doesn't match the iv size required for the algorithm specified", + "`algorithm` is not a supported algorithm.", + "`key` length does not match the key size required for the algorithm specified.", + "`iv` length does not match the `iv` size required for the algorithm specified.", ] return: types: ["string"] diff --git a/website/cue/reference/remap/functions/encode_key_value.cue b/website/cue/reference/remap/functions/encode_key_value.cue index 8a78da8f23806..2af964dab8f6b 100644 --- a/website/cue/reference/remap/functions/encode_key_value.cue +++ b/website/cue/reference/remap/functions/encode_key_value.cue @@ -3,7 +3,7 @@ package metadata remap: functions: encode_key_value: { category: "Codec" description: """ - Encodes the `value` to in key/value format with customizable delimiters. Default delimiters match + Encodes the `value` into key-value format with customizable delimiters. Default delimiters match the [logfmt](\(urls.logfmt)) format. """ notices: [ @@ -21,7 +21,7 @@ remap: functions: encode_key_value: { }, { name: "fields_ordering" - description: "The ordering of fields to preserve. Any fields not in this list will appear unordered, after any ordered fields." + description: "The ordering of fields to preserve. Any fields not in this list are listed unordered, after all ordered fields." required: false type: ["array"] }, @@ -34,21 +34,21 @@ remap: functions: encode_key_value: { }, { name: "field_delimiter" - description: "The string that separates each key/value pair." + description: "The string that separates each key-value pair." required: false default: " " type: ["string"] }, { name: "flatten_boolean" - description: "Whether to encode key/value with a boolean value as a standalone key if `true` and nothing if `false`." + description: "Whether to encode key-value with a boolean value as a standalone key if `true` and nothing if `false`." required: false type: ["boolean"] default: false }, ] internal_failure_reasons: [ - "`fields_ordering` contains a non-string element", + "`fields_ordering` contains a non-string element.", ] return: types: ["string"] diff --git a/website/cue/reference/remap/functions/encode_logfmt.cue b/website/cue/reference/remap/functions/encode_logfmt.cue index 6c37a97a55ab1..9fa01e746a7b4 100644 --- a/website/cue/reference/remap/functions/encode_logfmt.cue +++ b/website/cue/reference/remap/functions/encode_logfmt.cue @@ -16,13 +16,13 @@ remap: functions: encode_logfmt: { }, { name: "fields_ordering" - description: "The ordering of fields to preserve. Any fields not in this list will appear unordered, after any ordered fields." + description: "The ordering of fields to preserve. Any fields not in this list are listed unordered, after all ordered fields." required: false type: ["array"] }, ] internal_failure_reasons: [ - "`fields_ordering` contains a non-string element", + "`fields_ordering` contains a non-string element.", ] return: types: ["string"] diff --git a/website/cue/reference/remap/functions/encode_percent.cue b/website/cue/reference/remap/functions/encode_percent.cue index 2f3c9e04a1647..c6f9a3d61b0c7 100644 --- a/website/cue/reference/remap/functions/encode_percent.cue +++ b/website/cue/reference/remap/functions/encode_percent.cue @@ -15,7 +15,7 @@ remap: functions: encode_percent: { }, { name: "ascii_set" - description: "The ascii set to use when encoding the data." + description: "The ASCII set to use when encoding the data." required: false type: ["string"] default: "NON_ALPHANUMERIC" diff --git a/website/cue/reference/remap/functions/encrypt.cue b/website/cue/reference/remap/functions/encrypt.cue index 4d91f4efeb372..84b6deb5e7c11 100644 --- a/website/cue/reference/remap/functions/encrypt.cue +++ b/website/cue/reference/remap/functions/encrypt.cue @@ -54,14 +54,14 @@ remap: functions: encrypt: { }, { name: "key" - description: "The key for encryption. The should be raw bytes of the key (not encoded). The length must match the algorithm requested." + description: "The key in raw bytes (not encoded) for encryption. The length must match the algorithm requested." required: true type: ["string"] }, { name: "iv" description: #""" - The IV for encryption. The should be raw bytes of the IV (not encoded). The length must match the algorithm requested. + The IV in raw bytes (not encoded) for encryption. The length must match the algorithm requested. A new IV should be generated for every message. You can use `random_bytes` to generate a cryptographically secure random value. """# required: true @@ -69,9 +69,9 @@ remap: functions: encrypt: { }, ] internal_failure_reasons: [ - "`algorithm` isn't a supported algorithm", - "`key` length doesn't match the key size required for the algorithm specified", - "`iv` length doesn't match the iv size required for the algorithm specified", + "`algorithm` is not a supported algorithm.", + "`key` length does not match the key size required for the algorithm specified.", + "`iv` length does not match the `iv` size required for the algorithm specified.", ] return: types: ["string"] diff --git a/website/cue/reference/remap/functions/filter.cue b/website/cue/reference/remap/functions/filter.cue index 8c472bcd1cacc..690d4b845234a 100644 --- a/website/cue/reference/remap/functions/filter.cue +++ b/website/cue/reference/remap/functions/filter.cue @@ -1,25 +1,23 @@ package metadata remap: functions: filter: { - category: "Enumerate" + category: "Enumerate" description: """ Filter elements from a collection. This function currently *does not* support recursive iteration. - If you have a need for recursive iteration using `filter`, then - [please let us know](\(urls.new_feature_request))! - The function uses the "function closure syntax" to allow reading - the key/value or index/value combination for each item in the + The function uses the function closure syntax to allow reading + the key-value or index-value combination for each item in the collection. The same scoping rules apply to closure blocks as they do for - regular blocks, meaning, any variable defined in parent scopes - are accessible, and mutations to those variables are preserved, + regular blocks. This means that any variable defined in parent scopes + is accessible, and mutations to those variables are preserved, but any new variables instantiated in the closure block are unavailable outside of the block. - Check out the examples below to learn about the closure syntax. + See the examples below to learn about the closure syntax. """ arguments: [ diff --git a/website/cue/reference/remap/functions/for_each.cue b/website/cue/reference/remap/functions/for_each.cue index a4b1fdfa9e98a..2d7697e1c5462 100644 --- a/website/cue/reference/remap/functions/for_each.cue +++ b/website/cue/reference/remap/functions/for_each.cue @@ -1,27 +1,23 @@ package metadata remap: functions: for_each: { - category: "Enumerate" + category: "Enumerate" description: """ Iterate over a collection. This function currently *does not* support recursive iteration. - If you have a need for recursive iteration using `for_each`, - which can't be solved using the `map_keys` or `map_values` - enumeration functions (which *do* support recursion), then - [please let us know](\(urls.new_feature_request))! The function uses the "function closure syntax" to allow reading the key/value or index/value combination for each item in the collection. The same scoping rules apply to closure blocks as they do for - regular blocks, meaning, any variable defined in parent scopes - are accessible, and mutations to those variables are preserved, + regular blocks. This means that any variable defined in parent scopes + is accessible, and mutations to those variables are preserved, but any new variables instantiated in the closure block are unavailable outside of the block. - Check out the examples below to learn about the closure syntax. + See the examples below to learn about the closure syntax. """ arguments: [ diff --git a/website/cue/reference/remap/functions/format_int.cue b/website/cue/reference/remap/functions/format_int.cue index fefde3ba74e75..dfa689ba42d5f 100644 --- a/website/cue/reference/remap/functions/format_int.cue +++ b/website/cue/reference/remap/functions/format_int.cue @@ -22,7 +22,7 @@ remap: functions: format_int: { }, ] internal_failure_reasons: [ - "base is not between 2 and 36", + "The base is not between 2 and 36.", ] return: types: ["string"] diff --git a/website/cue/reference/remap/functions/from_unix_timestamp.cue b/website/cue/reference/remap/functions/from_unix_timestamp.cue index 45323b1811948..8ad585e73b208 100644 --- a/website/cue/reference/remap/functions/from_unix_timestamp.cue +++ b/website/cue/reference/remap/functions/from_unix_timestamp.cue @@ -5,8 +5,7 @@ remap: functions: from_unix_timestamp: { description: """ Converts the `value` integer from a [Unix timestamp](\(urls.unix_timestamp)) to a VRL `timestamp`. - Converts from the number of seconds since the Unix epoch by default, but milliseconds or nanoseconds can also be - specified by `unit`. + Converts from the number of seconds since the Unix epoch by default. To convert from milliseconds or nanoseconds, set the `unit` argument to `milliseconds` or `nanoseconds`. """ arguments: [ diff --git a/website/cue/reference/remap/functions/get_enrichment_table_record.cue b/website/cue/reference/remap/functions/get_enrichment_table_record.cue index 5635a40d670bb..58ff104e6754f 100644 --- a/website/cue/reference/remap/functions/get_enrichment_table_record.cue +++ b/website/cue/reference/remap/functions/get_enrichment_table_record.cue @@ -4,7 +4,7 @@ remap: functions: get_enrichment_table_record: { category: "Enrichment" description: """ Searches an [enrichment table](\(urls.enrichment_tables_concept)) for a row that matches the - provided condition. A single row must be matched. If either no rows or more than one row is + provided condition. A single row must be matched. If no rows are found or more than one row is found, an error is returned. \(remap._enrichment_table_explainer) @@ -37,15 +37,15 @@ remap: functions: get_enrichment_table_record: { }, { name: "case_sensitive" - description: "Should text fields match case exactly." + description: "Whether the text fields match the case exactly." required: false type: ["boolean"] default: true }, ] internal_failure_reasons: [ - "The row isn't found", - "Multiple rows are found that match the condition", + "The row is not found.", + "Multiple rows are found that match the condition.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/get_secret.cue b/website/cue/reference/remap/functions/get_secret.cue index 27bd241a13e07..e924b419c4272 100644 --- a/website/cue/reference/remap/functions/get_secret.cue +++ b/website/cue/reference/remap/functions/get_secret.cue @@ -22,7 +22,7 @@ remap: functions: get_secret: { examples: [ { - title: "Get the Datadog API key from the event metadata." + title: "Get the Datadog API key from the event metadata" source: #""" get_secret("datadog_api_key") """# diff --git a/website/cue/reference/remap/functions/hmac.cue b/website/cue/reference/remap/functions/hmac.cue index cea2776745f3b..5d6972352f7c6 100644 --- a/website/cue/reference/remap/functions/hmac.cue +++ b/website/cue/reference/remap/functions/hmac.cue @@ -10,8 +10,8 @@ remap: functions: hmac: { string using either [encode_base16](\(urls.vrl_functions)/#encode_base16) or [encode_base64](\(urls.vrl_functions)/#encode_base64). - This function is infallible if either the default `algorithm` value, or a recognized-valid compile-time - `algorithm` string literal is used. Otherwise it is fallible. + This function is infallible if either the default `algorithm` value or a recognized-valid compile-time + `algorithm` string literal is used. Otherwise, it is fallible. """ arguments: [ diff --git a/website/cue/reference/remap/functions/ip_aton.cue b/website/cue/reference/remap/functions/ip_aton.cue index 9ffad90ac966b..ec0e9faa32b32 100644 --- a/website/cue/reference/remap/functions/ip_aton.cue +++ b/website/cue/reference/remap/functions/ip_aton.cue @@ -18,7 +18,7 @@ remap: functions: ip_aton: { }, ] internal_failure_reasons: [ - "`value` isn't a valid IPv4 address", + "`value` is not a valid IPv4 address.", ] return: types: ["integer"] diff --git a/website/cue/reference/remap/functions/ip_cidr_contains.cue b/website/cue/reference/remap/functions/ip_cidr_contains.cue index 8bea00c1d432a..ecc1395e38304 100644 --- a/website/cue/reference/remap/functions/ip_cidr_contains.cue +++ b/website/cue/reference/remap/functions/ip_cidr_contains.cue @@ -21,8 +21,8 @@ remap: functions: ip_cidr_contains: { }, ] internal_failure_reasons: [ - "`cidr` isn't a valid CIDR", - "`ip` isn't a valid IP address", + "`cidr` is not a valid CIDR.", + "`ip` is not a valid IP address.", ] return: types: ["boolean"] diff --git a/website/cue/reference/remap/functions/ip_ntoa.cue b/website/cue/reference/remap/functions/ip_ntoa.cue index 1980f698f9c03..26cb3aa300835 100644 --- a/website/cue/reference/remap/functions/ip_ntoa.cue +++ b/website/cue/reference/remap/functions/ip_ntoa.cue @@ -4,7 +4,7 @@ remap: functions: ip_ntoa: { category: "IP" description: """ Converts numeric representation of IPv4 address in network-order bytes - to numbers-and-dots notation.. + to numbers-and-dots notation. This behavior mimics [inet_ntoa](\(urls.ip_ntoa)). """ @@ -18,7 +18,7 @@ remap: functions: ip_ntoa: { }, ] internal_failure_reasons: [ - "`value` cannot fit in u32", + "`value` cannot fit in an unsigned 32-bit integer.", ] return: types: ["string"] diff --git a/website/cue/reference/remap/functions/ip_ntop.cue b/website/cue/reference/remap/functions/ip_ntop.cue index 06c2816e2845c..4389b8fd386d7 100644 --- a/website/cue/reference/remap/functions/ip_ntop.cue +++ b/website/cue/reference/remap/functions/ip_ntop.cue @@ -29,7 +29,7 @@ remap: functions: ip_ntop: { }, ] internal_failure_reasons: [ - "`value` must be of length 4 or 16 bytes", + "`value` must be of length 4 or 16 bytes.", ] return: types: ["string"] diff --git a/website/cue/reference/remap/functions/ip_pton.cue b/website/cue/reference/remap/functions/ip_pton.cue index 1ba0bc54e70e6..2ec24fe4df180 100644 --- a/website/cue/reference/remap/functions/ip_pton.cue +++ b/website/cue/reference/remap/functions/ip_pton.cue @@ -28,7 +28,7 @@ remap: functions: ip_pton: { }, ] internal_failure_reasons: [ - "`value` isn't a valid IP (v4 or v6) address in text form", + "`value` is not a valid IP (v4 or v6) address in text form.", ] return: types: ["string"] diff --git a/website/cue/reference/remap/functions/ip_subnet.cue b/website/cue/reference/remap/functions/ip_subnet.cue index 196de7ef3208c..42b0a45df69be 100644 --- a/website/cue/reference/remap/functions/ip_subnet.cue +++ b/website/cue/reference/remap/functions/ip_subnet.cue @@ -30,8 +30,8 @@ remap: functions: ip_subnet: { }, ] internal_failure_reasons: [ - "`ip` isn't a valid IP address", - "`subnet` isn't a valid subnet.", + "`ip` is not a valid IP address.", + "`subnet` is not a valid subnet.", ] return: types: ["string"] diff --git a/website/cue/reference/remap/functions/ip_to_ipv6.cue b/website/cue/reference/remap/functions/ip_to_ipv6.cue index ddc2b04553470..d1eb75082d8f2 100644 --- a/website/cue/reference/remap/functions/ip_to_ipv6.cue +++ b/website/cue/reference/remap/functions/ip_to_ipv6.cue @@ -15,7 +15,7 @@ remap: functions: ip_to_ipv6: { }, ] internal_failure_reasons: [ - "`ip` isn't a valid IP address", + "`ip` is not a valid IP address.", ] return: { types: ["string"] diff --git a/website/cue/reference/remap/functions/ipv6_to_ipv4.cue b/website/cue/reference/remap/functions/ipv6_to_ipv4.cue index 455b9a418a5d3..fab14bde1117a 100644 --- a/website/cue/reference/remap/functions/ipv6_to_ipv4.cue +++ b/website/cue/reference/remap/functions/ipv6_to_ipv4.cue @@ -16,8 +16,8 @@ remap: functions: ipv6_to_ipv4: { }, ] internal_failure_reasons: [ - "`ip` isn't a valid IP address", - "`ip` is an IPv6 address that isn't compatible with IPv4", + "`ip` is not a valid IP address.", + "`ip` is an IPv6 address that is not compatible with IPv4.", ] return: { types: ["string"] diff --git a/website/cue/reference/remap/functions/keys.cue b/website/cue/reference/remap/functions/keys.cue index f982e3d073521..be3c493fa612f 100644 --- a/website/cue/reference/remap/functions/keys.cue +++ b/website/cue/reference/remap/functions/keys.cue @@ -23,7 +23,7 @@ remap: functions: keys: { } examples: [ { - title: "Get keys from the object." + title: "Get keys from the object" input: log: { "key1": "val1" "key2": "val2" diff --git a/website/cue/reference/remap/functions/length.cue b/website/cue/reference/remap/functions/length.cue index 75d8f56dd0119..9f685e66c5697 100644 --- a/website/cue/reference/remap/functions/length.cue +++ b/website/cue/reference/remap/functions/length.cue @@ -15,7 +15,7 @@ remap: functions: length: { arguments: [ { name: "value" - description: "The array or object" + description: "The array or object." required: true type: ["array", "object", "string"] }, diff --git a/website/cue/reference/remap/functions/map_keys.cue b/website/cue/reference/remap/functions/map_keys.cue index 1d65f0e63dcbb..b4b835f2dce18 100644 --- a/website/cue/reference/remap/functions/map_keys.cue +++ b/website/cue/reference/remap/functions/map_keys.cue @@ -16,24 +16,24 @@ remap: functions: map_keys: { - Any mutation done on a nested object *before* recursing into it, are preserved. 3. For every nested array type: - - First return the key of the array type itself + - First return the key of the array type itself. - Then find all objects within the array, and apply item (2) to each individual object. - Practically speaking, the above rules mean that `map_keys` with - `recursive` enabled will find *all* keys in the target, + The above rules mean that `map_keys` with + `recursive` enabled finds *all* keys in the target, regardless of whether nested objects are nested inside arrays. - The function uses the "function closure syntax" to allow reading + The function uses the function closure syntax to allow reading the key for each item in the object. The same scoping rules apply to closure blocks as they do for - regular blocks, meaning, any variable defined in parent scopes - are accessible, and mutations to those variables are preserved, + regular blocks. This means that any variable defined in parent scopes + is accessible, and mutations to those variables are preserved, but any new variables instantiated in the closure block are unavailable outside of the block. - Check out the examples below to learn about the closure syntax. + See the examples below to learn about the closure syntax. """# arguments: [ diff --git a/website/cue/reference/remap/functions/map_values.cue b/website/cue/reference/remap/functions/map_values.cue index 36f11c00e5ba3..fdfc8548dca40 100644 --- a/website/cue/reference/remap/functions/map_values.cue +++ b/website/cue/reference/remap/functions/map_values.cue @@ -16,7 +16,7 @@ remap: functions: map_values: { - Any mutation done on a collection *before* recursing into it, are preserved. - The function uses the "function closure syntax" to allow mutating + The function uses the function closure syntax to allow mutating the value for each item in the collection. The same scoping rules apply to closure blocks as they do for diff --git a/website/cue/reference/remap/functions/match_array.cue b/website/cue/reference/remap/functions/match_array.cue index d9dd07a60a36d..c45d46c2654f2 100644 --- a/website/cue/reference/remap/functions/match_array.cue +++ b/website/cue/reference/remap/functions/match_array.cue @@ -3,7 +3,7 @@ package metadata remap: functions: match_array: { category: "Enumerate" description: """ - Determines whether the elements in the `value` array matches the `pattern` - by default it checks at least one element matches, but can be set to determine if all the elements match. + Determines whether the elements in the `value` array matches the `pattern`. By default, it checks that at least one element matches, but can be set to determine if all the elements match. """ arguments: [ diff --git a/website/cue/reference/remap/functions/mod.cue b/website/cue/reference/remap/functions/mod.cue index 72e57cb3acfc3..0f6a5d639af8e 100644 --- a/website/cue/reference/remap/functions/mod.cue +++ b/website/cue/reference/remap/functions/mod.cue @@ -21,9 +21,9 @@ remap: functions: mod: { }, ] internal_failure_reasons: [ - "`value` isn't an integer or float", - "`modulus` isn't an integer or float", - "`modulus` is equal to 0", + "`value` is not an integer or float.", + "`modulus` is not an integer or float.", + "`modulus` is equal to 0.", ] return: types: ["string"] diff --git a/website/cue/reference/remap/functions/parse_apache_log.cue b/website/cue/reference/remap/functions/parse_apache_log.cue index 8ad937e778f2e..8da0fbdf0c0d5 100644 --- a/website/cue/reference/remap/functions/parse_apache_log.cue +++ b/website/cue/reference/remap/functions/parse_apache_log.cue @@ -4,7 +4,7 @@ remap: functions: parse_apache_log: { category: "Parse" description: """ Parses Apache access and error log lines. Lines can be in [`common`](\(urls.apache_common)), - [`combined`](\(urls.apache_combined)), or default [`error`](\(urls.apache_error)) format. + [`combined`](\(urls.apache_combined)), or the default [`error`](\(urls.apache_error)) format. """ notices: [ """ @@ -23,7 +23,7 @@ remap: functions: parse_apache_log: { name: "timestamp_format" description: """ The [date/time format](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) to use for - encoding the timestamp. The time is parsed in local time if the timestamp doesn't specify a timezone. + encoding the timestamp. The time is parsed in local time if the timestamp does not specify a timezone. """ required: false default: "%d/%b/%Y:%T %z" @@ -43,15 +43,15 @@ remap: functions: parse_apache_log: { ] internal_failure_reasons: [ - "`value` doesn't match the specified format", - "`timestamp_format` isn't a valid format string", - "The timestamp in `value` fails to parse using the provided `timestamp_format`", + "`value` does not match the specified format.", + "`timestamp_format` is not a valid format string.", + "The timestamp in `value` fails to parse using the provided `timestamp_format`.", ] return: types: ["object"] examples: [ { - title: "Parse via Apache log format (common)" + title: "Parse using Apache log format (common)" source: #""" parse_apache_log!("127.0.0.1 bob frank [10/Oct/2000:13:55:36 -0700] \"GET /apache_pb.gif HTTP/1.0\" 200 2326", format: "common") """# @@ -69,7 +69,7 @@ remap: functions: parse_apache_log: { } }, { - title: "Parse via Apache log format (combined)" + title: "Parse using Apache log format (combined)" source: #""" parse_apache_log!( s'127.0.0.1 bob frank [10/Oct/2000:13:55:36 -0700] "GET /apache_pb.gif HTTP/1.0" 200 2326 "http://www.seniorinfomediaries.com/vertical/channels/front-end/bandwidth" "Mozilla/5.0 (X11; Linux i686; rv:5.0) Gecko/1945-10-12 Firefox/37.0"', @@ -92,7 +92,7 @@ remap: functions: parse_apache_log: { } }, { - title: "Parse via Apache log format (error)" + title: "Parse using Apache log format (error)" source: #""" parse_apache_log!( s'[01/Mar/2021:12:00:19 +0000] [ab:alert] [pid 4803:tid 3814] [client 147.159.108.175:24259] I will bypass the haptic COM bandwidth, that should matrix the CSS driver!', diff --git a/website/cue/reference/remap/functions/parse_aws_alb_log.cue b/website/cue/reference/remap/functions/parse_aws_alb_log.cue index d96547ea75310..68c8f4e0d74b0 100644 --- a/website/cue/reference/remap/functions/parse_aws_alb_log.cue +++ b/website/cue/reference/remap/functions/parse_aws_alb_log.cue @@ -15,7 +15,7 @@ remap: functions: parse_aws_alb_log: { }, ] internal_failure_reasons: [ - "`value` isn't a properly formatted AWS ALB log", + "`value` is not a properly formatted AWS ALB log.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_aws_cloudwatch_log_subscription_message.cue b/website/cue/reference/remap/functions/parse_aws_cloudwatch_log_subscription_message.cue index d126be2437503..0b8953904a4ed 100644 --- a/website/cue/reference/remap/functions/parse_aws_cloudwatch_log_subscription_message.cue +++ b/website/cue/reference/remap/functions/parse_aws_cloudwatch_log_subscription_message.cue @@ -16,7 +16,7 @@ remap: functions: parse_aws_cloudwatch_log_subscription_message: { }, ] internal_failure_reasons: [ - "`value` isn't a properly formatted AWS Cloudwatch Log subscription message", + "`value` is not a properly formatted AWS CloudWatch Log subscription message.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_aws_vpc_flow_log.cue b/website/cue/reference/remap/functions/parse_aws_vpc_flow_log.cue index 8fcd5a8e29abc..d64042b9905a4 100644 --- a/website/cue/reference/remap/functions/parse_aws_vpc_flow_log.cue +++ b/website/cue/reference/remap/functions/parse_aws_vpc_flow_log.cue @@ -21,7 +21,7 @@ remap: functions: parse_aws_vpc_flow_log: { }, ] internal_failure_reasons: [ - "`value` isn't a properly formatted AWS VPC Flow log", + "`value` is not a properly formatted AWS VPC Flow log.", ] return: types: ["object"] @@ -66,10 +66,10 @@ remap: functions: parse_aws_vpc_flow_log: { } }, { - title: "Parse AWS VPC Flow including v5 fields" + title: "Parse AWS VPC Flow log including v5 fields" source: #""" - parse_aws_vpc_flow_log!("5 52.95.128.179 10.0.0.71 80 34210 6 1616729292 1616729349 IPv4 14 15044 123456789012 vpc-abcdefab012345678 subnet-aaaaaaaa012345678 i-0c50d5961bcb2d47b eni-1235b8ca123456789 ap-southeast-2 apse2-az3 - - ACCEPT 19 52.95.128.179 10.0.0.71 S3 - - ingress OK", - format: "version srcaddr dstaddr srcport dstport protocol start end type packets bytes account_id vpc_id subnet_id instance_id interface_id region az_id sublocation_type sublocation_id action tcp_flags pkt_srcaddr pkt_dstaddr pkt_src_aws_service pkt_dst_aws_service traffic_path flow_direction log_status") + parse_aws_vpc_flow_log!("5 52.95.128.179 10.0.0.71 80 34210 6 1616729292 1616729349 IPv4 14 15044 123456789012 vpc-abcdefab012345678 subnet-aaaaaaaa012345678 i-0c50d5961bcb2d47b eni-1235b8ca123456789 ap-southeast-2 apse2-az3 - - ACCEPT 19 52.95.128.179 10.0.0.71 S3 - - ingress OK", + format: "version srcaddr dstaddr srcport dstport protocol start end type packets bytes account_id vpc_id subnet_id instance_id interface_id region az_id sublocation_type sublocation_id action tcp_flags pkt_srcaddr pkt_dstaddr pkt_src_aws_service pkt_dst_aws_service traffic_path flow_direction log_status") """# return: { "account_id": "123456789012" diff --git a/website/cue/reference/remap/functions/parse_cef.cue b/website/cue/reference/remap/functions/parse_cef.cue index b6219eedf65df..5c1d7a415692e 100644 --- a/website/cue/reference/remap/functions/parse_cef.cue +++ b/website/cue/reference/remap/functions/parse_cef.cue @@ -20,13 +20,13 @@ remap: functions: parse_cef: { }, { name: "translate_custom_fields" - description: "Toggles translation of custom field pairs to `key: value`." + description: "Toggles translation of custom field pairs to `key:value`." required: false type: ["boolean"] }, ] internal_failure_reasons: [ - "`value` isn't a properly formatted CEF string", + "`value` is not a properly formatted CEF string.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_common_log.cue b/website/cue/reference/remap/functions/parse_common_log.cue index 9b489360d0a40..29acc391c2a78 100644 --- a/website/cue/reference/remap/functions/parse_common_log.cue +++ b/website/cue/reference/remap/functions/parse_common_log.cue @@ -30,15 +30,15 @@ remap: functions: parse_common_log: { }, ] internal_failure_reasons: [ - "`value` doesn't match the Common Log Format", - "`timestamp_format` isn't a valid format string", - "The timestamp in `value` fails to parse using the provided `timestamp_format`", + "`value` does not match the Common Log Format.", + "`timestamp_format` is not a valid format string.", + "The timestamp in `value` fails to parse using the provided `timestamp_format`.", ] return: types: ["object"] examples: [ { - title: "Parse via Common Log Format (with default timestamp format)" + title: "Parse using Common Log Format (with default timestamp format)" source: #""" parse_common_log!("127.0.0.1 bob frank [10/Oct/2000:13:55:36 -0700] \"GET /apache_pb.gif HTTP/1.0\" 200 2326") """# @@ -56,7 +56,7 @@ remap: functions: parse_common_log: { } }, { - title: "Parse via Common Log Format (with custom timestamp format)" + title: "Parse using Common Log Format (with custom timestamp format)" source: #""" parse_common_log!( "127.0.0.1 bob frank [2000-10-10T20:55:36Z] \"GET /apache_pb.gif HTTP/1.0\" 200 2326", diff --git a/website/cue/reference/remap/functions/parse_csv.cue b/website/cue/reference/remap/functions/parse_csv.cue index a441e3346b462..fc1f01f2517c1 100644 --- a/website/cue/reference/remap/functions/parse_csv.cue +++ b/website/cue/reference/remap/functions/parse_csv.cue @@ -27,8 +27,8 @@ remap: functions: parse_csv: { }, ] internal_failure_reasons: [ - "delimiter must be a single-byte utf8 character", - "`value` isn't a valid CSV string", + "The delimiter must be a single-byte UTF-8 character.", + "`value` is not a valid CSV string.", ] return: types: ["array"] diff --git a/website/cue/reference/remap/functions/parse_duration.cue b/website/cue/reference/remap/functions/parse_duration.cue index f6fbcff0a7130..347fd5493722c 100644 --- a/website/cue/reference/remap/functions/parse_duration.cue +++ b/website/cue/reference/remap/functions/parse_duration.cue @@ -33,7 +33,7 @@ remap: functions: parse_duration: { }, ] internal_failure_reasons: [ - "`value` isn't a properly formatted duration", + "`value` is not a properly formatted duration.", ] return: types: ["float"] diff --git a/website/cue/reference/remap/functions/parse_glog.cue b/website/cue/reference/remap/functions/parse_glog.cue index 9068c1d59155d..3fc76b44ca2b5 100644 --- a/website/cue/reference/remap/functions/parse_glog.cue +++ b/website/cue/reference/remap/functions/parse_glog.cue @@ -14,12 +14,12 @@ remap: functions: parse_glog: { }, ] internal_failure_reasons: [ - "`value` doesn't match the `glog` format", + "`value` does not match the `glog` format.", ] return: types: ["object"] examples: [ { - title: "Parse via glog" + title: "Parse using glog" source: #""" parse_glog!("I20210131 14:48:54.411655 15520 main.c++:9] Hello world!") """# diff --git a/website/cue/reference/remap/functions/parse_grok.cue b/website/cue/reference/remap/functions/parse_grok.cue index 2e474ddcdb467..c207ae4f829b2 100644 --- a/website/cue/reference/remap/functions/parse_grok.cue +++ b/website/cue/reference/remap/functions/parse_grok.cue @@ -3,7 +3,7 @@ package metadata remap: functions: parse_grok: { category: "Parse" description: """ - Parses the `value` using the [`grok` format](\(urls.grok)). All patterns [listed here](\(urls.grok_patterns)) + Parses the `value` using the [`grok`](\(urls.grok)) format. All patterns [listed here](\(urls.grok_patterns)) are supported. """ notices: [ @@ -28,7 +28,7 @@ remap: functions: parse_grok: { }, ] internal_failure_reasons: [ - "`value` fails to parse using the provided `pattern`", + "`value` fails to parse using the provided `pattern`.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_groks.cue b/website/cue/reference/remap/functions/parse_groks.cue index d45ba2051b25c..fea99d661db2f 100644 --- a/website/cue/reference/remap/functions/parse_groks.cue +++ b/website/cue/reference/remap/functions/parse_groks.cue @@ -35,7 +35,7 @@ remap: functions: parse_groks: { }, ] internal_failure_reasons: [ - "`value` fails to parse using the provided `pattern`", + "`value` fails to parse using the provided `pattern`.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_int.cue b/website/cue/reference/remap/functions/parse_int.cue index 1ae4e62987fd4..080a20598e871 100644 --- a/website/cue/reference/remap/functions/parse_int.cue +++ b/website/cue/reference/remap/functions/parse_int.cue @@ -18,17 +18,17 @@ remap: functions: parse_int: { description: """ The base the number is in. Must be between 2 and 36 (inclusive). - If unspecified, will use the string prefix to try to + If unspecified, the string prefix is used to determine the base: "0b", 8 for "0" or "0o", 16 for "0x", - and 10 otherwise + and 10 otherwise. """ required: false type: ["integer"] }, ] internal_failure_reasons: [ - "base is not between 2 and 36", - "number cannot be parsed in the base", + "The base is not between 2 and 36.", + "The number cannot be parsed in the base.", ] return: types: ["string"] diff --git a/website/cue/reference/remap/functions/parse_json.cue b/website/cue/reference/remap/functions/parse_json.cue index d061f95598ab1..512fa5fdcc9b7 100644 --- a/website/cue/reference/remap/functions/parse_json.cue +++ b/website/cue/reference/remap/functions/parse_json.cue @@ -23,14 +23,14 @@ remap: functions: parse_json: { name: "max_depth" description: """ Number of layers to parse for nested JSON-formatted documents. - The value must be in range 1..128. + The value must be in the range of 1 to 128. """ required: false type: ["integer"] }, ] internal_failure_reasons: [ - "`value` isn't a valid JSON-formatted payload", + "`value` is not a valid JSON-formatted payload.", ] return: types: ["boolean", "integer", "float", "string", "object", "array", "null"] diff --git a/website/cue/reference/remap/functions/parse_key_value.cue b/website/cue/reference/remap/functions/parse_key_value.cue index 34135eb1b4b60..e2e28211eec3b 100644 --- a/website/cue/reference/remap/functions/parse_key_value.cue +++ b/website/cue/reference/remap/functions/parse_key_value.cue @@ -3,7 +3,7 @@ package metadata remap: functions: parse_key_value: { category: "Parse" description: """ - Parses the `value` in key/value format. Also known as [logfmt](\(urls.logfmt)). + Parses the `value` in key-value format. Also known as [logfmt](\(urls.logfmt)). * Keys and values can be wrapped with `"`. * `"` characters can be escaped using `\\`. @@ -30,7 +30,7 @@ remap: functions: parse_key_value: { }, { name: "field_delimiter" - description: "The string that separates each key/value pair." + description: "The string that separates each key-value pair." required: false default: " " type: ["string"] @@ -48,14 +48,14 @@ remap: functions: parse_key_value: { }, { name: "accept_standalone_key" - description: "Whether a standalone key should be accepted, the resulting object will associate such keys with boolean value `true`" + description: "Whether a standalone key should be accepted, the resulting object associates such keys with the boolean value `true`." required: false type: ["boolean"] default: true }, ] internal_failure_reasons: [ - "`value` isn't a properly formatted key/value string", + "`value` is not a properly formatted key-value string.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_klog.cue b/website/cue/reference/remap/functions/parse_klog.cue index c31c0af119f9e..c078cd10f4b9c 100644 --- a/website/cue/reference/remap/functions/parse_klog.cue +++ b/website/cue/reference/remap/functions/parse_klog.cue @@ -14,12 +14,12 @@ remap: functions: parse_klog: { }, ] internal_failure_reasons: [ - "`value` doesn't match the `klog` format", + "`value` does not match the `klog` format.", ] return: types: ["object"] examples: [ { - title: "Parse via klog" + title: "Parse using klog" source: #""" parse_klog!("I0505 17:59:40.692994 28133 klog.go:70] hello from klog") """# diff --git a/website/cue/reference/remap/functions/parse_linux_authorization.cue b/website/cue/reference/remap/functions/parse_linux_authorization.cue index a52ca42d3516b..499744346e7b4 100644 --- a/website/cue/reference/remap/functions/parse_linux_authorization.cue +++ b/website/cue/reference/remap/functions/parse_linux_authorization.cue @@ -22,7 +22,7 @@ remap: functions: parse_linux_authorization: { }, ] internal_failure_reasons: [ - "`value` isn't a properly formatted Syslog message", + "`value` is not a properly formatted Syslog message.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_logfmt.cue b/website/cue/reference/remap/functions/parse_logfmt.cue index 0df364c856153..74332c1cd7fc7 100644 --- a/website/cue/reference/remap/functions/parse_logfmt.cue +++ b/website/cue/reference/remap/functions/parse_logfmt.cue @@ -20,7 +20,7 @@ remap: functions: parse_logfmt: { }, ] internal_failure_reasons: [ - "`value` isn't a properly formatted key/value string", + "`value` is not a properly formatted key-value string", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_nginx_log.cue b/website/cue/reference/remap/functions/parse_nginx_log.cue index dd4078aca8588..f58c6f78aab43 100644 --- a/website/cue/reference/remap/functions/parse_nginx_log.cue +++ b/website/cue/reference/remap/functions/parse_nginx_log.cue @@ -4,7 +4,7 @@ remap: functions: parse_nginx_log: { category: "Parse" description: """ Parses Nginx access and error log lines. Lines can be in [`combined`](\(urls.nginx_combined)), - [`ingress_upstreaminfo`](\(urls.nginx_ingress_upstreaminfo)) or [`error`](\(urls.nginx_error)) format. + [`ingress_upstreaminfo`](\(urls.nginx_ingress_upstreaminfo)), or [`error`](\(urls.nginx_error)) format. """ notices: [ """ @@ -48,9 +48,9 @@ remap: functions: parse_nginx_log: { ] internal_failure_reasons: [ - "`value` doesn't match the specified format", - "`timestamp_format` isn't a valid format string", - "The timestamp in `value` fails to parse using the provided `timestamp_format`", + "`value` does not match the specified format.", + "`timestamp_format` is not a valid format string.", + "The timestamp in `value` fails to parse using the provided `timestamp_format`.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_regex.cue b/website/cue/reference/remap/functions/parse_regex.cue index c9687c2d9545f..fc95669169749 100644 --- a/website/cue/reference/remap/functions/parse_regex.cue +++ b/website/cue/reference/remap/functions/parse_regex.cue @@ -3,7 +3,7 @@ package metadata remap: functions: parse_regex: { category: "Parse" description: """ - Parses the `value` via the provided [Regex](\(urls.regex)) `pattern`. + Parses the `value` using the provided [Regex](\(urls.regex)) `pattern`. This function differs from the `parse_regex_all` function in that it returns only the first match. """ @@ -35,8 +35,8 @@ remap: functions: parse_regex: { { name: "numeric_groups" description: """ - If true, the index of each group in the regular expression is also captured. The 0th index - will contain the whole match. + If true, the index of each group in the regular expression is also captured. Index `0` + contains the whole match. """ required: false default: false @@ -44,7 +44,7 @@ remap: functions: parse_regex: { }, ] internal_failure_reasons: [ - "`value` fails to parse using the provided `pattern`", + "`value` fails to parse using the provided `pattern`.", ] return: { types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_regex_all.cue b/website/cue/reference/remap/functions/parse_regex_all.cue index 30283949ab4a7..98f3d294cb617 100644 --- a/website/cue/reference/remap/functions/parse_regex_all.cue +++ b/website/cue/reference/remap/functions/parse_regex_all.cue @@ -3,7 +3,7 @@ package metadata remap: functions: parse_regex_all: { category: "Parse" description: """ - Parses the `value` via the provided [Regex](\(urls.regex)) `pattern`. + Parses the `value` using the provided [Regex](\(urls.regex)) `pattern`. This function differs from the `parse_regex` function in that it returns _all_ matches, not just the first. """ @@ -25,7 +25,7 @@ remap: functions: parse_regex_all: { { name: "numeric_groups" description: """ - If `true`, the index of each group in the regular expression is also captured. The 0th index + If `true`, the index of each group in the regular expression is also captured. Index `0` contains the whole match. """ required: false @@ -34,7 +34,7 @@ remap: functions: parse_regex_all: { }, ] internal_failure_reasons: [ - "`value` fails to parse via the provided `pattern`", + "`value` fails to parse using the provided `pattern`.", ] return: { types: ["array"] diff --git a/website/cue/reference/remap/functions/parse_ruby_hash.cue b/website/cue/reference/remap/functions/parse_ruby_hash.cue index 49daf5dc8a901..9d733c6ea2c5c 100644 --- a/website/cue/reference/remap/functions/parse_ruby_hash.cue +++ b/website/cue/reference/remap/functions/parse_ruby_hash.cue @@ -21,7 +21,7 @@ remap: functions: parse_ruby_hash: { }, ] internal_failure_reasons: [ - "`value` isn't a valid ruby hash formatted payload", + "`value` is not a valid ruby hash formatted payload.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_syslog.cue b/website/cue/reference/remap/functions/parse_syslog.cue index aa40ff1ddbcc2..cb17be2b04146 100644 --- a/website/cue/reference/remap/functions/parse_syslog.cue +++ b/website/cue/reference/remap/functions/parse_syslog.cue @@ -25,7 +25,7 @@ remap: functions: parse_syslog: { }, ] internal_failure_reasons: [ - "`value` isn't a properly formatted Syslog message", + "`value` is not a properly formatted Syslog message.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_timestamp.cue b/website/cue/reference/remap/functions/parse_timestamp.cue index 4b097c83063c5..dd679567e6642 100644 --- a/website/cue/reference/remap/functions/parse_timestamp.cue +++ b/website/cue/reference/remap/functions/parse_timestamp.cue @@ -22,7 +22,7 @@ remap: functions: parse_timestamp: { ] internal_failure_reasons: [ - "`value` fails to parse using the provided `format`", + "`value` fails to parse using the provided `format`.", ] return: types: ["timestamp"] diff --git a/website/cue/reference/remap/functions/parse_tokens.cue b/website/cue/reference/remap/functions/parse_tokens.cue index 2083884b340ab..c76fb6e2f6ef2 100644 --- a/website/cue/reference/remap/functions/parse_tokens.cue +++ b/website/cue/reference/remap/functions/parse_tokens.cue @@ -3,7 +3,7 @@ package metadata remap: functions: parse_tokens: { category: "Parse" description: #""" - Parses the `value` in "token" format. A token is considered to be one of the following: + Parses the `value` in token format. A token is considered to be one of the following: * A word surrounded by whitespace. * Text delimited by double quotes: `".."`. Quotes can be included in the token if they are escaped by a backslash (`\`). @@ -24,7 +24,7 @@ remap: functions: parse_tokens: { }, ] internal_failure_reasons: [ - "`value` isn't a properly formatted tokenized string", + "`value` is not a properly formatted tokenized string.", ] return: types: ["array"] diff --git a/website/cue/reference/remap/functions/parse_url.cue b/website/cue/reference/remap/functions/parse_url.cue index b2721de8d10a3..fb229b0ca38d7 100644 --- a/website/cue/reference/remap/functions/parse_url.cue +++ b/website/cue/reference/remap/functions/parse_url.cue @@ -17,7 +17,7 @@ remap: functions: parse_url: { name: "default_known_ports" description: """ If true and the port number is not specified in the input URL - string (or matches the default port for the scheme), it will be + string (or matches the default port for the scheme), it is populated from well-known ports for the following schemes: `http`, `https`, `ws`, `wss`, and `ftp`. """ @@ -27,7 +27,7 @@ remap: functions: parse_url: { }, ] internal_failure_reasons: [ - "`value` isn't a properly formatted URL", + "`value` is not a properly formatted URL.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/parse_user_agent.cue b/website/cue/reference/remap/functions/parse_user_agent.cue index acfc045189ef1..3f0717ff5a292 100644 --- a/website/cue/reference/remap/functions/parse_user_agent.cue +++ b/website/cue/reference/remap/functions/parse_user_agent.cue @@ -3,7 +3,7 @@ package metadata remap: functions: parse_user_agent: { category: "Parse" description: """ - Parses the `value` as a user agent string. Which has [a loosely defined format](\(urls.user_agent)) + Parses the `value` as a user agent string, which has [a loosely defined format](\(urls.user_agent)) so this parser only provides best effort guarantee. """ notices: [ diff --git a/website/cue/reference/remap/functions/parse_xml.cue b/website/cue/reference/remap/functions/parse_xml.cue index 82d2691a69fc4..ffe2ed4348e54 100644 --- a/website/cue/reference/remap/functions/parse_xml.cue +++ b/website/cue/reference/remap/functions/parse_xml.cue @@ -69,7 +69,7 @@ remap: functions: parse_xml: { }, ] internal_failure_reasons: [ - "`value` isn't a valid XML document", + "`value` is not a valid XML document.", ] return: types: ["object"] diff --git a/website/cue/reference/remap/functions/remove_secret.cue b/website/cue/reference/remap/functions/remove_secret.cue index 16466acfb3ef4..9f4cb61f8cf5b 100644 --- a/website/cue/reference/remap/functions/remove_secret.cue +++ b/website/cue/reference/remap/functions/remove_secret.cue @@ -22,7 +22,7 @@ remap: functions: remove_secret: { examples: [ { - title: "Removes the Datadog API key from the event." + title: "Removes the Datadog API key from the event" source: #""" remove_secret("datadog_api_key") """# diff --git a/website/cue/reference/remap/functions/seahash.cue b/website/cue/reference/remap/functions/seahash.cue index b3c1b5e6bf0a7..d4367c2e7a827 100644 --- a/website/cue/reference/remap/functions/seahash.cue +++ b/website/cue/reference/remap/functions/seahash.cue @@ -4,7 +4,7 @@ remap: functions: seahash: { category: "Cryptography" description: """ Calculates a [Seahash](\(urls.seahash)) hash of the `value`. - Note: Due to limitations in the underlying VRL data types, this function converts the unsigned 64-bit integer seahash result to a signed 64-bit integer. Results higher than the signed 64-bit integer maximum value wrap around to negative values. + **Note**: Due to limitations in the underlying VRL data types, this function converts the unsigned 64-bit integer SeaHash result to a signed 64-bit integer. Results higher than the signed 64-bit integer maximum value wrap around to negative values. """ arguments: [ diff --git a/website/cue/reference/remap/functions/set_secret.cue b/website/cue/reference/remap/functions/set_secret.cue index 904dd676d26e1..d532d405243ab 100644 --- a/website/cue/reference/remap/functions/set_secret.cue +++ b/website/cue/reference/remap/functions/set_secret.cue @@ -26,7 +26,7 @@ remap: functions: set_secret: { examples: [ { - title: "Set the Datadog API key to the given value." + title: "Set the Datadog API key to the given value" source: #""" set_secret("datadog_api_key", "abc122") """# diff --git a/website/cue/reference/remap/functions/set_semantic_meaning.cue b/website/cue/reference/remap/functions/set_semantic_meaning.cue index 83a9e907323d9..91193cd4c571c 100644 --- a/website/cue/reference/remap/functions/set_semantic_meaning.cue +++ b/website/cue/reference/remap/functions/set_semantic_meaning.cue @@ -3,18 +3,18 @@ package metadata remap: functions: set_semantic_meaning: { category: "Event" description: """ - Sets a semantic meaning for an event. Note that this function assigns + Sets a semantic meaning for an event. **Note**: This function assigns meaning at startup, and has _no_ runtime behavior. It is suggested to put all calls to this function at the beginning of a VRL function. The function - cannot be conditionally called (eg: using an if statement cannot stop the meaning - from being assigned). + cannot be conditionally called. For example, using an if statement cannot stop the meaning + from being assigned. """ arguments: [ { name: "target" description: """ - The path of the value that will be assigned a meaning. + The path of the value that is assigned a meaning. """ required: true type: ["path"] diff --git a/website/cue/reference/remap/functions/strlen.cue b/website/cue/reference/remap/functions/strlen.cue index 0ae8b6fc7a67e..5aab9bb20a188 100644 --- a/website/cue/reference/remap/functions/strlen.cue +++ b/website/cue/reference/remap/functions/strlen.cue @@ -4,16 +4,16 @@ remap: functions: strlen: { category: "Enumerate" description: """ Returns the number of UTF-8 characters in `value`. This differs from - `length` which would count the number of bytes of a string. + `length` which counts the number of bytes of a string. - Note that this is the count of [unicode scalar values](https://www.unicode.org/glossary/#unicode_scalar_value) - which can sometimes differ from [unicode code points](https://www.unicode.org/glossary/#code_point). + **Note**: This is the count of [Unicode scalar values](https://www.unicode.org/glossary/#unicode_scalar_value) + which can sometimes differ from [Unicode code points](https://www.unicode.org/glossary/#code_point). """ arguments: [ { name: "value" - description: "The string" + description: "The string." required: true type: ["string"] }, diff --git a/website/cue/reference/remap/functions/to_bool.cue b/website/cue/reference/remap/functions/to_bool.cue index 6d7a10594d155..3ba6a9d45d898 100644 --- a/website/cue/reference/remap/functions/to_bool.cue +++ b/website/cue/reference/remap/functions/to_bool.cue @@ -15,7 +15,7 @@ remap: functions: to_bool: { }, ] internal_failure_reasons: [ - "`value` isn't a supported boolean representation", + "`value` is not a supported boolean representation.", ] return: { types: ["boolean"] diff --git a/website/cue/reference/remap/functions/to_float.cue b/website/cue/reference/remap/functions/to_float.cue index 402e8674befb2..367d1cacccf89 100644 --- a/website/cue/reference/remap/functions/to_float.cue +++ b/website/cue/reference/remap/functions/to_float.cue @@ -17,7 +17,7 @@ remap: functions: to_float: { }, ] internal_failure_reasons: [ - "`value` isn't a supported float representation", + "`value` is not a supported float representation.", ] return: { types: ["float"] diff --git a/website/cue/reference/remap/functions/to_int.cue b/website/cue/reference/remap/functions/to_int.cue index b98e95cd12564..1c8f3dcb48d41 100644 --- a/website/cue/reference/remap/functions/to_int.cue +++ b/website/cue/reference/remap/functions/to_int.cue @@ -17,8 +17,8 @@ remap: functions: to_int: { }, ] internal_failure_reasons: [ - "`value` is a string but the text is not an integer", - "`value` is not a string, int, or timestamp", + "`value` is a string but the text is not an integer.", + "`value` is not a string, int, or timestamp.", ] return: { types: ["integer"] diff --git a/website/cue/reference/remap/functions/to_string.cue b/website/cue/reference/remap/functions/to_string.cue index 2216062b02471..4a8104d1bd32b 100644 --- a/website/cue/reference/remap/functions/to_string.cue +++ b/website/cue/reference/remap/functions/to_string.cue @@ -15,7 +15,7 @@ remap: functions: to_string: { }, ] internal_failure_reasons: [ - "`value` is not an integer, float, boolean, string, timestamp, or null", + "`value` is not an integer, float, boolean, string, timestamp, or null.", ] return: { types: ["string"] diff --git a/website/cue/reference/remap/functions/to_syslog_facility.cue b/website/cue/reference/remap/functions/to_syslog_facility.cue index ed1b2d8f79921..01cfc89ea909a 100644 --- a/website/cue/reference/remap/functions/to_syslog_facility.cue +++ b/website/cue/reference/remap/functions/to_syslog_facility.cue @@ -4,7 +4,7 @@ remap: functions: to_syslog_facility: { category: "Convert" description: """ Converts the `value`, a Syslog [facility code](\(urls.syslog_facility)), into its corresponding - Syslog keyword. i.e. 0 into `"kern"`, 1 into `"user"`, etc. + Syslog keyword. For example, `0` into `"kern"`, `1` into `"user"`, etc. """ arguments: [ @@ -16,7 +16,7 @@ remap: functions: to_syslog_facility: { }, ] internal_failure_reasons: [ - "`value` isn't a valid Syslog [facility code](\(urls.syslog_facility)).", + "`value` is not a valid Syslog [facility code](\(urls.syslog_facility)).", ] return: types: ["string"] diff --git a/website/cue/reference/remap/functions/to_syslog_severity.cue b/website/cue/reference/remap/functions/to_syslog_severity.cue index 1ea64b2f5a8d9..a50986a9ecbc5 100644 --- a/website/cue/reference/remap/functions/to_syslog_severity.cue +++ b/website/cue/reference/remap/functions/to_syslog_severity.cue @@ -16,7 +16,7 @@ remap: functions: to_syslog_severity: { }, ] internal_failure_reasons: [ - "`value` isn't a valid Syslog level keyword", + "`value` is not a valid Syslog level keyword.", ] return: { types: ["integer"] diff --git a/website/cue/reference/remap/functions/to_unix_timestamp.cue b/website/cue/reference/remap/functions/to_unix_timestamp.cue index 8691554794198..c80b50327aad4 100644 --- a/website/cue/reference/remap/functions/to_unix_timestamp.cue +++ b/website/cue/reference/remap/functions/to_unix_timestamp.cue @@ -5,14 +5,13 @@ remap: functions: to_unix_timestamp: { description: """ Converts the `value` timestamp into a [Unix timestamp](\(urls.unix_timestamp)). - Returns the number of seconds since the Unix epoch by default, but milliseconds or nanoseconds can also be - specified by `unit`. + Returns the number of seconds since the Unix epoch by default. To return the number in milliseconds or nanoseconds, set the `unit` argument to `milliseconds` or `nanoseconds`. """ arguments: [ { name: "value" - description: "The timestamp to convert to Unix." + description: "The timestamp to convert into a Unix timestamp." required: true type: ["timestamp"] }, diff --git a/website/cue/reference/remap/functions/unique.cue b/website/cue/reference/remap/functions/unique.cue index 3bb00bf9228d3..6dcb86389ca49 100644 --- a/website/cue/reference/remap/functions/unique.cue +++ b/website/cue/reference/remap/functions/unique.cue @@ -3,7 +3,7 @@ package metadata remap: functions: unique: { category: "Enumerate" description: #""" - Returns unique values for an array. + Returns the unique values for an array. The first occurrence of each element is kept. """# diff --git a/website/cue/reference/remap/functions/unnest.cue b/website/cue/reference/remap/functions/unnest.cue index 913ad9484aabb..3a1592a646f26 100644 --- a/website/cue/reference/remap/functions/unnest.cue +++ b/website/cue/reference/remap/functions/unnest.cue @@ -5,10 +5,10 @@ remap: functions: unnest: { description: """ Unnest an array field from an object to create an array of objects using that field; keeping all other fields. - Assigning the array result of this to `.` will result in multiple events being emitted from `remap`. See the + Assigning the array result of this to `.` results in multiple events being emitted from `remap`. See the [`remap` transform docs](\(urls.vector_remap_transform_multiple)) for more details. - This is also referred to as `explode`ing in some languages. + This is also referred to as `explode` in some languages. """ arguments: [ @@ -20,7 +20,7 @@ remap: functions: unnest: { }, ] internal_failure_reasons: [ - "Field path refers to is not an array", + "The field path referred to is not an array.", ] notices: [] return: { diff --git a/website/cue/reference/remap/functions/values.cue b/website/cue/reference/remap/functions/values.cue index 8a59c089a90be..78586579b159d 100644 --- a/website/cue/reference/remap/functions/values.cue +++ b/website/cue/reference/remap/functions/values.cue @@ -23,7 +23,7 @@ remap: functions: values: { } examples: [ { - title: "Get values from the object." + title: "Get values from the object" input: log: { "key1": "val1" "key2": "val2" diff --git a/website/cue/reference/urls.cue b/website/cue/reference/urls.cue index 836b1050114ad..bba6a6d352126 100644 --- a/website/cue/reference/urls.cue +++ b/website/cue/reference/urls.cue @@ -239,7 +239,7 @@ urls: { greptimecloud: "https://greptime.cloud" greptimedb: "https://github.com/greptimeteam/greptimedb" greptimedb_grpc: "https://docs.greptime.com/" - grok: "https://grokdebug.herokuapp.com/" + grok: "https://github.com/daschl/grok/tree/master/patterns" grok_debugger: "https://grokdebug.herokuapp.com/" grok_patterns: "\(github)/daschl/grok/tree/master/patterns" gzip: "https://www.gzip.org/"