Skip to content

monitoring.md: Add input Tail plugin metrics to monitoring page #2380

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

Closed
c-neto wants to merge 1 commit into from
+17 −0
Closed

monitoring.md: Add input Tail plugin metrics to monitoring page #2380

Show file tree
Hide file tree
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
13 changes: 13 additions & 0 deletions administration/monitoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,19 @@ The following are detailed descriptions for the metrics collected by the storage
| `fluentbit_output_upstream_total_connections` | name: the name or alias for the output instance | The sum of the connection count of each output plugins. | gauge | bytes |
| `fluentbit_output_upstream_busy_connections` | name: the name or alias for the output instance | The sum of the connection count in a busy state of each output plugins. | gauge | bytes |

#### Tail input plugin metrics

The following are detailed descriptions for the metrics collected when using the [Tail](../pipeline/inputs/tail.md) Input Plugin.

| Metric Name | Labels | Description | Type | Unit |
|---------------------------------------------|------------------------------|---------------|---------|---------|
| `fluentbit_input_files_closed_total` | name: the name or alias for the input instance | Total number of closed files. | counter | records |
| `fluentbit_input_files_opened_total` | name: the name or alias for the input instance | Total number of opened files. | counter | records |
| `fluentbit_input_files_rotated_total` | name: the name or alias for the input instance | Total number of rotated files. | counter | records |
| `fluentbit_input_long_line_skipped_total` | name: the name or alias for the input instance | Total number of skipped occurrences for long lines. This metric is only created when `skip_long_lines` is set to `true`. | counter | records |
| `fluentbit_input_long_line_truncated_total` | name: the name or alias for the input instance | Total number of truncated occurrences for long lines. This metric is only created when `truncate_long_lines` is set to `true`. | counter | records |
| `fluentbit_input_multiline_truncated_total` | name: the name or alias for the input instance. | Total number of truncated occurrences for multiline. This metric is only created when `multiline.parser` is defined. | counter | records |

### Output latency metric

Introduced in Fluent Bit 4.0.6, the `fluentbit_output_latency_seconds` histogram metric captures end-to-end latency from the time a chunk is created by an input plugin until it's successfully delivered by an output plugin. This provides observability into chunk-level pipeline performance and helps identify slowdowns or bottlenecks in the output path.
Expand Down
4 changes: 4 additions & 0 deletions pipeline/inputs/tail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,3 +569,7 @@ pipeline:

{% endtab %}
{% endtabs %}

### Input tail metrics

The Tail input plugin provides several dedicated metrics related to skipped long lines, truncated lines, and others. For detailed information about available metrics and how to use them, see [Monitoring](../../administration/monitoring.md).