From 11968ad7a4a0586dbea0484907058f69f4aa1838 Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Fri, 9 May 2025 11:07:11 -0700 Subject: [PATCH] Vale: Set Ordinal test to error, fix problems Signed-off-by: Lynette Miles --- CONTRIBUTING.md | 1 + pipeline/filters/throttle.md | 23 +++++++++++---------- pipeline/inputs/process-exporter-metrics.md | 4 ++-- vale-styles/FluentBit/Ordinal.yml | 4 ++-- 4 files changed, 17 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6dec9e840..a2f08a1bc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -140,6 +140,7 @@ The following tests are at a `error` level and will prevent merging: in [Google Docs](https://support.google.com/docs/thread/217182974/can-i-turn-smart-quotes-off-in-a-google-doc?hl=en) or [Microsoft Word](https://support.microsoft.com/en-us/office/smart-quotes-in-word-and-powerpoint-702fc92e-b723-4e3d-b2cc-71dedaf2f343) to prevent this problem. +- [Ordinal](https://developers.google.com/style/numbers) - [Repetition](https://github.com/errata-ai/vale/blob/v3/testdata/styles/Markup/Repetition.yml): Checks for the same word used twice in succession. diff --git a/pipeline/filters/throttle.md b/pipeline/filters/throttle.md index 9c54c256d..d04966421 100644 --- a/pipeline/filters/throttle.md +++ b/pipeline/filters/throttle.md @@ -15,7 +15,7 @@ The plugin supports the following configuration parameters: ## Functional description -Lets imagine we have configured: +Using the following configuration: ```text Rate 5 @@ -23,23 +23,25 @@ Window 5 Interval 1s ``` -we received 1 message first second, 3 messages 2nd, and 5 3rd. As you can see, disregard that Window is actually 5, we use "slow" start to prevent overflooding during the startup. +You would received 1 message in the first second, 3 messages second, and 5 third. +Disregard that Window is actually 5, because the configuration uses `slow` start +to prevent flooding during the startup. ```text -+-------+-+-+-+ -|1|3|5| | | | | -+-------+-+-+-+ -| 3 | average = 3, and not 1.8 if you calculate 0 for last 2 panes. ++-------+-+-+-+ +|1|3|5| | | | | ++-------+-+-+-+ +| 3 | average = 3, and not 1.8 if you calculate 0 for last 2 panes. +-----+ ``` But as soon as we reached Window size \* Interval, we will have true sliding window with aggregation over complete window. ```text -+-------------+ -|1|3|5|7|3|4| | -+-------------+ - | 4.4 | ++-------------+ +|1|3|5|7|3|4| | ++-------------+ + | 4.4 | ----------+ ``` @@ -135,4 +137,3 @@ $ bin/fluent-bit -i tail -p 'path=lines.txt' -F throttle -p 'rate=1' -m '*' -o s ``` The example above will pass 1000 messages per second in average over 300 seconds. - diff --git a/pipeline/inputs/process-exporter-metrics.md b/pipeline/inputs/process-exporter-metrics.md index f74c0996c..e415b6bb7 100644 --- a/pipeline/inputs/process-exporter-metrics.md +++ b/pipeline/inputs/process-exporter-metrics.md @@ -9,7 +9,7 @@ description: >- [Prometheus Node Exporter](https://github.com/prometheus/node_exporter) is a popular way to collect system level metrics from operating systems, such as CPU / Disk / Network / Process statistics. Fluent Bit 2.2 onwards includes a process exporter plugin that builds off the Prometheus design to collect process level metrics without having to manage two separate processes or agents. -The Process Exporter Metrics plugin implements collecting of the various metrics available from [the 3rd party implementation of Prometheus Process Exporter](https://github.com/ncabatoff/process-exporter) and these will be expanded over time as needed. +The Process Exporter Metrics plugin implements collecting of the various metrics available from [the third party implementation of Prometheus Process Exporter](https://github.com/ncabatoff/process-exporter) and these will be expanded over time as needed. **Important note:** All metrics including those collected with this plugin flow through a separate pipeline from logs and current filters do not operate on top of metrics. @@ -103,6 +103,6 @@ docker run -ti -v /proc:/host/proc:ro \ ## Enhancement Requests -Development prioritises a subset of the available collectors in the [the 3rd party implementation of Prometheus Process Exporter](https://github.com/ncabatoff/process-exporter), to request others please open a Github issue by using the following template:\ +Development prioritises a subset of the available collectors in the [the third party implementation of Prometheus Process Exporter](https://github.com/ncabatoff/process-exporter), to request others please open a Github issue by using the following template:\ \ \- [in_process_exporter_metrics](https://github.com/fluent/fluent-bit/issues/new?assignees=\&labels=\&template=feature_request.md\&title=in_process_exporter_metrics:%20add%20ABC%20collector) diff --git a/vale-styles/FluentBit/Ordinal.yml b/vale-styles/FluentBit/Ordinal.yml index cd836d5a5..d1ac7d27e 100644 --- a/vale-styles/FluentBit/Ordinal.yml +++ b/vale-styles/FluentBit/Ordinal.yml @@ -1,7 +1,7 @@ extends: existence message: "Spell out all ordinal numbers ('%s') in text." link: 'https://developers.google.com/style/numbers' -level: suggestion +level: error nonword: true tokens: - - \d+(?:st|nd|rd|th) \ No newline at end of file + - \d+(?:st|nd|rd|th)