Skip to content

Commit 4313344

Browse files
authored
Merge branch 'master' into erics-azure-outputs-yaml
Signed-off-by: Eric D. Schabell <[email protected]>
2 parents 0e97081 + f419eab commit 4313344

23 files changed

+1376
-943
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Each `.md` file in this repository is a single page. You can use
2828
to edit existing pages, or create a new `.md` file to add an additional page to
2929
the docs library. If you create a new page, you'll also need to update
3030
[GitBook's `SUMMARY.md` file](https://docs.gitbook.com/integrations/git-sync/content-configuration#structure)
31-
(or ask a maintainer to update it for you).
31+
(or request that a maintainer to update it for you).
3232

3333
## Workflow
3434

@@ -39,11 +39,11 @@ within a few minutes.
3939

4040
### Stale pull requests
4141

42-
If you open a pull request that requires ongoing discussion or review, the
43-
Fluent Bit maintainers will add a [`waiting-for-user` tag](#tags) to your pull
44-
request. This tag means that we're blocked from moving forward until you reply.
45-
To keep contributions from going stale, we'll wait 45 days for your response,
46-
but we may close the pull request if we don't hear back from you by then.
42+
If you open a pull request that requires ongoing discussion or review, the Fluent Bit
43+
maintainers will add a `waiting-for-user` to your pull request. This tag means that
44+
we're blocked from moving forward until you reply. To keep contributions from going
45+
stale, we'll wait 45 days for your response, but we may close the pull request if we
46+
don't hear back from you by then.
4747

4848
## Submit a contribution
4949

@@ -55,14 +55,14 @@ create a single PR against `master` and specify that your changes need to be
5555
**backported** to other branches; one of our maintainers will take care of that
5656
process on your behalf.
5757

58-
All contributions must be made **first** against [master branch](https://github.com/fluent/fluent-bit-docs/tree/master) which is the active development branch, and then **if** the contribution also applies for the current stable branch, submit another PR for that specific branch, if submitting another PR adds some complexity, please specify in the first PR as a comment (for master branch) that it needs to be *backported*. One of our maintainers will take care of that process.
58+
All contributions must be made **first** against [master branch](https://github.com/fluent/fluent-bit-docs/tree/master) which is the active development branch, and then if the contribution also applies for the current stable branch, submit another PR for that specific branch, if submitting another PR adds some complexity, specify in the first PR as a comment (for master branch) that it needs to be backported. One of the maintainers will take care of that process.
5959

6060
As a contributor, we'll ask you to follow a few best practices related to Git:
6161

6262
### One file per commit
6363

64-
Each commit you make should only modify one file or interface—we follow the same
65-
practice in the Fluent Bit source code.
64+
Each commit you make should only modify one file or interface, following the same
65+
practice as commits to the Fluent Bit source code.
6666

6767
### Commit subjects
6868

@@ -74,7 +74,7 @@ located at [pipeline/outputs/syslog.md](https://github.com/fluent/fluent-bit-doc
7474

7575
`pipeline: outputs: syslog: fix grammar in examples`
7676

77-
Since this commit is prefixed with the relevant file path, it helps our maintainers
77+
Because this commit is prefixed with the relevant file's path, it helps the maintainers
7878
understand and prioritize your contribution.
7979

8080
### Set your email in Git
@@ -88,7 +88,7 @@ For more information, refer to GitHub's guide to
8888
### Sign off your commits
8989

9090
You must sign off your commits to certify your identity as the commit author. If
91-
you don't sign off your commits, our CI system will flag the pull request with a
91+
you don't sign off your commits, the CI system will flag the pull request with a
9292
[DCO](https://github.com/src-d/guide/blob/master/developer-community/fix-DCO.md)
9393
error and prevent your pull request from merging.
9494

@@ -99,7 +99,7 @@ To prevent DCO errors, refer to the following guide about
9999
>
100100
> `git commit -a -s -m "pipeline: outputs: syslog: fix grammar in examples"`
101101
>
102-
> If you're using VSCode, you can also enable the
102+
> If you're using VSCode, enable the
103103
> [**Git: Always Sign Off**](https://github.com/microsoft/vscode/issues/83096#issuecomment-545350047)
104104
> setting, which automatically appends a `Signed-off-by:` message to your commits.
105105
@@ -109,7 +109,7 @@ The Fluent Bit maintainers refer to the
109109
[Google developer documentation style guide](https://developers.google.com/style)
110110
for most topics related to grammar, style, and formatting. We don't expect you
111111
to memorize these style rules, but the technical writer who reviews your pull
112-
request may suggest changes accordingly.
112+
request can suggest changes accordingly.
113113

114114
### URLs
115115

@@ -120,11 +120,21 @@ possible. For example:
120120
[LTSV](../pipeline/parsers/ltsv.md) and [Logfmt](../pipeline/parsers/logfmt.md)
121121
```
122122

123+
## Additional testing
124+
125+
Fluent Bit uses additional tests for style and consistency. Your maintainers
126+
suggest installing and applying the suggestions from these linters.
127+
123128
### Vale
124129

125130
The Fluent Bit maintainers use the [Vale](https://vale.sh/docs/) plugin, which lints
126-
pull requests and adds suggestions to improve style and clarity. Most Vale tests are
127-
at the `suggestion` level and won't block merging.
131+
the prose of your pull requests and adds suggestions to improve style and clarity.
132+
There is a [VSCode plugin for Vale](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode)
133+
which outputs suggestions to the problems pane in the IDE.
134+
135+
[See the Vale tests for Fluent Bit](https://github.com/fluent/fluent-bit-docs/tree/master/vale-styles).
136+
137+
Most Vale tests are at the `suggestion` level and won't block merging.
128138

129139
The following tests are at a `error` level and will prevent merging:
130140

@@ -151,3 +161,12 @@ The following tests are at a `error` level and will prevent merging:
151161
The following tests are at a `warning` level and won't prevent merging:
152162

153163
- [Ampersand](https://developers.google.com/style/word-list#ampersand)
164+
165+
### Markdownlint
166+
167+
[Markdownlint](https://github.com/markdownlint/markdownlint) checks markdown in a
168+
file and makes suggestions for improvements. Most markdownlint tests are enabled.
169+
[See the configuration file](https://github.com/fluent/fluent-bit-docs/blob/master/.markdownlint.json).
170+
171+
Line wrap tests are off due to a GitBook decision that hard wraps the rendered page
172+
on line wraps in the markdown. This leads to rendered pages with awkward line wraps.

administration/networking.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,12 @@ For example, if you have five workers and `net.max_worker_connections` is set
7171
to 10, a maximum of 50 connections is allowed. If the limit is reached, the output
7272
plugin issues a retry.
7373

74+
### Listener backlog
75+
76+
When Fluent Bit listens for incoming connections (for example, in input plugins like HTTP, TCP, OpenTelemetry, Forward, Syslog, etc.), the operating system maintains a queue of pending connections. The `net.backlog` option controls the maximum number of pending connections that can be queued before new connection attempts are refused. Increasing this value can help Fluent Bit handle bursts of incoming connections more gracefully. The default value is `128`.
77+
78+
> **Note:** On Linux, the effective backlog value may be capped by the kernel parameter `net.core.somaxconn`. If you need to allow a higher number of pending connections, you may need to increase this system setting.
79+
7480
## Configuration options
7581

7682
The following table describes the network configuration properties available and
@@ -89,6 +95,7 @@ that rely on networking I/O:
8995
| `net.keepalive_max_recycle` | Set maximum number of times a keepalive connection can be used before it's retired. | `2000` |
9096
| `net.max_worker_connections` | Set maximum number of TCP connections that can be established per worker. | `0` (unlimited) |
9197
| `net.source_address` | Specify network address to bind for data traffic. | _none_ |
98+
| `net.backlog` | Set the maximum number of pending connections for listening sockets. This option is vailable on versions >= 4.0.4. | `128` |
9299

93100
## Example
94101

0 commit comments

Comments
 (0)