From 9baa7d6a043f919a4458f49dea006424172aba3a Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Thu, 24 Jul 2025 10:10:57 -0700 Subject: [PATCH 1/4] Vale: endpoint, not end points Signed-off-by: Lynette Miles --- vale-styles/FluentBit/Endpoint.yml | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 vale-styles/FluentBit/Endpoint.yml diff --git a/vale-styles/FluentBit/Endpoint.yml b/vale-styles/FluentBit/Endpoint.yml new file mode 100644 index 000000000..408a72f6c --- /dev/null +++ b/vale-styles/FluentBit/Endpoint.yml @@ -0,0 +1,8 @@ +extends: substitution +message: "'%s' is not the preferred term; use 'endpoint' instead." +level: error +ignorecase: true +swap: + "end point": "endpoint" + end-point: "endpoint" + end-points: "endpoints" From 2b09b21471e2ad823659cf1c63968832e2c210d8 Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Tue, 19 Aug 2025 14:27:18 -0700 Subject: [PATCH 2/4] Standardize wording for endpoint Signed-off-by: Lynette Miles --- pipeline/filters/kubernetes.md | 8 +++++--- pipeline/inputs/windows-exporter-metrics.md | 10 +++++----- pipeline/outputs/prometheus-exporter.md | 4 ++-- pipeline/outputs/stackdriver.md | 2 +- vale-styles/FluentBit/Endpoint.yml | 9 +++++---- 5 files changed, 18 insertions(+), 15 deletions(-) diff --git a/pipeline/filters/kubernetes.md b/pipeline/filters/kubernetes.md index 845b0a994..bf8b52263 100644 --- a/pipeline/filters/kubernetes.md +++ b/pipeline/filters/kubernetes.md @@ -26,7 +26,7 @@ The plugin supports the following configuration parameters: | Key | Description | Default | | :--- | :--- | :--- | | `Buffer_Size` | Set the buffer size for HTTP client when reading responses from Kubernetes API server. The value must conform to the [unit size](../../administration/configuring-fluent-bit/unit-sizes.md) specification. A value of `0` results in no limit, and the buffer will expand as-needed. If pod specifications exceed the buffer limit, the API response is discarded when retrieving metadata, and some Kubernetes metadata will fail to be injected to the logs. | `32k` | -| `Kube_URL` | API Server end-point | [https://kubernetes.default.svc:443](https://kubernetes.default.svc:443) | +| `Kube_URL` | API Server endpoint | [https://kubernetes.default.svc:443](https://kubernetes.default.svc:443) | | `Kube_CA_File` | CA certificate file | `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt` | | `Kube_CA_Path` | Absolute path to scan for certificate files | _none_ | | `Kube_Token_File` | Token file | `/var/run/secrets/kubernetes.io/serviceaccount/token` | @@ -304,7 +304,7 @@ parsers: - name: custom-tag format: regex regex: '^(?[^_]+)\.(?[a-z0-9](?:[-a-z0-9]*[a-z0-9])?(?:\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)\.(?.+)\.(?[a-z0-9]{64})' - + pipeline: inputs: - name: tail @@ -590,4 +590,6 @@ Learn how to solve them to ensure that the Fluent Bit Kubernetes filter is opera ## Credit -The Kubernetes Filter plugin is fully inspired by the [Fluentd Kubernetes Metadata Filter](https://github.com/fabric8io/fluent-plugin-kubernetes_metadata_filter) written by [Jimmi Dyson](https://github.com/jimmidyson). \ No newline at end of file +The Kubernetes Filter plugin is fully inspired by the [Fluentd Kubernetes Metadata +Filter](https://github.com/fabric8io/fluent-plugin-kubernetes_metadata_filter) +written by [Jimmi Dyson](https://github.com/jimmidyson). diff --git a/pipeline/inputs/windows-exporter-metrics.md b/pipeline/inputs/windows-exporter-metrics.md index b3eb6b873..7828b3ec3 100644 --- a/pipeline/inputs/windows-exporter-metrics.md +++ b/pipeline/inputs/windows-exporter-metrics.md @@ -77,7 +77,7 @@ In the following configuration file, the input plugin `windows_exporter_metrics` # Node Exporter Metrics + Prometheus Exporter # ------------------------------------------- # The following example collect host metrics on Linux and expose -# them through a Prometheus HTTP end-point. +# them through a Prometheus HTTP endpoint. # # After starting the service try it with: # @@ -86,13 +86,13 @@ In the following configuration file, the input plugin `windows_exporter_metrics` service: flush: 1 log_level: info - + pipeline: inputs: - name: windows_exporter_metrics tag: node_metrics scrape_interval: 2 - + outputs: - name: prometheus_exporter match: node_metrics @@ -106,7 +106,7 @@ pipeline: # Node Exporter Metrics + Prometheus Exporter # ------------------------------------------- # The following example collect host metrics on Linux and expose -# them through a Prometheus HTTP end-point. +# them through a Prometheus HTTP endpoint. # # After starting the service try it with: # @@ -239,4 +239,4 @@ The WMI query will be called with the translated parameter as: The plugin implements a subset of the available collectors in the original Prometheus Windows Exporter. If you would like a specific collector prioritized, open a GitHub issue by using the following template: -- [`in_windows_exporter_metrics`](https://github.com/fluent/fluent-bit/issues/new?assignees=\&labels=\&template=feature_request.md\&title=in_windows_exporter_metrics:%20add%20ABC%20collector) \ No newline at end of file +- [`in_windows_exporter_metrics`](https://github.com/fluent/fluent-bit/issues/new?assignees=\&labels=\&template=feature_request.md\&title=in_windows_exporter_metrics:%20add%20ABC%20collector) diff --git a/pipeline/outputs/prometheus-exporter.md b/pipeline/outputs/prometheus-exporter.md index e66a39b6a..40b8361b9 100644 --- a/pipeline/outputs/prometheus-exporter.md +++ b/pipeline/outputs/prometheus-exporter.md @@ -31,7 +31,7 @@ The Prometheus exporter works only with metrics captured from metric plugins. In # Node Exporter Metrics + Prometheus Exporter # ------------------------------------------- # The following example collect host metrics on Linux and expose -# them through a Prometheus HTTP end-point. +# them through a Prometheus HTTP endpoint. # # After starting the service try it with: # @@ -65,7 +65,7 @@ pipeline: # Node Exporter Metrics + Prometheus Exporter # ------------------------------------------- # The following example collect host metrics on Linux and expose -# them through a Prometheus HTTP end-point. +# them through a Prometheus HTTP endpoint. # # After starting the service try it with: # diff --git a/pipeline/outputs/stackdriver.md b/pipeline/outputs/stackdriver.md index 20a070f97..03ac24dda 100644 --- a/pipeline/outputs/stackdriver.md +++ b/pipeline/outputs/stackdriver.md @@ -267,7 +267,7 @@ An upstream connection error means Fluent Bit wasn't able to reach Google servic [2019/01/07 23:24:09] [error] [oauth2] could not get an upstream connection ``` -This is due to a network issue in the environment where Fluent Bit is running. Make sure that the Host, Container or Pod can reach the following Google end-points: +This is due to a network issue in the environment where Fluent Bit is running. Make sure that the Host, Container or Pod can reach the following Google endpoints: - [https://www.googleapis.com](https://www.googleapis.com) - [https://logging.googleapis.com](https://logging.googleapis.com) diff --git a/vale-styles/FluentBit/Endpoint.yml b/vale-styles/FluentBit/Endpoint.yml index 408a72f6c..69d4da40f 100644 --- a/vale-styles/FluentBit/Endpoint.yml +++ b/vale-styles/FluentBit/Endpoint.yml @@ -1,8 +1,9 @@ extends: substitution -message: "'%s' is not the preferred term; use 'endpoint' instead." +message: 'Use "%s" instead of "%s".' level: error ignorecase: true swap: - "end point": "endpoint" - end-point: "endpoint" - end-points: "endpoints" + end point: endpoint + end-point: endpoint + end points: endpoints + end-points: endpoints From 5d1c10541646aab3d8266966ef3ed77f8506aa92 Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Tue, 19 Aug 2025 16:14:11 -0700 Subject: [PATCH 3/4] Fixing an error Signed-off-by: Lynette Miles --- pipeline/inputs/fluentbit-metrics.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pipeline/inputs/fluentbit-metrics.md b/pipeline/inputs/fluentbit-metrics.md index 4424780c1..d64b80980 100644 --- a/pipeline/inputs/fluentbit-metrics.md +++ b/pipeline/inputs/fluentbit-metrics.md @@ -33,7 +33,7 @@ In the following configuration file, the input plugin `node_exporter_metrics` co service: flush: 1 log_level: info - + pipeline: inputs: - name: fluentbit_metrics @@ -54,7 +54,7 @@ pipeline: # Fluent Bit Metrics + Prometheus Exporter # ------------------------------------------- # The following example collects Fluent Bit metrics and exposes -# them through a Prometheus HTTP end-point. +# them through a Prometheus HTTP endpoint. # # After starting the service try it with: # @@ -83,4 +83,4 @@ You can test the expose of the metrics by using `curl`: ```shell curl http://127.0.0.1:2021/metrics -``` \ No newline at end of file +``` From 22f1f6be8e5ae3cdf5cf3d1a50619aec64f87cf7 Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Tue, 19 Aug 2025 16:16:58 -0700 Subject: [PATCH 4/4] Fix merge conflict Signed-off-by: Lynette Miles --- pipeline/inputs/node-exporter-metrics.md | 2 +- pipeline/inputs/process-exporter-metrics.md | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/pipeline/inputs/node-exporter-metrics.md b/pipeline/inputs/node-exporter-metrics.md index d4d122162..25158c97e 100644 --- a/pipeline/inputs/node-exporter-metrics.md +++ b/pipeline/inputs/node-exporter-metrics.md @@ -100,7 +100,7 @@ In the following configuration file, the input plugin `node_exporter_metrics` co # Node Exporter Metrics + Prometheus Exporter # ------------------------------------------- # The following example collect host metrics on Linux and expose -# them through a Prometheus HTTP end-point. +# them through a Prometheus HTTP endpoint. # # After starting the service try it with: # diff --git a/pipeline/inputs/process-exporter-metrics.md b/pipeline/inputs/process-exporter-metrics.md index a6f15fd9b..bbb5de1e2 100644 --- a/pipeline/inputs/process-exporter-metrics.md +++ b/pipeline/inputs/process-exporter-metrics.md @@ -14,7 +14,6 @@ The Process Exporter Metrics plugin implements collecting of the various metrics {% hint style="info" %} All metrics including those collected with this plugin flow through a separate pipeline from logs and current filters don't operate on top of metrics. This plugin is only supported on Linux based operating systems as it uses the `proc` filesystem to access the relevant metrics. MacOS doesn't have the `proc` filesystem so this plugin won't work for it. - {% endhint %} ## Configuration @@ -58,7 +57,7 @@ In the following configuration file, the input plugin `process_exporter_metrics` # Process Exporter Metrics + Prometheus Exporter # ------------------------------------------- # The following example collect host metrics on Linux and expose -# them through a Prometheus HTTP end-point. +# them through a Prometheus HTTP endpoint. # # After starting the service try it with: # @@ -88,7 +87,7 @@ pipeline: # Process Exporter Metrics + Prometheus Exporter # ------------------------------------------- # The following example collect host metrics on Linux and expose -# them through a Prometheus HTTP end-point. +# them through a Prometheus HTTP endpoint. # # After starting the service try it with: #