Skip to content

in_tcp, in_udp, in_syslog: document deprecated parameters #662

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenhys merged 1 commit into from
Aug 4, 2026
Merged

in_tcp, in_udp, in_syslog: document deprecated parameters #662

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions input/syslog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,16 @@ The field name of the client's hostname. If set, the client's hostname will be s

The field name of the client's address. If set, the client's address will be set to its key.

### `include_source_host`

| type | default | version |
| :--- | :--- | :--- |
| bool | false | 0.10.53 |

This parameter is deprecated. Use `source_hostname_key` or `source_address_key` instead.

If `true`, adds the source host to the event record.

### `severity_key`

| type | default | version |
Expand Down
10 changes: 10 additions & 0 deletions input/tcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,16 @@ You will get something like below:
}
```

### `source_host_key`

| type | default | version |
| :--- | :--- | :--- |
| string | nil | 0.10.51 |

This parameter is deprecated. Use `source_hostname_key` instead.

The field name of the client's hostname.

### `message_length_limit`

| type | default | version |
Expand Down
20 changes: 20 additions & 0 deletions input/udp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,16 @@ You will get something like this:
}
```

### `source_host_key`

| type | default | version |
| :--- | :--- | :--- |
| string | nil | 0.10.51 |

This parameter is deprecated. Use `source_hostname_key` instead.

The field name of the client's hostname.

### `message_length_limit`

| type | default | version |
Expand All @@ -127,6 +137,16 @@ You will get something like this:

The maximum number of bytes for the message.

### `body_size_limit`

| type | default | version |
| :--- | :--- | :--- |
| size | nil | 0.10.51 |

This parameter is deprecated. Use `message_length_limit` instead.

The maximum number of bytes for the message.

### `remove_newline`

| type | default | version |
Expand Down