Skip to content

Commit 2acfc04

Browse files
Data pipeline: update titles to sentence case + unwrap lines
Signed-off-by: Alexa Kreizinger <[email protected]>
1 parent 13504e7 commit 2acfc04

38 files changed

+202
-253
lines changed

SUMMARY.md

Lines changed: 47 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -90,95 +90,96 @@
9090

9191
## Data Pipeline <a href="#pipeline" id="pipeline"></a>
9292

93-
* [Pipeline Monitoring](pipeline/pipeline-monitoring.md)
93+
* [Pipeline monitoring](pipeline/pipeline-monitoring.md)
9494
* [Inputs](pipeline/inputs/README.md)
9595
* [Collectd](pipeline/inputs/collectd.md)
96-
* [CPU Log Based Metrics](pipeline/inputs/cpu-metrics.md)
97-
* [Disk I/O Log Based Metrics](pipeline/inputs/disk-io-metrics.md)
98-
* [Docker Events](pipeline/inputs/docker-events.md)
99-
* [Docker Log Based Metrics](pipeline/inputs/docker-metrics.md)
96+
* [CPU metrics](pipeline/inputs/cpu-metrics.md)
97+
* [Disk I/O metrics](pipeline/inputs/disk-io-metrics.md)
98+
* [Docker events](pipeline/inputs/docker-events.md)
99+
* [Docker metrics](pipeline/inputs/docker-metrics.md)
100100
* [Dummy](pipeline/inputs/dummy.md)
101+
* [Ebpf](pipeline/inputs/ebpf.md)
101102
* [Elasticsearch](pipeline/inputs/elasticsearch.md)
103+
* [Exec WASI](pipeline/inputs/exec-wasi.md)
102104
* [Exec](pipeline/inputs/exec.md)
103-
* [Exec Wasi](pipeline/inputs/exec-wasi.md)
104-
* [Ebpf](pipeline/inputs/ebpf.md)
105-
* [Fluent Bit Metrics](pipeline/inputs/fluentbit-metrics.md)
105+
* [Fluent Bit metrics](pipeline/inputs/fluentbit-metrics.md)
106106
* [Forward](pipeline/inputs/forward.md)
107107
* [Head](pipeline/inputs/head.md)
108108
* [Health](pipeline/inputs/health.md)
109109
* [HTTP](pipeline/inputs/http.md)
110110
* [Kafka](pipeline/inputs/kafka.md)
111-
* [Kernel Logs](pipeline/inputs/kernel-logs.md)
112-
* [Kubernetes Events](pipeline/inputs/kubernetes-events.md)
113-
* [Memory Metrics](pipeline/inputs/memory-metrics.md)
111+
* [Kernel logs](pipeline/inputs/kernel-logs.md)
112+
* [Kubernetes events](pipeline/inputs/kubernetes-events.md)
113+
* [Memory metrics](pipeline/inputs/memory-metrics.md)
114114
* [MQTT](pipeline/inputs/mqtt.md)
115-
* [Network I/O Log Based Metrics](pipeline/inputs/network-io-metrics.md)
116-
* [NGINX Exporter Metrics](pipeline/inputs/nginx.md)
117-
* [Node Exporter Metrics](pipeline/inputs/node-exporter-metrics.md)
115+
* [Network I/O metrics](pipeline/inputs/network-io-metrics.md)
116+
* [NGINX exporter metrics](pipeline/inputs/nginx.md)
117+
* [Node exporter metrics](pipeline/inputs/node-exporter-metrics.md)
118118
* [OpenTelemetry](pipeline/inputs/opentelemetry.md)
119-
* [Podman Metrics](pipeline/inputs/podman-metrics.md)
120-
* [Process Exporter Metrics](pipeline/inputs/process-exporter-metrics.md)
121-
* [Process Log Based Metrics](pipeline/inputs/process.md)
122-
* [Prometheus Remote Write](pipeline/inputs/prometheus-remote-write.md)
123-
* [Prometheus Scrape Metrics](pipeline/inputs/prometheus-scrape-metrics.md)
119+
* [Podman metrics](pipeline/inputs/podman-metrics.md)
120+
* [Process exporter metrics](pipeline/inputs/process-exporter-metrics.md)
121+
* [Process metrics](pipeline/inputs/process.md)
122+
* [Prometheus remote write](pipeline/inputs/prometheus-remote-write.md)
123+
* [Prometheus scrape Metrics](pipeline/inputs/prometheus-scrape-metrics.md)
124124
* [Random](pipeline/inputs/random.md)
125-
* [Serial Interface](pipeline/inputs/serial-interface.md)
125+
* [Serial interface](pipeline/inputs/serial-interface.md)
126126
* [Splunk](pipeline/inputs/splunk.md)
127-
* [Standard Input](pipeline/inputs/standard-input.md)
127+
* [Standard input](pipeline/inputs/standard-input.md)
128128
* [StatsD](pipeline/inputs/statsd.md)
129129
* [Syslog](pipeline/inputs/syslog.md)
130130
* [Systemd](pipeline/inputs/systemd.md)
131131
* [Tail](pipeline/inputs/tail.md)
132132
* [TCP](pipeline/inputs/tcp.md)
133133
* [Thermal](pipeline/inputs/thermal.md)
134134
* [UDP](pipeline/inputs/udp.md)
135-
* [Windows Event Log](pipeline/inputs/windows-event-log.md)
136-
* [Windows Event Log (winevtlog)](pipeline/inputs/windows-event-log-winevtlog.md)
137-
* [Windows Exporter Metrics](pipeline/inputs/windows-exporter-metrics.md)
135+
* [Windows Event logs (winevtlog)](pipeline/inputs/windows-event-log-winevtlog.md)
136+
* [Windows Event logs (winlog)](pipeline/inputs/windows-event-log.md)
137+
* [Windows exporter metrics](pipeline/inputs/windows-exporter-metrics.md)
138138
* [Parsers](pipeline/parsers/README.md)
139-
* [Configuring Parser](pipeline/parsers/configuring-parser.md)
139+
* [Configuring parsers](pipeline/parsers/configuring-parser.md)
140140
* [JSON](pipeline/parsers/json.md)
141-
* [Regular Expression](pipeline/parsers/regular-expression.md)
141+
* [Regular expression](pipeline/parsers/regular-expression.md)
142142
* [LTSV](pipeline/parsers/ltsv.md)
143143
* [Logfmt](pipeline/parsers/logfmt.md)
144144
* [Decoders](pipeline/parsers/decoders.md)
145145
* [Processors](pipeline/processors/README.md)
146-
* [Content Modifier](pipeline/processors/content-modifier.md)
146+
* [Content modifier](pipeline/processors/content-modifier.md)
147147
* [Labels](pipeline/processors/labels.md)
148-
* [Metrics Selector](pipeline/processors/metrics-selector.md)
149-
* [OpenTelemetry Envelope](pipeline/processors/opentelemetry-envelope.md)
148+
* [Metrics selector](pipeline/processors/metrics-selector.md)
149+
* [OpenTelemetry envelope](pipeline/processors/opentelemetry-envelope.md)
150150
* [Sampling](pipeline/processors/sampling.md)
151151
* [SQL](pipeline/processors/sql.md)
152152
* [Filters as processors](pipeline/processors/filters.md)
153153
* [Conditional processing](pipeline/processors/conditional-processing.md)
154154
* [Filters](pipeline/filters/README.md)
155-
* [AWS Metadata](pipeline/filters/aws-metadata.md)
155+
* [AWS metadata](pipeline/filters/aws-metadata.md)
156156
* [CheckList](pipeline/filters/checklist.md)
157-
* [ECS Metadata](pipeline/filters/ecs-metadata.md)
157+
* [ECS metadata](pipeline/filters/ecs-metadata.md)
158158
* [Expect](pipeline/filters/expect.md)
159-
* [GeoIP2 Filter](pipeline/filters/geoip2-filter.md)
159+
* [GeoIP2 filter](pipeline/filters/geoip2-filter.md)
160160
* [Grep](pipeline/filters/grep.md)
161161
* [Kubernetes](pipeline/filters/kubernetes.md)
162-
* [Log to Metrics](pipeline/filters/log_to_metrics.md)
162+
* [Logs to metrics](pipeline/filters/log_to_metrics.md)
163163
* [Lua](pipeline/filters/lua.md)
164-
* [Parser](pipeline/filters/parser.md)
165-
* [Record Modifier](pipeline/filters/record-modifier.md)
166164
* [Modify](pipeline/filters/modify.md)
167165
* [Multiline](pipeline/filters/multiline-stacktrace.md)
168166
* [Nest](pipeline/filters/nest.md)
169167
* [Nightfall](pipeline/filters/nightfall.md)
170-
* [Rewrite Tag](pipeline/filters/rewrite-tag.md)
171-
* [Standard Output](pipeline/filters/standard-output.md)
168+
* [Parser](pipeline/filters/parser.md)
169+
* [Record modifier](pipeline/filters/record-modifier.md)
170+
* [Rewrite tag](pipeline/filters/rewrite-tag.md)
171+
* [Standard output](pipeline/filters/standard-output.md)
172172
* [Sysinfo](pipeline/filters/sysinfo.md)
173+
* [Tensorflow](pipeline/filters/tensorflow.md)
173174
* [Throttle](pipeline/filters/throttle.md)
174175
* [Type Converter](pipeline/filters/type-converter.md)
175-
* [Tensorflow](pipeline/filters/tensorflow.md)
176176
* [Wasm](pipeline/filters/wasm.md)
177177
* [Outputs](pipeline/outputs/README.md)
178178
* [Amazon CloudWatch](pipeline/outputs/cloudwatch.md)
179179
* [Amazon Kinesis Data Firehose](pipeline/outputs/firehose.md)
180180
* [Amazon Kinesis Data Streams](pipeline/outputs/kinesis.md)
181181
* [Amazon S3](pipeline/outputs/s3.md)
182+
* [Apache SkyWalking](pipeline/outputs/skywalking.md)
182183
* [Azure Blob](pipeline/outputs/azure_blob.md)
183184
* [Azure Data Explorer](pipeline/outputs/azure_kusto.md)
184185
* [Azure Log Analytics](pipeline/outputs/azure.md)
@@ -189,34 +190,32 @@
189190
* [Dynatrace](pipeline/outputs/dynatrace.md)
190191
* [Elasticsearch](pipeline/outputs/elasticsearch.md)
191192
* [File](pipeline/outputs/file.md)
192-
* [FlowCounter](pipeline/outputs/flowcounter.md)
193+
* [Flow counter](pipeline/outputs/flowcounter.md)
193194
* [Forward](pipeline/outputs/forward.md)
194-
* [GELF](pipeline/outputs/gelf.md)
195+
* [Graylog Extended Log Format (GELF)](pipeline/outputs/gelf.md)
195196
* [Google Chronicle](pipeline/outputs/chronicle.md)
196197
* [Google Cloud BigQuery](pipeline/outputs/bigquery.md)
197198
* [HTTP](pipeline/outputs/http.md)
198199
* [InfluxDB](pipeline/outputs/influxdb.md)
199-
* [Kafka](pipeline/outputs/kafka.md)
200+
* [Kafka Producer](pipeline/outputs/kafka.md)
200201
* [Kafka REST Proxy](pipeline/outputs/kafka-rest-proxy.md)
201202
* [LogDNA](pipeline/outputs/logdna.md)
202203
* [Loki](pipeline/outputs/loki.md)
203-
* [Microsoft Fabric](pipeline/outputs/azure_kusto.md)
204204
* [NATS](pipeline/outputs/nats.md)
205205
* [New Relic](pipeline/outputs/new-relic.md)
206-
* [NULL](pipeline/outputs/null.md)
206+
* [Null](pipeline/outputs/null.md)
207207
* [Observe](pipeline/outputs/observe.md)
208208
* [OpenObserve](pipeline/outputs/openobserve.md)
209209
* [OpenSearch](pipeline/outputs/opensearch.md)
210210
* [OpenTelemetry](pipeline/outputs/opentelemetry.md)
211-
* [Oracle Log Analytics](pipeline/outputs/oci-logging-analytics.md)
211+
* [Oracle Cloud Infrastructure Logging Analytics](pipeline/outputs/oci-logging-analytics.md)
212212
* [PostgreSQL](pipeline/outputs/postgresql.md)
213-
* [Prometheus Exporter](pipeline/outputs/prometheus-exporter.md)
214-
* [Prometheus Remote Write](pipeline/outputs/prometheus-remote-write.md)
215-
* [SkyWalking](pipeline/outputs/skywalking.md)
213+
* [Prometheus exporter](pipeline/outputs/prometheus-exporter.md)
214+
* [Prometheus remote write](pipeline/outputs/prometheus-remote-write.md)
216215
* [Slack](pipeline/outputs/slack.md)
217216
* [Splunk](pipeline/outputs/splunk.md)
218217
* [Stackdriver](pipeline/outputs/stackdriver.md)
219-
* [Standard Output](pipeline/outputs/standard-output.md)
218+
* [Standard output](pipeline/outputs/standard-output.md)
220219
* [Syslog](pipeline/outputs/syslog.md)
221220
* [TCP and TLS](pipeline/outputs/tcp-and-tls.md)
222221
* [Treasure Data](pipeline/outputs/treasure-data.md)

pipeline/filters/aws-metadata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AWS Metadata
1+
# AWS metadata
22

33
The _AWS Filter_ enriches logs with AWS Metadata. The plugin adds the EC2 instance ID and availability zone to log records. To use this plugin, you must be running in EC2 and have the [instance metadata service enabled](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html).
44

@@ -188,4 +188,4 @@ The resulting logs might look like this:
188188

189189
```text
190190
{"log"=>"aws is awesome", "az"=>"us-east-1a", "ec2_instance_id"=>"i-0e66fc7f9809d7168", "Name"=>"fluent-bit-docs-example", "project"=>"fluentbit"}
191-
```
191+
```

pipeline/filters/checklist.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ pipeline:
2828
path: test1.log
2929
read_from_head: true
3030
parser: json
31-
31+
3232
filters:
3333
- name: checklist
3434
match: test1
@@ -38,7 +38,7 @@ pipeline:
3838
- ioc abc
3939
- badurl null
4040
log_level: debug
41-
41+
4242
outputs:
4343
- name: stdout
4444
match: test1
@@ -97,4 +97,4 @@ The configuration uses `$remote_addr` as the lookup key, and `7.7.7.7` is malici
9797

9898
```text
9999
{"remote_addr": "7.7.7.7", "ioc":"abc", "url":"https://badurl.com/payload.htm","badurl":"null"}
100-
```
100+
```

pipeline/filters/log_to_metrics.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Generate metrics from logs
33
---
44

5-
# Log to Metrics
5+
# Logs to metrics
66

77
![](https://static.scarf.sh/a.png?x-pxid=768830f6-8d2d-4231-9e5e-259ce6797ba5)
88

@@ -55,25 +55,25 @@ The following example takes records from two `dummy` inputs and counts all messa
5555
service:
5656
flush: 1
5757
log_level: info
58-
58+
5959
pipeline:
6060
inputs:
6161
- name: dummy
6262
dummy: '{"message":"dummy", "kubernetes":{"namespace_name": "default", "docker_id": "abc123", "pod_name": "pod1", "container_name": "mycontainer", "pod_id": "def456", "labels":{"app": "app1"}}, "duration": 20, "color": "red", "shape": "circle"}'
6363
tag: dummy.log
64-
64+
6565
- name: dummy
6666
dummy: '{"message":"hello", "kubernetes":{"namespace_name": "default", "docker_id": "abc123", "pod_name": "pod1", "container_name": "mycontainer", "pod_id": "def456", "labels":{"app": "app1"}}, "duration": 60, "color": "blue", "shape": "square"}'
6767
tag: dummy.log2
68-
68+
6969
filters:
7070
- name: log_to_metrics
7171
match: 'dummy.log*'
7272
tag: test_metric
7373
metric_mode: counter
7474
metric_name: count_all_dummy_messages
7575
metric_description: 'This metric counts dummy messages'
76-
76+
7777
outputs:
7878
- name: prometheus_exporter
7979
match: '*'
@@ -157,17 +157,17 @@ The `gauge` mode needs a `value_field` to specify where to generate the metric v
157157
service:
158158
flush: 1
159159
log_level: info
160-
160+
161161
pipeline:
162162
inputs:
163163
- name: dummy
164164
dummy: '{"message":"dummy", "kubernetes":{"namespace_name": "default", "docker_id": "abc123", "pod_name": "pod1", "container_name": "mycontainer", "pod_id": "def456", "labels":{"app": "app1"}}, "duration": 20, "color": "red", "shape": "circle"}'
165165
tag: dummy.log
166-
166+
167167
- name: dummy
168168
dummy: '{"message":"hello", "kubernetes":{"namespace_name": "default", "docker_id": "abc123", "pod_name": "pod1", "container_name": "mycontainer", "pod_id": "def456", "labels":{"app": "app1"}}, "duration": 60, "color": "blue", "shape": "square"}'
169169
tag: dummy.log2
170-
170+
171171
filters:
172172
- name: log_to_metrics
173173
match: 'dummy.log*'
@@ -179,10 +179,10 @@ pipeline:
179179
kubernetes_mode: on
180180
regex: 'message .*el.*'
181181
add_label: app $kubernetes['labels']['app']
182-
label_field:
182+
label_field:
183183
- color
184184
- shape
185-
185+
186186
outputs:
187187
- name: prometheus_exporter
188188
match: '*'
@@ -221,7 +221,7 @@ pipeline:
221221
add_label app $kubernetes['labels']['app']
222222
label_field color
223223
label_field shape
224-
224+
225225
[OUTPUT]
226226
name prometheus_exporter
227227
match *
@@ -269,7 +269,7 @@ If you execute the example curl command multiple times, the example metric value
269269

270270
#### Metric `label_values`
271271

272-
The label sets defined by `add_label` and `label_field` are added to the metric. The lines in the metric represent every combination of labels. Only combinations that are actually used are displayed here.
272+
The label sets defined by `add_label` and `label_field` are added to the metric. The lines in the metric represent every combination of labels. Only combinations that are actually used are displayed here.
273273

274274
### Histogram
275275

@@ -282,17 +282,17 @@ Similar to the `gauge` mode, the `histogram` mode needs a `value_field` to speci
282282
service:
283283
flush: 1
284284
log_level: info
285-
285+
286286
pipeline:
287287
inputs:
288288
- name: dummy
289289
dummy: '{"message":"dummy", "kubernetes":{"namespace_name": "default", "docker_id": "abc123", "pod_name": "pod1", "container_name": "mycontainer", "pod_id": "def456", "labels":{"app": "app1"}}, "duration": 20, "color": "red", "shape": "circle"}'
290290
tag: dummy.log
291-
291+
292292
- name: dummy
293293
dummy: '{"message":"hello", "kubernetes":{"namespace_name": "default", "docker_id": "abc123", "pod_name": "pod1", "container_name": "mycontainer", "pod_id": "def456", "labels":{"app": "app1"}}, "duration": 60, "color": "blue", "shape": "square"}'
294294
tag: dummy.log2
295-
295+
296296
filters:
297297
- name: log_to_metrics
298298
match: 'dummy.log*'
@@ -307,7 +307,7 @@ pipeline:
307307
label_field:
308308
- color
309309
- shape
310-
310+
311311
outputs:
312312
- name: prometheus_exporter
313313
match: '*'
@@ -346,7 +346,7 @@ pipeline:
346346
add_label app $kubernetes['labels']['app']
347347
label_field color
348348
label_field shape
349-
349+
350350
[OUTPUT]
351351
name prometheus_exporter
352352
match *
@@ -422,17 +422,17 @@ In the resulting output, there are several buckets by default: `0.005, 0.01, 0.0
422422
service:
423423
flush: 1
424424
log_level: info
425-
425+
426426
pipeline:
427427
inputs:
428428
- name: dummy
429429
dummy: '{"message":"dummy", "kubernetes":{"namespace_name": "default", "docker_id": "abc123", "pod_name": "pod1", "container_name": "mycontainer", "pod_id": "def456", "labels":{"app": "app1"}}, "duration": 20, "color": "red", "shape": "circle"}'
430430
tag: dummy.log
431-
431+
432432
- name: dummy
433433
dummy: '{"message":"hello", "kubernetes":{"namespace_name": "default", "docker_id": "abc123", "pod_name": "pod1", "container_name": "mycontainer", "pod_id": "def456", "labels":{"app": "app1"}}, "duration": 60, "color": "blue", "shape": "square"}'
434434
tag: dummy.log2
435-
435+
436436
filters:
437437
- name: log_to_metrics
438438
match: 'dummy.log*'
@@ -455,7 +455,7 @@ pipeline:
455455
label_field:
456456
- color
457457
- shape
458-
458+
459459
outputs:
460460
- name: prometheus_exporter
461461
match: '*'
@@ -501,7 +501,7 @@ pipeline:
501501
regex message .*el.*
502502
label_field color
503503
label_field shape
504-
504+
505505
[OUTPUT]
506506
name prometheus_exporter
507507
match *
@@ -536,4 +536,4 @@ The `+Inf` bucket will always be included regardless of the buckets you specify.
536536

537537
{% endhint %}
538538

539-
This filter also attaches Kubernetes labels to each metric, identical to the behavior of `label_field`. This results in two sets for the histogram.
539+
This filter also attaches Kubernetes labels to each metric, identical to the behavior of `label_field`. This results in two sets for the histogram.

0 commit comments

Comments
 (0)