Skip to content

Fixed case in config param table for head input plugin doc. Applies to #2260. #2262

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
eschabell merged 1 commit into from
Dec 2, 2025
Merged

Fixed case in config param table for head input plugin doc. Applies to #2260. #2262

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
24 changes: 12 additions & 12 deletions pipeline/inputs/head.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ The plugin supports the following configuration parameters:

| Key | Description | Default |
|:----------------|:--------------------------------------------------------------------------------------------------------|:--------|
| `Add_Path` | If enabled, the path is appended to each record. | `false` |
| `Buf_Size` | Buffer size to read the file. | `256` |
| `File` | Absolute path to the target file. For example: `/proc/uptime`. | _none_ |
| `Interval_NSec` | Polling interval (nanoseconds). | `0` |
| `Interval_Sec` | Polling interval (seconds). | `1` |
| `Key` | Rename a key. | `head` |
| `Lines` | Line number to read. If the number N is set, `in_head` reads first N lines like `head(1) -n`. | `0` |
| `Split_line` | If enabled, `in_head` generates key-value pair per line. | `false` |
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
| `add_path` | If enabled, the path is appended to each record. | `false` |
| `buf_size` | Buffer size to read the file. | `256` |
| `file` | Absolute path to the target file. For example: `/proc/uptime`. | _none_ |
| `interval_nsec` | Polling interval (nanoseconds). | `0` |
| `interval_sec` | Polling interval (seconds). | `1` |
| `key` | Rename a key. | `head` |
| `lines` | Line number to read. If the number N is set, `in_head` reads first N lines like `head(1) -n`. | `0` |
| `split_line` | If enabled, `in_head` generates key-value pair per line. | `false` |
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |

## Getting started

Expand Down Expand Up @@ -78,7 +78,7 @@ pipeline:
File /proc/uptime
Buf_Size 256
Interval_Sec 1
Interval_NSec 0
Interval_Nsec 0

[OUTPUT]
Name stdout
Expand All @@ -90,7 +90,7 @@ pipeline:

The interval is calculated like this:

`Total interval (sec) = Interval_Sec + (Interval_Nsec / 1000000000)`.
`Total interval (sec) = interval_sec + (interval_nsec / 1000000000)`.

For example: `1.5s = 1s + 500000000ns`.

Expand Down Expand Up @@ -147,7 +147,7 @@ pipeline:
Tag head.cpu
File /proc/cpuinfo
Lines 8
Split_line true
Split_Line true
# {"line0":"processor : 0", "line1":"vendor_id : GenuineIntel" ...}

[FILTER]
Expand Down