Skip to content

Commit 4a2ce21

Browse files
committed
feat: run generate-component-docs to generate some docs
1 parent 0eb1bde commit 4a2ce21

File tree

3 files changed

+38
-1
lines changed

3 files changed

+38
-1
lines changed

.tool-versions

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ruby 3.3.6

website/cue/reference/components/sinks/generated/greptimedb_logs.cue

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,8 @@ generated: components: sinks: greptimedb_logs: configuration: {
153153
"""
154154
required: false
155155
type: object: {
156-
examples: [{}]
156+
examples: [{},
157+
]
157158
options: "*": {
158159
description: "Extra header key-value pairs."
159160
required: true
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
package metadata
2+
3+
generated: components: sources: snmp_trap: configuration: {
4+
address: {
5+
description: """
6+
The address to listen for SNMP traps on.
7+
8+
SNMP traps are typically sent to UDP port 162.
9+
"""
10+
required: true
11+
type: string: examples: ["0.0.0.0:9000", "systemd", "systemd#3", "0.0.0.0:162", "127.0.0.1:1162"]
12+
}
13+
host_key: {
14+
description: """
15+
Overrides the name of the log field used to add the peer host to each event.
16+
17+
The value is the peer host's address, including the port. For example, `192.168.1.1:162`.
18+
19+
By default, the [global `log_schema.host_key` option][global_host_key] is used.
20+
21+
[global_host_key]: https://vector.dev/docs/reference/configuration/global-options/#log_schema.host_key
22+
"""
23+
required: false
24+
type: string: {}
25+
}
26+
receive_buffer_bytes: {
27+
description: """
28+
The size of the receive buffer used for the listening socket.
29+
30+
This should not typically need to be changed.
31+
"""
32+
required: false
33+
type: uint: unit: "bytes"
34+
}
35+
}

0 commit comments

Comments
 (0)