Skip to content

Commit 7172a77

Browse files
committed
update
1 parent 56fe8d7 commit 7172a77

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ $ bundle
2828

2929
To receive data, this plugin requires `<http>` or `<grpc>` section, or both.
3030

31-
* Root section
31+
#### Root section
3232

3333
| parameter | type | description | default |
3434
|-----------|--------|----------------------|----------|
3535
| tag | string | The tag of the event | required |
3636

37-
* `<http>` section
37+
#### `<http>` section
3838

3939
This requires to receive data via HTTP/HTTPS.
4040

@@ -43,7 +43,7 @@ This requires to receive data via HTTP/HTTPS.
4343
| bind | string | The address to bind to | `0.0.0.0` |
4444
| port | integer | The port to listen to | `4318` |
4545

46-
* `<grpc>` section
46+
#### `<grpc>` section
4747

4848
This requires to receive data via gRPC.
4949

@@ -59,7 +59,6 @@ This requires to receive data via gRPC.
5959

6060
Refer [Config: Transport Section](https://docs.fluentd.org/configuration/transport-section)
6161

62-
6362
#### Example
6463

6564
```
@@ -83,7 +82,9 @@ Refer [Config: Transport Section](https://docs.fluentd.org/configuration/transpo
8382

8483
To send data, this plugin requires `<http>` or `<grpc>` section.
8584

86-
* `<http>` section
85+
#### `<http>` section
86+
87+
This requires to send data via HTTP/HTTPS.
8788

8889
| parameter | type | description | default |
8990
|---------------------------------|---------|----------------------------------------------------------------|-------------------------|
@@ -99,13 +100,18 @@ To send data, this plugin requires `<http>` or `<grpc>` section.
99100
|-----------|--------|-------------------------------------------|------------------|---------|
100101
| compress | enum | The option to compress HTTP request body | `text` / `gzip` | `text` |
101102

102-
* `<grpc>` section
103+
#### `<grpc>` section
104+
105+
This requires to send data via gRPC.
106+
107+
> [!WARNING]
108+
> Now, gRPC feature status is experimental.
103109
104110
| parameter | type | description | default |
105111
|---------------------------------|---------|----------------------------------------------------------------|------------------|
106112
| endpoint | string | The endpoint for HTTP/HTTPS request | `127.0.0.1:4317` |
107113

108-
* `<transport>` section
114+
#### `<transport>` section
109115

110116
| parameter | type | description | default |
111117
|------------------------|---------|------------------------------------------------|---------|
@@ -120,7 +126,7 @@ To send data, this plugin requires `<http>` or `<grpc>` section.
120126

121127
Refer [Config: Transport Section](https://docs.fluentd.org/configuration/transport-section)
122128

123-
* `<buffer>` section
129+
#### `<buffer>` section
124130

125131
| parameter | type | description | default |
126132
|------------------------|--------|------------------------------------------------|---------|

0 commit comments

Comments
 (0)