@bsb/syslog 9.1.2 → 9.6.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +660 -660
- package/lib/plugins/observable-syslog/index.d.ts +34 -34
- package/lib/plugins/observable-syslog/index.js +20 -20
- package/lib/plugins/service-syslog-server/index.d.ts +10 -10
- package/lib/plugins/service-syslog-server/index.js +12 -12
- package/lib/schemas/observable-syslog.json +181 -1
- package/lib/schemas/observable-syslog.plugin.json +191 -3
- package/lib/schemas/service-syslog-server.json +45 -2
- package/lib/schemas/service-syslog-server.plugin.json +54 -3
- package/package.json +8 -8
|
@@ -26,51 +26,51 @@
|
|
|
26
26
|
*/
|
|
27
27
|
import { BSBObservable, BSBObservableConstructor, BSBError } from "@bsb/base";
|
|
28
28
|
import { DTrace, LogMeta } from "@bsb/base";
|
|
29
|
-
import * as av from "
|
|
29
|
+
import * as av from "anyvali";
|
|
30
30
|
/**
|
|
31
31
|
* Configuration schema for syslog client observable
|
|
32
32
|
*/
|
|
33
33
|
export declare const SyslogClientConfigSchema: av.ObjectSchema<{
|
|
34
|
-
host: av.
|
|
35
|
-
port: av.
|
|
36
|
-
protocol: av.
|
|
34
|
+
host: av.StringSchema;
|
|
35
|
+
port: av.Int32Schema;
|
|
36
|
+
protocol: av.EnumSchema<string[]>;
|
|
37
37
|
tls: av.OptionalSchema<av.ObjectSchema<{
|
|
38
|
-
rejectUnauthorized: av.
|
|
38
|
+
rejectUnauthorized: av.BoolSchema;
|
|
39
39
|
ca: av.OptionalSchema<av.StringSchema>;
|
|
40
40
|
cert: av.OptionalSchema<av.StringSchema>;
|
|
41
41
|
key: av.OptionalSchema<av.StringSchema>;
|
|
42
42
|
}>>;
|
|
43
|
-
facility: av.
|
|
43
|
+
facility: av.Int32Schema;
|
|
44
44
|
hostname: av.OptionalSchema<av.StringSchema>;
|
|
45
|
-
appName: av.
|
|
46
|
-
rfc: av.
|
|
45
|
+
appName: av.StringSchema;
|
|
46
|
+
rfc: av.EnumSchema<string[]>;
|
|
47
47
|
levels: av.ObjectSchema<{
|
|
48
|
-
debug: av.
|
|
49
|
-
info: av.
|
|
50
|
-
warn: av.
|
|
51
|
-
error: av.
|
|
48
|
+
debug: av.BoolSchema;
|
|
49
|
+
info: av.BoolSchema;
|
|
50
|
+
warn: av.BoolSchema;
|
|
51
|
+
error: av.BoolSchema;
|
|
52
52
|
}>;
|
|
53
53
|
}>;
|
|
54
54
|
export type SyslogClientConfig = av.Infer<typeof SyslogClientConfigSchema>;
|
|
55
55
|
export declare const Config: import("@bsb/base").BSBPluginConfigClass<av.ObjectSchema<{
|
|
56
|
-
host: av.
|
|
57
|
-
port: av.
|
|
58
|
-
protocol: av.
|
|
56
|
+
host: av.StringSchema;
|
|
57
|
+
port: av.Int32Schema;
|
|
58
|
+
protocol: av.EnumSchema<string[]>;
|
|
59
59
|
tls: av.OptionalSchema<av.ObjectSchema<{
|
|
60
|
-
rejectUnauthorized: av.
|
|
60
|
+
rejectUnauthorized: av.BoolSchema;
|
|
61
61
|
ca: av.OptionalSchema<av.StringSchema>;
|
|
62
62
|
cert: av.OptionalSchema<av.StringSchema>;
|
|
63
63
|
key: av.OptionalSchema<av.StringSchema>;
|
|
64
64
|
}>>;
|
|
65
|
-
facility: av.
|
|
65
|
+
facility: av.Int32Schema;
|
|
66
66
|
hostname: av.OptionalSchema<av.StringSchema>;
|
|
67
|
-
appName: av.
|
|
68
|
-
rfc: av.
|
|
67
|
+
appName: av.StringSchema;
|
|
68
|
+
rfc: av.EnumSchema<string[]>;
|
|
69
69
|
levels: av.ObjectSchema<{
|
|
70
|
-
debug: av.
|
|
71
|
-
info: av.
|
|
72
|
-
warn: av.
|
|
73
|
-
error: av.
|
|
70
|
+
debug: av.BoolSchema;
|
|
71
|
+
info: av.BoolSchema;
|
|
72
|
+
warn: av.BoolSchema;
|
|
73
|
+
error: av.BoolSchema;
|
|
74
74
|
}>;
|
|
75
75
|
}>>;
|
|
76
76
|
/**
|
|
@@ -78,24 +78,24 @@ export declare const Config: import("@bsb/base").BSBPluginConfigClass<av.ObjectS
|
|
|
78
78
|
*/
|
|
79
79
|
export declare class Plugin extends BSBObservable<InstanceType<typeof Config>> {
|
|
80
80
|
static Config: import("@bsb/base").BSBPluginConfigClass<av.ObjectSchema<{
|
|
81
|
-
host: av.
|
|
82
|
-
port: av.
|
|
83
|
-
protocol: av.
|
|
81
|
+
host: av.StringSchema;
|
|
82
|
+
port: av.Int32Schema;
|
|
83
|
+
protocol: av.EnumSchema<string[]>;
|
|
84
84
|
tls: av.OptionalSchema<av.ObjectSchema<{
|
|
85
|
-
rejectUnauthorized: av.
|
|
85
|
+
rejectUnauthorized: av.BoolSchema;
|
|
86
86
|
ca: av.OptionalSchema<av.StringSchema>;
|
|
87
87
|
cert: av.OptionalSchema<av.StringSchema>;
|
|
88
88
|
key: av.OptionalSchema<av.StringSchema>;
|
|
89
89
|
}>>;
|
|
90
|
-
facility: av.
|
|
90
|
+
facility: av.Int32Schema;
|
|
91
91
|
hostname: av.OptionalSchema<av.StringSchema>;
|
|
92
|
-
appName: av.
|
|
93
|
-
rfc: av.
|
|
92
|
+
appName: av.StringSchema;
|
|
93
|
+
rfc: av.EnumSchema<string[]>;
|
|
94
94
|
levels: av.ObjectSchema<{
|
|
95
|
-
debug: av.
|
|
96
|
-
info: av.
|
|
97
|
-
warn: av.
|
|
98
|
-
error: av.
|
|
95
|
+
debug: av.BoolSchema;
|
|
96
|
+
info: av.BoolSchema;
|
|
97
|
+
warn: av.BoolSchema;
|
|
98
|
+
error: av.BoolSchema;
|
|
99
99
|
}>;
|
|
100
100
|
}>>;
|
|
101
101
|
private logFormatter;
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
26
26
|
*/
|
|
27
27
|
import { BSBObservable, createConfigSchema, LogFormatter, BSBError } from "@bsb/base";
|
|
28
|
-
import * as av from "
|
|
28
|
+
import * as av from "anyvali";
|
|
29
29
|
import { hostname } from "node:os";
|
|
30
30
|
// @ts-ignore - no types available
|
|
31
31
|
import * as SyslogClient from "syslog-client";
|
|
@@ -33,32 +33,32 @@ import * as SyslogClient from "syslog-client";
|
|
|
33
33
|
* Configuration schema for syslog client observable
|
|
34
34
|
*/
|
|
35
35
|
export const SyslogClientConfigSchema = av.object({
|
|
36
|
-
host: av.
|
|
37
|
-
port: av.
|
|
38
|
-
protocol: av.
|
|
36
|
+
host: av.string().default("localhost").describe("Syslog server hostname"),
|
|
37
|
+
port: av.int32().min(1).max(65535).default(514).describe("Syslog server port"),
|
|
38
|
+
protocol: av.enum_(["udp", "tcp", "tls"]).default("udp").describe("Transport protocol used to send syslog messages"),
|
|
39
39
|
tls: av.optional(av.object({
|
|
40
|
-
rejectUnauthorized: av.
|
|
41
|
-
ca: av.optional(av.string()),
|
|
42
|
-
cert: av.optional(av.string()),
|
|
43
|
-
key: av.optional(av.string()),
|
|
44
|
-
}
|
|
45
|
-
facility: av.
|
|
46
|
-
hostname: av.optional(av.string()),
|
|
47
|
-
appName: av.
|
|
48
|
-
rfc: av.
|
|
40
|
+
rejectUnauthorized: av.bool().default(true).describe("Whether TLS certificate validation rejects unauthorized certificates"),
|
|
41
|
+
ca: av.optional(av.string()).describe("Optional TLS certificate authority data"),
|
|
42
|
+
cert: av.optional(av.string()).describe("Optional TLS client certificate data"),
|
|
43
|
+
key: av.optional(av.string()).describe("Optional TLS client private key data"),
|
|
44
|
+
}).describe("TLS connection settings for syslog transport")),
|
|
45
|
+
facility: av.int32().min(0).max(23).default(16).describe("Syslog facility code"),
|
|
46
|
+
hostname: av.optional(av.string()).describe("Hostname reported in syslog messages, defaulting to the local hostname"),
|
|
47
|
+
appName: av.string().default("bsb-app").describe("Application name reported in syslog messages"),
|
|
48
|
+
rfc: av.enum_(["3164", "5424"]).default("5424").describe("Syslog message format RFC"),
|
|
49
49
|
levels: av.object({
|
|
50
|
-
debug: av.
|
|
51
|
-
info: av.
|
|
52
|
-
warn: av.
|
|
53
|
-
error: av.
|
|
54
|
-
}
|
|
55
|
-
}
|
|
50
|
+
debug: av.bool().default(true).describe("Whether debug logs are sent to syslog"),
|
|
51
|
+
info: av.bool().default(true).describe("Whether info logs are sent to syslog"),
|
|
52
|
+
warn: av.bool().default(true).describe("Whether warning logs are sent to syslog"),
|
|
53
|
+
error: av.bool().default(true).describe("Whether error logs are sent to syslog"),
|
|
54
|
+
}).describe("Log level enablement"),
|
|
55
|
+
}).describe("Syslog client observable plugin configuration");
|
|
56
56
|
export const Config = createConfigSchema({
|
|
57
57
|
name: 'observable-syslog',
|
|
58
58
|
description: 'Syslog client observable plugin for forwarding logs to syslog servers',
|
|
59
|
-
version: '9.0.0',
|
|
60
59
|
image: './assets/syslog-icon.png',
|
|
61
60
|
tags: ['syslog', 'logging', 'observable', 'network'],
|
|
61
|
+
documentation: ['./docs/syslog-client.md'],
|
|
62
62
|
}, SyslogClientConfigSchema);
|
|
63
63
|
/**
|
|
64
64
|
* Convert BSB log level to syslog severity
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
*/
|
|
27
27
|
import { BSBService, BSBServiceConstructor, BSBServiceClient } from "@bsb/base";
|
|
28
28
|
import { Observable } from "@bsb/base";
|
|
29
|
-
import * as av from "
|
|
29
|
+
import * as av from "anyvali";
|
|
30
30
|
/**
|
|
31
31
|
* Syslog message structure
|
|
32
32
|
*/
|
|
@@ -42,15 +42,15 @@ export type SyslogMessage = av.Infer<typeof SyslogMessageSchema>;
|
|
|
42
42
|
* Configuration schema for syslog server
|
|
43
43
|
*/
|
|
44
44
|
export declare const SyslogServerConfigSchema: av.ObjectSchema<{
|
|
45
|
-
port: av.
|
|
46
|
-
address: av.
|
|
47
|
-
exclusive: av.
|
|
45
|
+
port: av.Int32Schema;
|
|
46
|
+
address: av.StringSchema;
|
|
47
|
+
exclusive: av.BoolSchema;
|
|
48
48
|
}>;
|
|
49
49
|
export type SyslogServerConfig = av.Infer<typeof SyslogServerConfigSchema>;
|
|
50
50
|
export declare const Config: import("@bsb/base").BSBPluginConfigClass<av.ObjectSchema<{
|
|
51
|
-
port: av.
|
|
52
|
-
address: av.
|
|
53
|
-
exclusive: av.
|
|
51
|
+
port: av.Int32Schema;
|
|
52
|
+
address: av.StringSchema;
|
|
53
|
+
exclusive: av.BoolSchema;
|
|
54
54
|
}>>;
|
|
55
55
|
/**
|
|
56
56
|
* Event schemas for syslog server
|
|
@@ -80,9 +80,9 @@ export declare const EventSchemas: {
|
|
|
80
80
|
*/
|
|
81
81
|
export declare class Plugin extends BSBService<InstanceType<typeof Config>, typeof EventSchemas> {
|
|
82
82
|
static Config: import("@bsb/base").BSBPluginConfigClass<av.ObjectSchema<{
|
|
83
|
-
port: av.
|
|
84
|
-
address: av.
|
|
85
|
-
exclusive: av.
|
|
83
|
+
port: av.Int32Schema;
|
|
84
|
+
address: av.StringSchema;
|
|
85
|
+
exclusive: av.BoolSchema;
|
|
86
86
|
}>>;
|
|
87
87
|
static EventSchemas: {
|
|
88
88
|
readonly emitEvents: {
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
26
26
|
*/
|
|
27
27
|
import { BSBService, BSBServiceClient, createConfigSchema, bsb } from "@bsb/base";
|
|
28
|
-
import * as av from "
|
|
28
|
+
import * as av from "anyvali";
|
|
29
29
|
import { createFireAndForgetEvent } from "@bsb/base";
|
|
30
30
|
// @ts-ignore - no types available
|
|
31
31
|
import SyslogServer from "syslog-server";
|
|
@@ -33,26 +33,26 @@ import SyslogServer from "syslog-server";
|
|
|
33
33
|
* Syslog message structure
|
|
34
34
|
*/
|
|
35
35
|
export const SyslogMessageSchema = av.object({
|
|
36
|
-
gatewayTime: av.number(),
|
|
37
|
-
date: av.number(),
|
|
38
|
-
host: av.string(),
|
|
39
|
-
protocol: av.string(),
|
|
40
|
-
message: av.string(),
|
|
41
|
-
}
|
|
36
|
+
gatewayTime: av.number().describe("Timestamp when the syslog gateway received the message"),
|
|
37
|
+
date: av.number().describe("Timestamp parsed from the syslog message"),
|
|
38
|
+
host: av.string().describe("Host reported by the syslog sender"),
|
|
39
|
+
protocol: av.string().describe("Protocol used to receive the syslog message"),
|
|
40
|
+
message: av.string().describe("Raw syslog message body"),
|
|
41
|
+
}).describe("Syslog message event payload");
|
|
42
42
|
/**
|
|
43
43
|
* Configuration schema for syslog server
|
|
44
44
|
*/
|
|
45
45
|
export const SyslogServerConfigSchema = av.object({
|
|
46
|
-
port: av.
|
|
47
|
-
address: av.
|
|
48
|
-
exclusive: av.
|
|
49
|
-
}
|
|
46
|
+
port: av.int32().min(1).max(65535).default(514).describe("UDP port the syslog server listens on"),
|
|
47
|
+
address: av.string().default("0.0.0.0").describe("Network address the syslog server binds to"),
|
|
48
|
+
exclusive: av.bool().default(false).describe("Whether the server requests exclusive address binding"),
|
|
49
|
+
}).describe("Syslog server plugin configuration");
|
|
50
50
|
export const Config = createConfigSchema({
|
|
51
51
|
name: 'service-syslog-server',
|
|
52
52
|
description: 'Syslog server service plugin that receives messages and emits events',
|
|
53
|
-
version: '9.0.0',
|
|
54
53
|
image: './assets/syslog-icon.png',
|
|
55
54
|
tags: ['syslog', 'server', 'service', 'events'],
|
|
55
|
+
documentation: ['./docs/syslog-server.md'],
|
|
56
56
|
}, SyslogServerConfigSchema);
|
|
57
57
|
/**
|
|
58
58
|
* Event schemas for syslog server
|
|
@@ -1,7 +1,187 @@
|
|
|
1
1
|
{
|
|
2
2
|
"pluginName": "observable-syslog",
|
|
3
|
-
"version": "9.0.0",
|
|
4
3
|
"events": {},
|
|
4
|
+
"version": "9.6.12",
|
|
5
|
+
"configSchema": {
|
|
6
|
+
"anyvaliVersion": "1.0",
|
|
7
|
+
"schemaVersion": "1.1",
|
|
8
|
+
"root": {
|
|
9
|
+
"kind": "object",
|
|
10
|
+
"properties": {
|
|
11
|
+
"host": {
|
|
12
|
+
"kind": "string",
|
|
13
|
+
"default": "localhost",
|
|
14
|
+
"metadata": {
|
|
15
|
+
"description": "Syslog server hostname"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"port": {
|
|
19
|
+
"kind": "int32",
|
|
20
|
+
"min": 1,
|
|
21
|
+
"max": 65535,
|
|
22
|
+
"default": 514,
|
|
23
|
+
"metadata": {
|
|
24
|
+
"description": "Syslog server port"
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
"protocol": {
|
|
28
|
+
"kind": "enum",
|
|
29
|
+
"values": [
|
|
30
|
+
"udp",
|
|
31
|
+
"tcp",
|
|
32
|
+
"tls"
|
|
33
|
+
],
|
|
34
|
+
"default": "udp",
|
|
35
|
+
"metadata": {
|
|
36
|
+
"description": "Transport protocol used to send syslog messages"
|
|
37
|
+
}
|
|
38
|
+
},
|
|
39
|
+
"tls": {
|
|
40
|
+
"kind": "optional",
|
|
41
|
+
"inner": {
|
|
42
|
+
"kind": "object",
|
|
43
|
+
"properties": {
|
|
44
|
+
"rejectUnauthorized": {
|
|
45
|
+
"kind": "bool",
|
|
46
|
+
"default": true,
|
|
47
|
+
"metadata": {
|
|
48
|
+
"description": "Whether TLS certificate validation rejects unauthorized certificates"
|
|
49
|
+
}
|
|
50
|
+
},
|
|
51
|
+
"ca": {
|
|
52
|
+
"kind": "optional",
|
|
53
|
+
"inner": {
|
|
54
|
+
"kind": "string"
|
|
55
|
+
},
|
|
56
|
+
"metadata": {
|
|
57
|
+
"description": "Optional TLS certificate authority data"
|
|
58
|
+
}
|
|
59
|
+
},
|
|
60
|
+
"cert": {
|
|
61
|
+
"kind": "optional",
|
|
62
|
+
"inner": {
|
|
63
|
+
"kind": "string"
|
|
64
|
+
},
|
|
65
|
+
"metadata": {
|
|
66
|
+
"description": "Optional TLS client certificate data"
|
|
67
|
+
}
|
|
68
|
+
},
|
|
69
|
+
"key": {
|
|
70
|
+
"kind": "optional",
|
|
71
|
+
"inner": {
|
|
72
|
+
"kind": "string"
|
|
73
|
+
},
|
|
74
|
+
"metadata": {
|
|
75
|
+
"description": "Optional TLS client private key data"
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
},
|
|
79
|
+
"required": [
|
|
80
|
+
"rejectUnauthorized"
|
|
81
|
+
],
|
|
82
|
+
"unknownKeys": "strip",
|
|
83
|
+
"metadata": {
|
|
84
|
+
"description": "TLS connection settings for syslog transport"
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
},
|
|
88
|
+
"facility": {
|
|
89
|
+
"kind": "int32",
|
|
90
|
+
"min": 0,
|
|
91
|
+
"max": 23,
|
|
92
|
+
"default": 16,
|
|
93
|
+
"metadata": {
|
|
94
|
+
"description": "Syslog facility code"
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
"hostname": {
|
|
98
|
+
"kind": "optional",
|
|
99
|
+
"inner": {
|
|
100
|
+
"kind": "string"
|
|
101
|
+
},
|
|
102
|
+
"metadata": {
|
|
103
|
+
"description": "Hostname reported in syslog messages, defaulting to the local hostname"
|
|
104
|
+
}
|
|
105
|
+
},
|
|
106
|
+
"appName": {
|
|
107
|
+
"kind": "string",
|
|
108
|
+
"default": "bsb-app",
|
|
109
|
+
"metadata": {
|
|
110
|
+
"description": "Application name reported in syslog messages"
|
|
111
|
+
}
|
|
112
|
+
},
|
|
113
|
+
"rfc": {
|
|
114
|
+
"kind": "enum",
|
|
115
|
+
"values": [
|
|
116
|
+
"3164",
|
|
117
|
+
"5424"
|
|
118
|
+
],
|
|
119
|
+
"default": "5424",
|
|
120
|
+
"metadata": {
|
|
121
|
+
"description": "Syslog message format RFC"
|
|
122
|
+
}
|
|
123
|
+
},
|
|
124
|
+
"levels": {
|
|
125
|
+
"kind": "object",
|
|
126
|
+
"properties": {
|
|
127
|
+
"debug": {
|
|
128
|
+
"kind": "bool",
|
|
129
|
+
"default": true,
|
|
130
|
+
"metadata": {
|
|
131
|
+
"description": "Whether debug logs are sent to syslog"
|
|
132
|
+
}
|
|
133
|
+
},
|
|
134
|
+
"info": {
|
|
135
|
+
"kind": "bool",
|
|
136
|
+
"default": true,
|
|
137
|
+
"metadata": {
|
|
138
|
+
"description": "Whether info logs are sent to syslog"
|
|
139
|
+
}
|
|
140
|
+
},
|
|
141
|
+
"warn": {
|
|
142
|
+
"kind": "bool",
|
|
143
|
+
"default": true,
|
|
144
|
+
"metadata": {
|
|
145
|
+
"description": "Whether warning logs are sent to syslog"
|
|
146
|
+
}
|
|
147
|
+
},
|
|
148
|
+
"error": {
|
|
149
|
+
"kind": "bool",
|
|
150
|
+
"default": true,
|
|
151
|
+
"metadata": {
|
|
152
|
+
"description": "Whether error logs are sent to syslog"
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
},
|
|
156
|
+
"required": [
|
|
157
|
+
"debug",
|
|
158
|
+
"info",
|
|
159
|
+
"warn",
|
|
160
|
+
"error"
|
|
161
|
+
],
|
|
162
|
+
"unknownKeys": "strip",
|
|
163
|
+
"metadata": {
|
|
164
|
+
"description": "Log level enablement"
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
},
|
|
168
|
+
"required": [
|
|
169
|
+
"host",
|
|
170
|
+
"port",
|
|
171
|
+
"protocol",
|
|
172
|
+
"facility",
|
|
173
|
+
"appName",
|
|
174
|
+
"rfc",
|
|
175
|
+
"levels"
|
|
176
|
+
],
|
|
177
|
+
"unknownKeys": "strip",
|
|
178
|
+
"metadata": {
|
|
179
|
+
"description": "Syslog client observable plugin configuration"
|
|
180
|
+
}
|
|
181
|
+
},
|
|
182
|
+
"definitions": {},
|
|
183
|
+
"extensions": {}
|
|
184
|
+
},
|
|
5
185
|
"pluginType": "observable",
|
|
6
186
|
"capabilities": {
|
|
7
187
|
"logging": {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"id": "observable-syslog",
|
|
3
3
|
"name": "observable-syslog",
|
|
4
|
-
"version": "9.
|
|
4
|
+
"version": "9.6.12",
|
|
5
5
|
"description": "Syslog client observable plugin for forwarding logs to syslog servers",
|
|
6
6
|
"category": "observable",
|
|
7
7
|
"tags": [
|
|
@@ -10,7 +10,195 @@
|
|
|
10
10
|
"observable",
|
|
11
11
|
"network"
|
|
12
12
|
],
|
|
13
|
-
"documentation": [
|
|
13
|
+
"documentation": [
|
|
14
|
+
"./docs/syslog-client.md"
|
|
15
|
+
],
|
|
14
16
|
"dependencies": [],
|
|
15
|
-
"
|
|
17
|
+
"author": {
|
|
18
|
+
"name": "BetterCorp (PTY) Ltd",
|
|
19
|
+
"email": "ninja@bettercorp.dev",
|
|
20
|
+
"url": "https://bettercorp.dev/"
|
|
21
|
+
},
|
|
22
|
+
"license": "(AGPL-3.0-only OR Commercial)",
|
|
23
|
+
"image": "./assets/syslog-icon.png",
|
|
24
|
+
"configSchema": {
|
|
25
|
+
"anyvaliVersion": "1.0",
|
|
26
|
+
"schemaVersion": "1.1",
|
|
27
|
+
"root": {
|
|
28
|
+
"kind": "object",
|
|
29
|
+
"properties": {
|
|
30
|
+
"host": {
|
|
31
|
+
"kind": "string",
|
|
32
|
+
"default": "localhost",
|
|
33
|
+
"metadata": {
|
|
34
|
+
"description": "Syslog server hostname"
|
|
35
|
+
}
|
|
36
|
+
},
|
|
37
|
+
"port": {
|
|
38
|
+
"kind": "int32",
|
|
39
|
+
"min": 1,
|
|
40
|
+
"max": 65535,
|
|
41
|
+
"default": 514,
|
|
42
|
+
"metadata": {
|
|
43
|
+
"description": "Syslog server port"
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
"protocol": {
|
|
47
|
+
"kind": "enum",
|
|
48
|
+
"values": [
|
|
49
|
+
"udp",
|
|
50
|
+
"tcp",
|
|
51
|
+
"tls"
|
|
52
|
+
],
|
|
53
|
+
"default": "udp",
|
|
54
|
+
"metadata": {
|
|
55
|
+
"description": "Transport protocol used to send syslog messages"
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
"tls": {
|
|
59
|
+
"kind": "optional",
|
|
60
|
+
"inner": {
|
|
61
|
+
"kind": "object",
|
|
62
|
+
"properties": {
|
|
63
|
+
"rejectUnauthorized": {
|
|
64
|
+
"kind": "bool",
|
|
65
|
+
"default": true,
|
|
66
|
+
"metadata": {
|
|
67
|
+
"description": "Whether TLS certificate validation rejects unauthorized certificates"
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
"ca": {
|
|
71
|
+
"kind": "optional",
|
|
72
|
+
"inner": {
|
|
73
|
+
"kind": "string"
|
|
74
|
+
},
|
|
75
|
+
"metadata": {
|
|
76
|
+
"description": "Optional TLS certificate authority data"
|
|
77
|
+
}
|
|
78
|
+
},
|
|
79
|
+
"cert": {
|
|
80
|
+
"kind": "optional",
|
|
81
|
+
"inner": {
|
|
82
|
+
"kind": "string"
|
|
83
|
+
},
|
|
84
|
+
"metadata": {
|
|
85
|
+
"description": "Optional TLS client certificate data"
|
|
86
|
+
}
|
|
87
|
+
},
|
|
88
|
+
"key": {
|
|
89
|
+
"kind": "optional",
|
|
90
|
+
"inner": {
|
|
91
|
+
"kind": "string"
|
|
92
|
+
},
|
|
93
|
+
"metadata": {
|
|
94
|
+
"description": "Optional TLS client private key data"
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
},
|
|
98
|
+
"required": [
|
|
99
|
+
"rejectUnauthorized"
|
|
100
|
+
],
|
|
101
|
+
"unknownKeys": "strip",
|
|
102
|
+
"metadata": {
|
|
103
|
+
"description": "TLS connection settings for syslog transport"
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
},
|
|
107
|
+
"facility": {
|
|
108
|
+
"kind": "int32",
|
|
109
|
+
"min": 0,
|
|
110
|
+
"max": 23,
|
|
111
|
+
"default": 16,
|
|
112
|
+
"metadata": {
|
|
113
|
+
"description": "Syslog facility code"
|
|
114
|
+
}
|
|
115
|
+
},
|
|
116
|
+
"hostname": {
|
|
117
|
+
"kind": "optional",
|
|
118
|
+
"inner": {
|
|
119
|
+
"kind": "string"
|
|
120
|
+
},
|
|
121
|
+
"metadata": {
|
|
122
|
+
"description": "Hostname reported in syslog messages, defaulting to the local hostname"
|
|
123
|
+
}
|
|
124
|
+
},
|
|
125
|
+
"appName": {
|
|
126
|
+
"kind": "string",
|
|
127
|
+
"default": "bsb-app",
|
|
128
|
+
"metadata": {
|
|
129
|
+
"description": "Application name reported in syslog messages"
|
|
130
|
+
}
|
|
131
|
+
},
|
|
132
|
+
"rfc": {
|
|
133
|
+
"kind": "enum",
|
|
134
|
+
"values": [
|
|
135
|
+
"3164",
|
|
136
|
+
"5424"
|
|
137
|
+
],
|
|
138
|
+
"default": "5424",
|
|
139
|
+
"metadata": {
|
|
140
|
+
"description": "Syslog message format RFC"
|
|
141
|
+
}
|
|
142
|
+
},
|
|
143
|
+
"levels": {
|
|
144
|
+
"kind": "object",
|
|
145
|
+
"properties": {
|
|
146
|
+
"debug": {
|
|
147
|
+
"kind": "bool",
|
|
148
|
+
"default": true,
|
|
149
|
+
"metadata": {
|
|
150
|
+
"description": "Whether debug logs are sent to syslog"
|
|
151
|
+
}
|
|
152
|
+
},
|
|
153
|
+
"info": {
|
|
154
|
+
"kind": "bool",
|
|
155
|
+
"default": true,
|
|
156
|
+
"metadata": {
|
|
157
|
+
"description": "Whether info logs are sent to syslog"
|
|
158
|
+
}
|
|
159
|
+
},
|
|
160
|
+
"warn": {
|
|
161
|
+
"kind": "bool",
|
|
162
|
+
"default": true,
|
|
163
|
+
"metadata": {
|
|
164
|
+
"description": "Whether warning logs are sent to syslog"
|
|
165
|
+
}
|
|
166
|
+
},
|
|
167
|
+
"error": {
|
|
168
|
+
"kind": "bool",
|
|
169
|
+
"default": true,
|
|
170
|
+
"metadata": {
|
|
171
|
+
"description": "Whether error logs are sent to syslog"
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
},
|
|
175
|
+
"required": [
|
|
176
|
+
"debug",
|
|
177
|
+
"info",
|
|
178
|
+
"warn",
|
|
179
|
+
"error"
|
|
180
|
+
],
|
|
181
|
+
"unknownKeys": "strip",
|
|
182
|
+
"metadata": {
|
|
183
|
+
"description": "Log level enablement"
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
},
|
|
187
|
+
"required": [
|
|
188
|
+
"host",
|
|
189
|
+
"port",
|
|
190
|
+
"protocol",
|
|
191
|
+
"facility",
|
|
192
|
+
"appName",
|
|
193
|
+
"rfc",
|
|
194
|
+
"levels"
|
|
195
|
+
],
|
|
196
|
+
"unknownKeys": "strip",
|
|
197
|
+
"metadata": {
|
|
198
|
+
"description": "Syslog client observable plugin configuration"
|
|
199
|
+
}
|
|
200
|
+
},
|
|
201
|
+
"definitions": {},
|
|
202
|
+
"extensions": {}
|
|
203
|
+
}
|
|
16
204
|
}
|