Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marc-gr committed Dec 11, 2024
1 parent 9b51965 commit faf0309
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 6 deletions.
7 changes: 2 additions & 5 deletions x-pack/filebeat/docs/inputs/input-unifiedlogs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,9 @@ telemetry across all levels of the system. This system centralizes the storage o
log data in memory and on disk, rather than writing that data to a text-based log file.

The input interacts with the `log` command-line tool to provide access to the events.
It can process events in some different ways:

- Streaming new, incoming events. This is the default.
- Start processing events from a start date. This happens when the input is restarted,
or when a specific start date is provided.
- Start processing events since the beginning of time, by setting the `backill` option.
The input starts streaming events from the current point in time unless a start date or
the `backfill` options are set. When restarted it will continue where it left off.

Alternatively, it can also do one off operations, such as:

Expand Down
2 changes: 1 addition & 1 deletion x-pack/filebeat/input/unifiedlogs/input.go
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ func (input *input) runWithMetrics(ctx context.Context, pub inputcursor.Publishe

// to avoid race conditions updating the cursor, and to be able to
// resume from the oldest point in time, we only update cursor
// from the streaming gorouting once backfilling is done.
// from the streaming goroutine once backfilling is done.
defer wrappedPub.startUpdatingCursor()
}
logCmd := newLogShowCmd(ctx, input.config)
Expand Down

0 comments on commit faf0309

Please sign in to comment.