Skip to content
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.

Sign up for GitHub

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

Update docs on error handling output schema. #32874

Merged
merged 1 commit into from
Oct 22, 2024
Merged

Update docs on error handling output schema. #32874

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion website/www/site/content/en/documentation/sdks/yaml-errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ The `output` parameter is a name that must referenced as an input to
another transform that will process the errors (e.g. by writing them out).
For example,
the following code will write all "good" processed records to one file and
any "bad" records to a separate file.
any "bad" records, along with metadata about what error was encountered,
to a separate file.

```
pipeline:
Expand Down Expand Up @@ -77,6 +78,8 @@ for a robust pipeline).
Note also that the exact format of the error outputs is still being finalized.
They can be safely printed and written to outputs, but their precise schema
may change in a future version of Beam and should not yet be depended on.
Currently it has, at the very least, an `element` field which holds the element
that caused the error.

Some transforms allow for extra arguments in their error_handling config, e.g.
for Python functions one can give a `threshold` which limits the relative number
Expand Down
Loading