Skip to content

filebeat/input/v2: improve context cancelation documentation #47906

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −0
Open

filebeat/input/v2: improve context cancelation documentation #47906

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
10 changes: 10 additions & 0 deletions filebeat/input/v2/input.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,11 @@ type Context struct {
Agent beat.Info

// Cancelation is used by Beats to signal the input to shut down.
//
// An input started with a Context parameter, ctx, must shut down when
// <-ctx.Cancelation.Done() does not block or when ctx.Cancelation.Error()
// returns a non-nil error. If an input is started with a specific Context
// it should only shutdown in response to that Context's Cancelation.
Cancelation Canceler

// StatusReporter provides a method to update the status of the underlying unit
Expand Down Expand Up @@ -221,6 +226,11 @@ type TestContext struct {
Agent beat.Info

// Cancelation is used by Beats to signal the input to shut down.
//
// An input started with a Context parameter, ctx, must shut down when
// <-ctx.Cancelation.Done() does not block or when ctx.Cancelation.Error()
// returns a non-nil error. If an input is started with a specific Context
// it should only shutdown in response to that Context's Cancelation.
Cancelation Canceler
}

Expand Down
Loading