Skip to content

Commit ac2fc46

Browse files
authored
Merge pull request #1499 from fluent/lynettemiles/sc-105735/update-administration-hot-reload-md-fluent
2 parents 768697a + 65c83f4 commit ac2fc46

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

administration/hot-reload.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,19 @@
22
description: Enable hot reload through SIGHUP signal or an HTTP endpoint
33
---
44

5-
# Hot Reload
5+
# Hot reload
66

7-
Fluent Bit supports the hot reloading feature when enabled via the configuration file or command line with `-Y` or `--enable-hot-reload` option.
7+
Fluent Bit supports the reloading feature when enabled in the configuration file
8+
or on the command line with `-Y` or `--enable-hot-reload` option.
89

9-
## Getting Started
10+
Hot reloading is supported on Linux, macOS, and Windows operating systems.
1011

11-
To get started with reloading via HTTP, the first step is to enable the HTTP Server from the configuration file:
12+
## Update the configuration
1213

13-
```toml
14+
To get started with reloading over HTTP, enable the HTTP Server
15+
in the configuration file:
16+
17+
```text
1418
[SERVICE]
1519
HTTP_Server On
1620
HTTP_Listen 0.0.0.0
@@ -19,47 +23,44 @@ To get started with reloading via HTTP, the first step is to enable the HTTP Ser
1923
...
2024
```
2125

22-
The above configuration snippet will enable the HTTP endpoint for hot reloading.
23-
2426
## How to reload
2527

26-
### Via HTTP
28+
After updating the configuration, use one of the following methods to perform a
29+
hot reload:
2730

28-
Hot reloading can be kicked via HTTP endpoints that are:
31+
### HTTP
2932

30-
* `PUT /api/v2/reload`
31-
* `POST /api/v2/reload`
33+
Use the following HTTP endpoints to perform a hot reload:
3234

33-
If users don't enable the hot reloading feature, hot reloading via these endpoints will not work.
35+
- `PUT /api/v2/reload`
36+
- `POST /api/v2/reload`
3437

3538
For using curl to reload Fluent Bit, users must specify an empty request body as:
3639

3740
```text
38-
$ curl -X POST -d '{}' localhost:2020/api/v2/reload
41+
curl -X POST -d '{}' localhost:2020/api/v2/reload
3942
```
4043

41-
### Via Signal
44+
### Signal
4245

43-
Hot reloading also can be kicked via `SIGHUP`.
46+
Hot reloading can be used with `SIGHUP`.
4447

45-
`SIGHUP` signal is not supported on Windows. So, users can't enable this feature on Windows.
48+
`SIGHUP` signal isn't supported on Windows.
4649

47-
## How to confirm reloaded or not
50+
## Confirm a reload
4851

49-
### via HTTP
52+
Use one of the following methods to confirm the reload occurred.
5053

51-
The number of hot reloaded count can be obtained via the HTTP endpoint that is:
54+
### HTTP
5255

53-
* `GET /api/v2/reload`
56+
Obtain a count of hot reload using the HTTP endpoint:
5457

55-
The endpoint returns the count of hot-reloaded as follows:
58+
- `GET /api/v2/reload`
59+
60+
The endpoint returns `hot_reload_count` as follows:
5661

5762
```json
5863
{"hot_reload_count":3}
5964
```
6065

61-
The default value of that number is 0.
62-
63-
## Limitations
64-
65-
The hot reloading feature is currently working on Linux, macOS and Windows.
66+
The default value of the counter is `0`.

0 commit comments

Comments
 (0)