Skip to content

Add custom functions to OP Custom Processor doc [WEB-9510]#37956

Open
Jackie-Robson wants to merge 1 commit into
masterfrom
jackie.robson/web-9510-add-vrl-functions
Open

Add custom functions to OP Custom Processor doc [WEB-9510]#37956
Jackie-Robson wants to merge 1 commit into
masterfrom
jackie.robson/web-9510-add-vrl-functions

Conversation

@Jackie-Robson

@Jackie-Robson Jackie-Robson commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

What does this PR do? What is the motivation?

Surfaces VRL functions/features that were recently added to Observability Pipelines in the OP Custom Processor reference. The page renders data/reference/functions.json, so these are added there. Requested in WEB-9510 by the OP team; follows the same pattern as WEB-7892.

Changes (all in data/reference/functions.json):

  • shannon_entropy — add "UTF-8 emoji (7 Unicode scalar values) with grapheme segmentation" example
  • parse_regex — add "Parse using Regex with variables" example
  • parse_regex_all — add "Parse using Regex with variables" example
  • encode_proto — add the optional allow_lossy_string_coercion argument
  • to_entries — add function (Object category)
  • from_entries — add function (Object category)

Definitions/examples were sourced from the upstream vectordotdev/vrl stdlib to match canonical signatures and outputs.

Merge readiness

  • Ready for merge

AI assistance

Used Claude Code: located the rendering mechanism and prior-art commit, pulled authoritative definitions from upstream VRL stdlib, and made the JSON edits. Reviewed by me.

Additional notes

No new function category is introduced (all fall under existing String/Codec/Parse/Object groups), so custom_processor.md's category list needs no change. JSON validated with python3 -m json.tool.

Surface VRL functions/features recently added to Observability Pipelines
in the Custom Processor reference (data/reference/functions.json):

- shannon_entropy: add UTF-8 emoji (7 Unicode scalar values) example
- parse_regex: add 'Parse using Regex with variables' example
- parse_regex_all: add 'Parse using Regex with variables' example
- encode_proto: add allow_lossy_string_coercion argument
- to_entries: add function (Object category)
- from_entries: add function (Object category)

Definitions sourced from upstream vectordotdev/vrl stdlib.
@Jackie-Robson Jackie-Robson requested a review from a team as a code owner July 3, 2026 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant