-
-
Notifications
You must be signed in to change notification settings - Fork 3
Update UDP docs for the new executor #260
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
Open
jachris
wants to merge
5
commits into
topic/new-executor
Choose a base branch
from
topic/port-udp
base: topic/new-executor
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
7a0828f
Add to_udp operator documentation
jachris 44d8406
Remove legacy UDP operator docs
jachris 139956b
Clarify to_udp message types
jachris da3fb7d
Use string in to_udp docs
jachris 63be852
Document accept_udp instead of from_udp
jachris File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,59 @@ | ||
| --- | ||
| title: to_udp | ||
| category: Outputs/Events | ||
| example: 'to_udp "127.0.0.1:514", message=this' | ||
| --- | ||
|
|
||
| import Integration from '@components/see-also/Integration.astro'; | ||
| import Op from '@components/see-also/Op.astro'; | ||
|
|
||
| Sends one UDP datagram per input event. | ||
|
|
||
| ```tql | ||
| to_udp endpoint:str, [message=string|blob|record|null] | ||
| ``` | ||
|
|
||
| ## Description | ||
|
|
||
| Sends one UDP datagram per input event to a fixed remote UDP endpoint. | ||
|
|
||
| ### `endpoint: str` | ||
|
|
||
| The address of the remote endpoint. Must be of the format `host:port`. The | ||
| optional `udp://` prefix is accepted but not required. | ||
|
|
||
| ### `message = string|blob|record|null (optional)` | ||
|
|
||
| An expression that is evaluated once per input event and must produce one of | ||
| the following types: | ||
|
|
||
| - `string` values are sent as UTF-8 bytes. | ||
| - `blob` values are sent verbatim. | ||
| - `record` values are serialized as compact JSON. | ||
| - `null` values are skipped with a warning. | ||
|
|
||
| All other result types are ignored with a warning. | ||
|
|
||
| If you omit `message`, the operator sends the whole event as compact JSON. | ||
|
|
||
| ## Examples | ||
|
|
||
| Send a field as a UDP datagram: | ||
|
|
||
| ```tql | ||
| from {message: "hello"} | ||
| to_udp "127.0.0.1:514", message=message | ||
| ``` | ||
|
|
||
| Send the full event as compact JSON: | ||
|
|
||
| ```tql | ||
| from {service: "dns", status: "ok"} | ||
| to_udp "127.0.0.1:514" | ||
| ``` | ||
|
|
||
| ## See Also | ||
|
|
||
| - <Op>from_udp</Op> | ||
| - <Op>save_udp</Op> | ||
| - <Integration>udp</Integration> |
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.
This new card is inserted in the bytes CardGrid (between
save_udpandsave_zmq) even thoughto_udpis documented as an event output operator (category: Outputs/Eventsinreference/operators/to_udp.mdx). On/reference/operators, users browse by section headings, so keepingto_udpunder bytes makes it easy to miss and misclassifies its usage model. Move it to the Events section so discoverability and categorization match the operator contract.Useful? React with 👍 / 👎.