Skip to content

Commit d261f6a

Browse files
eschabelleschabell
authored
in_opentelemetry: fix typo and sort configuration parameters alphabetically (#2298)
- Fix typo: log_supress_interval → log_suppress_interval - Sort configuration parameters alphabetically: - buffer_chunk_size before buffer_max_size - thread.ring_buffer.* before threaded - tls.ciphers before tls.crt_file - Improve thread.ring_buffer.capacity and thread.ring_buffer.window descriptions - Add links to multithreading administration doc for threading parameters Applies to #2209. Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 068d99c commit d261f6a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

‎pipeline/inputs/opentelemetry.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ Fluent Bit has a compliant implementation which fully supports `OTLP/HTTP` and `
1313
| Key | Description | Default |
1414
|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
1515
| `alias` | Sets an alias for multiple instances of the same input plugin. If no alias is specified, a default name will be assigned using the plugin name followed by a dot and a sequence number. | _none_ |
16-
| `buffer_max_size` | Maximum size of the HTTP request buffer in `KB`, `MB`, or `GB`. | `4M` |
1716
| `buffer_chunk_size` | Size of each buffer chunk allocated for HTTP requests (advanced users only). | `512K` |
17+
| `buffer_max_size` | Maximum size of the HTTP request buffer in `KB`, `MB`, or `GB`. | `4M` |
1818
| `encode_profiles_as_log` | Encode profiles received as text and ingest them in the logging pipeline. | `true` |
1919
| `host` | The hostname. | `localhost` |
2020
| `http2` | Enable HTTP/2 protocol support for the OpenTelemetry receiver. | `true` |
2121
| `listen` | The network address to listen on. | `0.0.0.0` |
2222
| `log_level` | Specifies the log level for this plugin. If not set here, the plugin uses the global log level specified in the `service` section of your configuration file. | `info` |
23-
| `log_supress_interval` | Suppresses log messages from this plugin that appear similar within a specified time interval. `0` no suppression. | `0` |
23+
| `log_suppress_interval` | Suppresses log messages from this plugin that appear similar within a specified time interval. `0` no suppression. | `0` |
2424
| `logs_body_key` | Specify a body key. | _none_ |
2525
| `logs_metadata_key` | Key name to store OpenTelemetry logs metadata in the record. | `otlp` |
2626
| `mem_buf_limit` | Set a memory buffer limit for the input plugin. If the limit is reached, the plugin will pause until the buffer is drained. The value is in bytes. If set to 0, the buffer limit is disabled. | `0` |
@@ -40,14 +40,14 @@ Fluent Bit has a compliant implementation which fully supports `OTLP/HTTP` and `
4040
| `tag` | Set a tag for the events generated by this input plugin. | _none_ |
4141
| `tag_from_uri` | By default, the tag will be created from the URI. For example, `v1_metrics` from `/v1/metrics`. This must be set to false if using `tag`. | `true` |
4242
| `tag_key` | Record accessor key to use for generating tags from incoming records. | _none_ |
43-
| `threaded` | Enable threading on an input. | `false` |
44-
| `thread.ring_buffer.capacity` | Set custom ring buffer capacity when the input runs in threaded mode. | `1024` |
45-
| `thread.ring_buffer.window` | Set custom ring buffer window percentage for threaded inputs. | `5` |
43+
| `thread.ring_buffer.capacity` | Number of slots in the ring buffer for data entries when running in [threaded](../../administration/multithreading.md) mode. Each slot can hold one data entry. | `1024` |
44+
| `thread.ring_buffer.window` | Percentage threshold (1-100) of the ring buffer capacity at which a flush is triggered when running in [threaded](../../administration/multithreading.md) mode. | `5` |
45+
| `threaded` | Enable [multithreading](../../administration/multithreading.md) for this input to run in a separate dedicated thread. | `false` |
4646
| `tls` | Enable or disable TLS/SSL support. | `off` |
4747
| `tls.ca_file` | Absolute path to CA certificate file. | _none_ |
4848
| `tls.ca_path` | Absolute path to scan for certificate files. | _none_ |
49-
| `tls.crt_file` | Absolute path to Certificate file. | _none_ |
5049
| `tls.ciphers` | Specify TLS ciphers up to TLSv1.2. | _none_ |
50+
| `tls.crt_file` | Absolute path to Certificate file. | _none_ |
5151
| `tls.debug` | Set TLS debug level. Accepts `0` (No debug), `1`(Error), `2` (State change), `3` (Informational) and `4` (Verbose). | `1` |
5252
| `tls.key_file` | Absolute path to private Key file. | _none_ |
5353
| `tls.key_passwd` | Optional password for tls.key_file file. | _none_ |

0 commit comments

Comments
 (0)