Skip to content

Commit 4fc61e1

Browse files
committed
Updates: Reviewed the language and grammar changes.
Signed-off-by: Azeem Sajid <azeem.sajid@gmail.com>
1 parent ebe77db commit 4fc61e1

File tree

138 files changed

+1397
-1334
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

138 files changed

+1397
-1334
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
![](.gitbook/assets/images/logo_documentation_1.0.png)
44

5-
[Fluentd](https://www.fluentd.org/) is an open-source data collector for unified
6-
logging layer. Fluentd allows you to unify data collection and consumption for a
7-
better use and understanding of data.
5+
[Fluentd](https://www.fluentd.org/) is an open-source data collector for a
6+
unified logging layer. Fluentd allows you to unify data collection and
7+
consumption for better use and understanding of data.
88

99
[Fluentd](https://www.fluentd.org/) is licensed under the terms of the
1010
[Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0). This project

configuration/buffer-section.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ of events. The buffering is handled by the Fluentd core.
66

77
## Buffer Section Overview
88

9-
Buffer section comes under `<match>` section. It is enabled for those output
9+
Buffer section comes under the `<match>` section. It is enabled for those output
1010
plugins that support buffered output features.
1111

1212
```
@@ -42,7 +42,7 @@ Third-party plugins may also be installed and configured.
4242

4343
However, the `@type` parameter is not mandatory. If omitted, by default, the
4444
buffer plugin specified by the output plugin is used (if possible). Otherwise,
45-
`memory` buffer plugin is used.
45+
the `memory` buffer plugin is used.
4646

4747
For the usual workload, the file buffer plugin is recommended. It is more
4848
durable for the general use-cases.
@@ -130,7 +130,7 @@ For example:
130130
"13:59:59"]`, ...
131131

132132
The events will be grouped into chunks by their time range. They will be flushed
133-
by the output plugin after expiration of the time key range.
133+
by the output plugin after the expiration of the time key range.
134134

135135
```
136136
<match tag.**>
@@ -324,8 +324,8 @@ Same with chunk keys:
324324

325325
### Argument
326326

327-
Argument is an array of chunk keys that must be a list of comma-separated
328-
strings. It can also be left as blank.
327+
It is an array of chunk keys that must be a list of comma-separated strings. It
328+
can also be left blank.
329329

330330
```
331331
<buffer> # blank

configuration/config-file.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Sending a `SIGHUP` signal will reload the config file.
4040

4141
### Docker
4242

43-
For a Docker container, the default location of config file is
43+
For a Docker container, the default location of the config file is
4444
`/fluentd/etc/fluent.conf`. To mount a config file from outside of Docker, use a
4545
`bind-mount`.
4646

@@ -71,7 +71,7 @@ The configuration file consists of the following directives:
7171
1. **`source`** directives determine the input sources
7272
2. **`match`** directives determine the output destinations
7373
3. **`filter`** directives determine the event processing pipelines
74-
4. **`system`** directives set system wide configuration
74+
4. **`system`** directives set system-wide configuration
7575
5. **`label`** directives group the output and filter for internal routing
7676
6. **`@include`** directives include other files
7777

@@ -115,7 +115,7 @@ and it must be in the Unix time format. The `record` is a JSON object.
115115

116116
Fluentd accepts all non-period characters as a part of a `tag`. However, since
117117
the `tag` is sometimes used in a different context by output destinations (e.g.
118-
table name, database name, key name, etc.), **it is strongly recommended that
118+
the table name, database name, key name, etc.), **it is strongly recommended that
119119
you stick to the lower-case alphabets, digits and underscore** (e.g.
120120
`^[a-z0-9_]+$`).
121121

@@ -173,7 +173,7 @@ destination (in the above example, only the events with the tag `myapp.access`
173173
are matched. See [the section below for more advanced usage](#how-match-patterns-work)).
174174
The `@type` parameter specifies the output plugin to use.
175175

176-
Just like input sources, you can add new output destinations by writing your own
176+
Just like input sources, you can add new output destinations by writing custom
177177
plugins. For further information regarding Fluentd output destinations, please
178178
refer to the [Output Plugin Overview](/plugins/output/README.md) article.
179179

@@ -219,9 +219,9 @@ information regarding Fluentd filter destinations, please refer to the
219219
[Filter Plugin Overview](/plugins/filter/README.md) article.
220220

221221

222-
## 4. Set system wide configuration: the "system" directive
222+
## 4. Set system-wide configuration: the `system` directive
223223

224-
System-wide configurations are set by **system** directive. Most of them are
224+
System-wide configurations are set by `system` directive. Most of them are
225225
also available via command line options. For example, the following
226226
configurations are available:
227227

@@ -316,7 +316,8 @@ In this configuration, `forward` events are routed to `record_transformer`
316316
filter / `elasticsearch` output and `in_tail` events are routed to `grep` filter
317317
/ `s3` output inside `@SYSTEM` label.
318318

319-
The `label` parameter is useful for event flow separation without `tag` prefix.
319+
The `label` parameter is useful for event flow separation without the `tag`
320+
prefix.
320321

321322

322323
### `@ERROR` label
@@ -325,10 +326,10 @@ The `@ERROR` label is a builtin label used for error record emitted by plugin's
325326
`emit_error_event` API.
326327

327328
If `<label @ERROR>` is set, the events are routed to this label when the related
328-
errors are emitted e.g. buffer is full or invalid record.
329+
errors are emitted e.g. the buffer is full or the record is invalid.
329330

330331

331-
## 6. Reuse your config: the "@include" directive
332+
## 6. Reuse your config: the `@include` directive
332333

333334
The directives in separate configuration files can be imported using the
334335
**@include** directive:
@@ -537,7 +538,7 @@ defined as follows:
537538
- `<INTEGER>m` or `<INTEGER>M`: number of megabytes
538539
- `<INTEGER>g` or `<INTEGER>G`: number of gigabytes
539540
- `<INTEGER>t` or `<INTEGER>T`: number of terabytes
540-
- Otherwise, the field is parsed as integer, and that integer is the
541+
- Otherwise, the field is parsed as an integer, and that integer is the
541542
**number of bytes**.
542543
- `time`: the field is parsed as a time duration.
543544
- `<INTEGER>s`: seconds
@@ -548,11 +549,11 @@ defined as follows:
548549
**number of seconds**. This option is useful for specifying sub-second
549550
time durations such as 0.1 (0.1 second = 100 milliseconds).
550551
- `array`: the field is parsed as a JSON array. It also supports the shorthand
551-
syntax. These are same values:
552+
syntax. These are the same values:
552553
- normal: `["key1", "key2"]`
553554
- shorthand: `key1,key2`
554555
- `hash`: the field is parsed as a JSON object. It also supports the shorthand
555-
syntax. These are same values:
556+
syntax. These are the same values:
556557
- normal: `{"key1": "value1", "key2": "value2"}`
557558
- shorthand: `key1:value1,key2:value2`
558559

@@ -654,7 +655,7 @@ host_param "#{hostname}" # This is same with Socket.gethostname
654655
```
655656

656657
The `worker_id` shortcut is useful under multiple workers. For example, for a
657-
separate plugin id, add `worker_id` to store path in s3 to avoid file conflict.
658+
separate plugin id, add `worker_id` to store the path in s3 to avoid file conflict.
658659

659660
Since v1.8.0, helper methods `use_nil` and `use_default` are available:
660661

@@ -674,7 +675,7 @@ The `config-xxx` mixins use `"${}"`, not `"#{}"`. These embedded configurations
674675
are two different things.
675676

676677

677-
### In double quoted string literal, `\` is escape character
678+
### In double-quoted string literal, `\` is the escape character
678679

679680
The forward slash `\` is interpreted as an escape character. You need `\` for
680681
setting `"`, `\r`, `\n`, `\t`, `\` or several characters in double-quoted string

configuration/parse-section.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Here's the list of built-in parser plugins:
7070
The default value of the following parameters will be overridden by the
7171
individual parser plugins:
7272

73-
- **`types`** (hash) (optional): Specify types for converting field into other
73+
- **`types`** (hash) (optional): Specify types for converting field into another
7474
type. See below "The detail of types parameter" section.
7575
- Default: `nil`
7676
- string-based hash: `field1:type, field2:type, field3:type:option,
@@ -103,15 +103,15 @@ individual parser plugins:
103103

104104
#### `types` Parameter
105105

106-
For `types` parameter, the following types are supported:
106+
For the `types` parameter, the following types are supported:
107107

108108
- `string`: Converts the field into `String` type. This uses `to_s` method for
109109
conversion.
110110

111111
- `bool`: Converts the string `"true"`, `"yes"` or `"1"` into `true`. Otherwise,
112112
`false`.
113113

114-
- `integer` (not `int`): Converts the field into `Integer` type. This uses
114+
- `integer` (not `int`): Converts the field into the `Integer` type. This uses
115115
`to_i` method for conversion. For example, the string `"1000"` converts into
116116
`1000`.
117117

configuration/plugin-common-parameters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ set of the `<filter>` and `<match>` subsections under `<label>`.
104104
</label>
105105
```
106106

107-
NOTE: The values for `@label` parameter MUST start with `@` character.
107+
NOTE: The values for the `@label` parameter MUST start with `@` character.
108108

109109
Specifying `@label` is strongly recommended to route events to any plugin
110110
without modifying the tags. It helps make the complex configuration modular and

configuration/routing-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Label reduces complex `tag` handling by separating data pipelines.
9292
## Reroute Event by Tag
9393

9494
Use [fluent-plugin-route](https://github.com/tagomoris/fluent-plugin-route)
95-
plugin. This plugin rewrites `tag` and re-emit events to other match or Label.
95+
plugin. This plugin rewrites `tag` and re-emit events to other `match` or Label.
9696

9797
```
9898
<match worker.**>

configuration/service_discovery-section.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Service Discovery Section Configurations
22

3-
Some of Fluentd plugins support the `<service_discovery>` section to set the
3+
Some of the Fluentd plugins support the `<service_discovery>` section to set the
44
target nodes dynamically.
55

66
## Service Discovery Section Overview
@@ -40,7 +40,7 @@ For more details, see plugins documentation.
4040

4141
### `@type`
4242

43-
The `@type` parameter specifies the type of the service discovery plugin.
43+
The `@type` parameter specifies the type of service discovery plugin.
4444

4545
```
4646
<service_discovery>

configuration/transport-section.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ sections. It specifies the transport protocol, version, and certificates.
5050
- Default: `false` (uses secure connection with `tls`)
5151

5252
If you want to accept multiple TLS protocols, use `min_version`/`max_version`
53-
instead of `version`. To support old style, fluentd accepts `TLS1_1` and
53+
instead of `version`. To support the old style, fluentd accepts `TLS1_1` and
5454
`TLSv1_1` values.
5555

5656
NOTE: `TLS1_3` is available when your system supports TLS 1.3.

container-deployment/docker-compose.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ services:
8686

8787
The `logging` section (check [Docker Compose documentation](https://docs.docker.com/compose/compose-file/#/logging))
8888
of `web` container specifies [Docker Fluentd Logging Driver](https://docs.docker.com/engine/admin/logging/fluentd/)
89-
as a default container logging driver. All the logs from `web` container will
89+
as a default container logging driver. All the logs from the `web` container will
9090
automatically be forwarded to `host:port` specified by `fluentd-address`.
9191

9292

@@ -96,7 +96,7 @@ Create `fluentd/Dockerfile` with the following content using the Fluentd
9696
[official Docker image](https://hub.docker.com/r/fluent/fluentd/); and then,
9797
install the Elasticsearch plugin:
9898

99-
``` {.CodeRay}
99+
```
100100
# fluentd/Dockerfile
101101
102102
FROM fluent/fluentd:v1.6-debian-1
@@ -110,7 +110,7 @@ Then, create the Fluentd configuration file `fluentd/conf/fluent.conf`. The
110110
Docker logging driver and `elasticsearch` output plugin forwards these logs to
111111
Elasticsearch.
112112

113-
``` {.CodeRay}
113+
```
114114
# fluentd/conf/fluent.conf
115115
116116
<source>
@@ -190,7 +190,7 @@ Specify `fluentd-*` to `Index name or pattern` and click `Create`.
190190
Timestamp](/images/7.2_efk-kibana-timestamp.png)
191191

192192
Then, go to `Discover` tab to check the logs. As you can see, logs are properly
193-
collected into Elasticsearch + Kibana, via Fluentd.
193+
collected into the Elasticsearch + Kibana, via Fluentd.
194194

195195
![Kibana Discover](/images/7.2_efk-kibana-discover.png)
196196

container-deployment/docker-logging-driver.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ over the registers, or on the other hand, if the application has multiple
1010
instances running, the scenario becomes even more complex.
1111

1212
On Docker v1.6, the concept of **[logging drivers](https://docs.docker.com/engine/admin/logging/overview/)**
13-
was introduced. Basically, the Docker engine is aware about the output
14-
interfaces that manage the application messages.
13+
was introduced. The Docker engine is aware of the output interfaces that manage
14+
the application messages.
1515

1616
![Fluentd Docker](https://www.fluentd.org/assets/img/recipes/fluentd_docker.png)
1717

@@ -20,7 +20,7 @@ For Docker v1.8, we have implemented a native
2020
Now, you are able to have a unified and structured logging system with the
2121
simplicity and high performance of [Fluentd](http://fluentd.org).
2222

23-
NOTE: Currently, Fluentd logging driver doesn't support sub-second precision.
23+
NOTE: Currently, the Fluentd logging driver doesn't support sub-second precision.
2424

2525

2626
## Getting Started
@@ -129,8 +129,8 @@ information from the source container along with the message.
129129

130130
### Additional Step 1: Parse Log Message
131131

132-
Application log is stored in the `"log"` field in the record. You can parse this
133-
log before sending it to the destinations by using
132+
The application log is stored in the `"log"` field in the record. You can parse
133+
this log before sending it to the destinations by using
134134
[`filter_parser`](/plugins/filter/parser.md).
135135

136136
``` {.CodeRay}
@@ -159,8 +159,8 @@ Filtered Event:
159159

160160
### Additional Step 2: Concatenate Multiple Lines Log Messages
161161

162-
Application log is stored in the `log` field of the record. You can concatenate
163-
these logs by using
162+
The application log is stored in the `log` field of the record. You can
163+
concatenate these logs by using
164164
[`fluent-plugin-concat`](https://github.com/fluent-plugins-nursery/fluent-plugin-concat)
165165
filter before sending it to the destinations.
166166

@@ -184,7 +184,7 @@ Original Events:
184184

185185
Filtered Events:
186186

187-
``` {.CodeRay}
187+
```
188188
2016-04-13 14:45:55 +0900 docker.28cf38e21204: {"container_id":"28cf38e212042225f5f80a56fac08f34c8f0b235e738900c4e0abcf39253a702","container_name":"/romantic_dubinsky","source":"stdout","log":"-e:2:in `/'\n-e:2:in `do_division_by_zero'\n-e:4:in `<main>'"}
189189
```
190190

@@ -197,7 +197,7 @@ plugin instead.
197197

198198
The [Fluentd Logging
199199
Driver](https://docs.docker.com/engine/admin/logging/fluentd/) supports
200-
following options through the `--log-opt` Docker command line argument:
200+
following options through the `--log-opt` Docker command-line argument:
201201

202202
- `fluentd-address`
203203
- `tag`
@@ -229,7 +229,7 @@ $ docker run --log-driver=fluentd --log-opt tag=docker.my_new_tag ubuntu echo ".
229229
Additionally, this option allows to specify some internal variables such as
230230
`{{.ID}}`, `{{.FullID}}` or `{{.Name}}` like this:
231231

232-
``` {.CodeRay}
232+
```
233233
$ docker run --log-driver=fluentd --log-opt tag=docker.{{.ID}} ubuntu echo "..."
234234
```
235235

@@ -238,7 +238,7 @@ $ docker run --log-driver=fluentd --log-opt tag=docker.{{.ID}} ubuntu echo "..."
238238

239239
For a real-world use-case, you would want to use something other than the
240240
Fluentd standard output to store Docker container messages, such as
241-
Elasticsearch, MongoDB, HDFS, S3, Google Cloud Storage and so on.
241+
Elasticsearch, MongoDB, HDFS, S3, Google Cloud Storage, and so on.
242242

243243
This document describes how to set up a multi-container logging environment via
244244
EFK (Elasticsearch, Fluentd, Kibana) with Docker Compose.

0 commit comments

Comments
 (0)