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

Fix comment grammar in loop.go #1518

Merged
merged 2 commits into from
Jan 31, 2024
Merged

Fix comment grammar in loop.go #1518

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13d76b7
Add fix
bjee19 Jan 31, 2024
2a18d9c
Another fix
bjee19 Jan 31, 2024
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
10 changes: 5 additions & 5 deletions internal/framework/events/loop.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ import (
// - Otherwise, the new event will be saved for later handling. All saved events will be handled after the handling of
// the current event(s) finishes. Multiple saved events will be handled at once -- they will be batched.
//
// Batching is needed because, because typically handling an event (or multiple events at once) will result into
// reloading NGINX, which is the operation we want to minimize, for the following reasons:
// (1) A reload takes time - at least 200ms. The time depends on the size of the configuration including the number of
// TLS certs, available CPU cycles.
// (2) A reload can have side-effects for the data plane traffic.
// Batching is needed because handling an event (or multiple events at once) will typically result in
// reloading NGINX, which is an operation we want to minimize for the following reasons:
// (1) A reload takes time - at least 200ms. The time depends on the size of the configuration, the number of
// TLS certs, and the number of available CPU cycles.
// (2) A reload can have side-effects for data plane traffic.
// FIXME(pleshakov): better document the side effects and how to prevent and mitigate them.
// So when the EventLoop have 100 saved events, it is better to process them at once rather than one by one.
// https://github.com/nginxinc/nginx-gateway-fabric/issues/551
Expand Down
Loading