Work / SysMon / Configuration

2016-05-09 21:29:58

Schema

A direct link to the configuration json schema:

https://www.sekaita.com/files/work/sysmon.config.schema.json.

Below is the json schema for the configuration file:

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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Root configuration object",
    "description": "sysmon root configuration object.",
    "additionalItems": false,
    "properties": {
        "inspectorType": {
            "enum": ["Fixed", "Floating", "Free"]
        },
        "icons": {
            "type": "array",
            "title": "Icon array",
            "description": "An array of icon description objects.",
            "items": {
                "type": "object",
                "title": "Icon description object",
                "description": "An object that defines the configuration of an icon.",
                "additionalItems": false,
                "properties": {
                    "updateInterval": {
                        "type": "integer",
                        "title": "Update interval",
                        "description": "The time in milliseconds between updates."
                    },
                    "scrollAmount": {
                        "type": "integer",
                        "title": "Scroll speed",
                        "description": "The horizontal amount by which the graph moves per update interval."
                    },
                    "units": {
                        "type": "string",
                        "title": "Value units",
                        "description": "The units of measurement the value is represented in."
                    },
                    "gaugeLines": {
                        "type": "array",
                        "title": "GaugeLines array",
                        "description": "An array of gauge line description objects.",
                        "items": {
                            "type": "object",
                            "title": "Gauge line description object",
                            "description": "An object that defines the configuration of a gauge line.",
                            "additionalItems": false,
                            "properties": {
                                "value": {
                                    "type": "integer",
                                    "title": "Value",
                                    "description": "The value at which the gauge line is rendered."
                                },
                                "colour": {
                                    "type": "string",
                                    "title": "Colour",
                                    "description": "The colour of the gauge line."
                                },
                                "dotPitch": {
                                    "type": "integer",
                                    "title": "Dot pitch",
                                    "description": "The distance between the dots in the gauge line."
                                }
                            },
                            "required": [
                                "value",
                                "colour"
                            ]
                        }
                    },
                    "graphs": {
                        "type": "array",
                        "title": "Graph array",
                        "description": "An array of graph description objects.",
                        "items": {
                            "type": "object",
                            "title": "Graph description object",
                            "description": "An object that defines the configuration of a graph.",
                            "additionalItems": false,
                            "properties": {
                                "input": {
                                    "type": "object",
                                    "title": "Input description object",
                                    "description": "An object that defines the configuration of an input data source for a graph.",
                                    "additionalItems": false,
                                    "properties": {
                                        "type": {
                                            "type": "string",
                                            "title": "Source type",
                                            "description": "The type of the input data source."
                                        },
                                        "name": {
                                            "type": "string",
                                            "title": "Source name",
                                            "description": "The name of the input data source."
                                        }
                                    },
                                    "required": [
                                        "type"
                                    ]
                                },
                                "output": {
                                    "type": "object",
                                    "title": "Output description object",
                                    "description": "An object that defines the configuration for the visual output of a graph.",
                                    "additionalItems": false,
                                    "properties": {
                                        "renderMethod": {
                                            "type": "string",
                                            "title": "RenderMethod",
                                            "description": "The type of graph to render."
                                        },
                                        "toolTip": {
                                            "type": "string",
                                            "title": "ToolTip",
                                            "description": "A piece of descriptive/friendly text that is displayed in the icon tool-tip."
                                        },
                                        "rescale": {
                                            "type": "boolean",
                                            "title": "Rescale",
                                            "description": "Whether the display vertically rescales to accomodate this graph."
                                        },                                     
                                        "previewOnly": {
                                            "type": "boolean",
                                            "title": "Preview Only",
                                            "description": "Whether this graph is rendered in the preview only."
                                        },                                                                             
                                        "colours": {
                                            "type": "array",
                                            "title": "Colours array.",
                                            "description": "An array of colour description objects.",
                                            "items": {
                                                "type": "object",
                                                "title": "Colour description object",
                                                "description": "An object that defines the configuration of an element in the colour look-up table.",
                                                "additionalItems": false,
                                                "properties": {
                                                    "value": {
                                                        "type": "integer",
                                                        "title": "Value",
                                                        "description": "The value at which the intensity of the specified colour peaks."
                                                    },
                                                    "colour": {
                                                        "type": "string",
                                                        "title": "Colour schema.",
                                                        "description": "The colour in which to render lines with."
                                                    }
                                                },
                                                "required": [
                                                    "value",
                                                    "colour"
                                                ]
                                            }
                                        },
                                        "highlight": {
                                            "type": "object",
                                            "title": "Highlight description object",
                                            "description": "An object that defines the configuration of the highlighting logic applicable to this graph.",
                                            "additionalItems": false,
                                            "properties": {
                                                "units": {
                                                    "type": "string",
                                                    "title": "Units",
                                                    "description": "The of unit of measurement by which to calculate highlighting contribution."
                                                },
                                                "value": {
                                                    "type": "integer",
                                                    "title": "Value",
                                                    "description": "The value to use when calculating highlighting contribution."
                                                },
                                                "colour": {
                                                    "type": "string",
                                                    "title": "Colour",
                                                    "description": "The highlight colour."
                                                }
                                            },
                                            "required": [
                                                "value"
                                            ]
                                        }
                                    },
                                    "required": [
                                        "renderMethod",
                                        "colours"
                                    ]
                                }
                            },
                            "required": [
                                "input",
                                "output"
                            ]
                        }
                    }
                },
                "required": [
                    "updateInterval",
                    "scrollAmount",
                    "graphs"
                ]
            }
        }
    },
    "required": [
        "icons"
    ]
}