Skip to content

Commit 08e4bb3

Browse files
committed
Admin: monitoring:final style
Signed-off-by: Lynette Miles <[email protected]>
1 parent f0c33bd commit 08e4bb3

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

administration/monitoring.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ pipeline:
6161
{% endtab %}
6262
{% endtabs %}
6363

64-
Start Fluent bit with the corresponding configuration chosen previously:
64+
Start Fluent Bit with the corresponding configuration chosen previously:
6565

6666
```shell
6767
# For YAML configuration.
@@ -122,7 +122,7 @@ Fluent Bit exposes the following endpoints for monitoring.
122122
| `/api/v1/health` | Display the Fluent Bit health check result. | String |
123123
| `/api/v2/metrics` | Display internal metrics per loaded plugin. | [cmetrics text format](https://github.com/fluent/cmetrics) |
124124
| `/api/v2/metrics/prometheus` | Display internal metrics per loaded plugin ready in Prometheus Server format. | Prometheus Text 0.0.4 |
125-
| `/api/v2/reload | Execute hot reloading or get the status of hot reloading. See the [hot-reloading documentation](hot-reload.md). | JSON |
125+
| `/api/v2/reload` | Execute hot reloading or get the status of hot reloading. See the [hot-reloading documentation](hot-reload.md). | JSON |
126126

127127
### v1 metrics
128128

@@ -137,7 +137,7 @@ The following terms are key to understanding how Fluent Bit processes metrics:
137137
- **Record**: a single message collected from a source, such as a single long line in a file.
138138
- **Chunk**: log records ingested and stored by Fluent Bit input plugin instances. A batch of records in a chunk are tracked together as a single unit.
139139

140-
The Fluent Bit engine attempts to fit records into chunks of at most `2 MB`, but the size can vary at runtime. Chunks are then sent to an output. An output plugin instance can either successfully send the full chunk to the destination and mark it as successful, or it can fail the chunk entirely if an unrecoverable error is encountered, or it can ask for the chunk to be retried.
140+
The Fluent Bit engine attempts to fit records into chunks of at most `2 MB`, but the size can vary at runtime. Chunks are then sent to an output. An output plugin instance can successfully send the full chunk to the destination and mark it as successful, or it can fail the chunk entirely if an unrecoverable error is encountered, or it can ask for the chunk to be retried.
141141

142142
| Metric name | Labels | Description | Type | Unit |
143143
| ----------- | ------ | ----------- | ---- | ---- |
@@ -372,7 +372,7 @@ When querying the related metrics, the aliases are returned instead of the plugi
372372

373373
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=0b83cb05-4f52-4853-83cc-f4539b64044d" />
374374

375-
You can create Grafana dashboards and alerts using Fluent Bit's exposed Prometheus style metrics.
375+
You can create Grafana dashboards and alerts using Fluent Bit exposed Prometheus style metrics.
376376

377377
The provided [example dashboard](https://github.com/fluent/fluent-bit-docs/blob/master/monitoring/dashboard.json) is heavily inspired by [Banzai Cloud](https://github.com/banzaicloud)'s [logging operator dashboard](https://grafana.com/grafana/dashboards/7752) with a few key differences, such as the use of the `instance` label, stacked graphs, and a focus on Fluent Bit metrics. See [this blog post](https://www.robustperception.io/controlling-the-instance-label) for more information.
378378

@@ -384,7 +384,7 @@ Sample alerts [are available](https://github.com/fluent/fluent-bit-docs/blob/mas
384384

385385
## Health check for Fluent Bit
386386

387-
Fluent bit supports the following configurations to set up the health check.
387+
Fluent Bit supports the following configurations to set up the health check.
388388

389389
| Configuration name | Description | Default |
390390
| ---------------------- | ------------| ------------- |
@@ -472,4 +472,6 @@ Health status = (HC_Errors_Count > 5) OR (HC_Retry_Failure_Count > 5) IN 5 secon
472472

473473
## Telemetry Pipeline
474474

475-
[Telemetry Pipeline](https://chronosphere.io/platform/telemetry-pipeline/) is a hosted service that lets you monitor your Fluent Bit agents including data flow, metrics, and configurations.
475+
[Telemetry Pipeline](https://chronosphere.io/platform/telemetry-pipeline/) is a
476+
hosted service that lets you monitor your Fluent Bit agents including data flow,
477+
metrics, and configurations.

vale-styles/FluentBit/Headings.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ exceptions:
7171
- JSON
7272
- Kafka
7373
- Kafka Producer
74-
- Kafka REST
74+
- Kafka
7575
- Kinesis
7676
- KQL
7777
- Kubernetes
@@ -104,6 +104,7 @@ exceptions:
104104
- PromQL
105105
- Raspberry Pi
106106
- REPL
107+
- REST
107108
- ServiceMonitor
108109
- SignalFx
109110
- Slack

0 commit comments

Comments
 (0)