Skip to content

chore: add note to DEVELOPING.md re panics #17277

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

Merged
spencergilbert merged 1 commit into from
May 2, 2023
Merged

chore: add note to DEVELOPING.md re panics #17277

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
11 changes: 11 additions & 0 deletions docs/DEVELOPING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,17 @@ Yep!
warn!(message = "Failed to merge value.", %error);
```

#### Panics

As a general rule, code in Vector should *not* panic.

However, there are very rare situations where the code makes certain assumptions
about the given state and if those assumptions are not met this is clearly due
to a bug within Vector. In this situation Vector cannot safely proceed. Issuing
a panic here is acceptable.

All potential panics *MUST* be clearly documented in the function documentation.

### Feature flags

When a new component (a source, transform, or sink) is added, it has to be put
Expand Down