Repository navigation
Expand file tree
/
Copy pathsocket.toml
More file actions
75 lines (66 loc) · 1.87 KB
/
Copy pathsocket.toml
File metadata and controls
75 lines (66 loc) · 1.87 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
[sinks.socket]
title = "Socket"
noun = "a TCP, UDP, or UDS socket"
beta = false
common = true
delivery_guarantee = "best_effort"
egress_method = "streaming"
features = [
"Stream logs over a TCP, UDP, or Unix socket.",
"Buffer your data in-memory or on-disk for performance and durability.",
]
function_category = "transmit"
healthcheck = true
input_types = ["log"]
requirements = {}
write_to_description = "a [socket][urls.socket], such as a [TCP][urls.tcp], [UDP][urls.udp], or [UDS][urls.uds] socket"
<%= render("_partials/fields/_component_options.toml", type: "sink", name: "socket") %>
<%= render(
"_partials/fields/_buffer_options.toml",
namespace: "sinks.socket.options",
common: false,
groups: ["tcp", "udp", "unix"]
) %>
<%= render("_partials/fields/_encoding_options.toml",
namespace: "sinks.socket.options",
encodings: ["json", "text"],
groups: ["tcp", "udp", "unix"]
) %>
[sinks.socket.options.mode]
type = "string"
common = true
examples.tcp = ["tcp"]
examples.udp = ["udp"]
examples.unix = ["unix"]
groups = ["tcp", "udp", "unix"]
required = true
description = "The type of socket to use."
[sinks.socket.options.mode.enum]
tcp = "TCP socket"
udp = "UDP socket"
unix = "Unix domain socket"
[sinks.socket.options.address]
type = "string"
common = true
examples = ["92.12.333.224:5000"]
groups = ["tcp", "udp"]
relevant_when = {mode = ["tcp", "udp"]}
required = true
description = "The address to connect to. The address _must_ include a port."
[sinks.socket.options.path]
type = "string"
common = true
examples = ["/path/to/socket"]
groups = ["unix"]
relevant_when = {mode = "unix"}
required = true
description = """The unix socket path. This should be the absolute path.\
"""
<%= render(
"_partials/fields/_tls_connector_options.toml",
namespace: "sinks.socket.options",
can_enable: true,
can_verify_certificate: true,
can_verify_hostname: true,
groups: ["tcp"]
) %>