summaryrefslogtreecommitdiffstats
path: root/spec/snmptrap-collector-component-spec.json
blob: e9f827efcecec306fdc14841d850f618eefe163f (plain)
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
{
        "self": {
                "version": "1.4.0",
                "name": "snmptrap-collector",
                "description": "Collector for receiving SNMP traps and publishing to DMAAP/MR",
                "component_type": "docker"
        },
        "streams": {
                "subscribes": [

                ],
                "publishes": [
                        {
                                "format": "snmptrap_output",
                                "version": "1.3.0",
                                "type": "message router",
                                "config_key": "snmp_trap"
                        }
                ]
        },
        "services": {
                "calls": [],
                "provides": []
        },
        "parameters": [
                    {
                        "name": "sw_interval_in_seconds",
                        "value": "60",
                        "description": "StormWatch sample interval",
                        "designer_editable" : false,
                        "policy_editable" : false,
                        "sourced_at_deployment" : false
                    },
                    {
                        "name": "StormWatchPolicy",
                        "description": "Configure storm watch control parameters via Policy",
                        "sourced_at_deployment": false,
                        "designer_editable": true,
                        "policy_editable": true,
                        "policy_group": "DCAE.Config_StormWatch",
                        "policy_schema": [
                            {
                                "name": "sw_trap_config",
                                "description": "List of storm watch control rules",
                                "type": "list",
                                "entry_schema": [
                                    {
                                        "name": "sw_notify_oid",
                                        "description": "Stormwatch notify oid",
                                        "type": "string",
                                        "value": ""
                                    },
                                    {
                                        "name": "sw_high_water_in_interval",
                                        "description": "Onset number of traps in interval",
                                        "type": "string",
                                        "value": ""
                                    },
                                    {
                                        "name": "sw_low_water_in_interval",
                                        "description": "Clearing number of traps in interval",
                                        "type": "string",
                                        "value": ""
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "name": "Protocols",
                        "description": "Protocol parameters",
                        "sourced_at_deployment": false,
                        "designer_editable": false,
                        "policy_editable": false,
                        "value": [
                            {
                                "name": "ipv4_interface",
                                "description": "ipv4 address trap receiver should listen to (0.0.0.0 -> all)",
                                "value": "0.0.0.0"
                            },
                            {
                                "name": "ipv4_port",
                                "description": "port trap receiver should bind to for ipv4 traps",
                                "value": "162"
                            },
                            {
                                "name": "ipv6_interface",
                                "description": "ipv6 address trap receiver should listen to (::FFFF:0:0 -> all)",
                                "value": "::FFFF:0:0"
                            },
                            {
                                "name": "ipv6_port",
                                "description": "port trap receiver should bind to for ipv6 traps",
                                "value": "162"
                            }
                        ]
                    },
                    {
                        "name": "Cache",
                        "description": "Cache parameters",
                        "sourced_at_deployment": false,
                        "designer_editable": false,
                        "policy_editable": false,
                        "value": [
                            {
                                "name": "dns_cache_ttl_seconds",
                                "description": "dns cache ttl in seconds",
                                "value": "60"
                            }
                        ]
                    },
                    {
                        "name": "Files",
                        "description": "Files parameters",
                        "sourced_at_deployment": false,
                        "designer_editable": false,
                        "policy_editable": false,
                        "value": [
                            {
                                "name": "arriving_traps_log",
                                "description": "log for all traps accepted by receiver",
                                "value": "snmptrapd_arriving_traps.log"
                            },
                            {
                                "name": "data_dir",
                                "description": "directory for published traps (json)",
                                "value": "data"
                            },
                            {
                                "name": "eelf_audit",
                                "description": "eelf audit log",
                                "value": "audit.log"
                            },
                            {
                                "name": "eelf_base_dir",
                                "description": "base directory for eelf logs",
                                "value": "/opt/app/snmptrap/logs"
                            },
                            {
                                "name": "eelf_debug",
                                "description": "eelf debug log",
                                "value": "debug.log"
                            },
                            {
                                "name": "eelf_error",
                                "description": "eelf error log",
                                "value": "error.log"
                            },
                            {
                                "name": "eelf_metrics",
                                "description": "eelf metrics log",
                                "value": "metrics.log"
                            },
                            {
                                "name": "log_dir",
                                "description": "logs directory",
                                "value": "logs"
                            },
                            {
                                "name": "minimum_severity_to_log",
                                "description": "minimun severity to log",
                                "value": "2"
                            },
                            {
                                "name": "perm_status_file",
                                "description": "permanent status log",
                                "value": "snmptrapd_status.log"
                            },
                            {
                                "name": "pid_dir",
                                "description": "directory for pid file",
                                "value": "tmp"
                            },
                            {
                                "name": "roll_frequency",
                                "description": "frequency of log file rolls",
                                "value": "hour"
                            },
                            {
                                "name": "runtime_base_dir",
                                "description": "base directory for runtime files",
                                "value": "hour"
                            },
                            {
                                "name": "snmptrapd_diag",
                                "description": "diagnostic program log",
                                "value": "snmptrapd_prog_diag.log"
                            },
                            {
                                "name": "traps_stats_log",
                                "description": "traps statistics log",
                                "value": "snmptrapd_stats.csv"
                            }
                        ]
                    },
                    {
                        "name": "Publisher",
                        "description": "Publisher parameters",
                        "sourced_at_deployment": false,
                        "designer_editable": false,
                        "policy_editable": false,
                        "value": [
                            {
                                "name": "http_milliseconds_between_retries",
                                "description": "milliseconds between publish retries",
                                "value": "750"
                            },
                            {
                                "name": "http_peer_publisher",
                                "description": "peer publisher",
                                "value": "unavailable"
                            },
                            {
                                "name": "http_primary_publisher",
                                "description": "primary publisher",
                                "value": "true"
                            },
                            {
                                "name": "http_retries",
                                "description": "retries for publish attempts",
                                "value": "3"
                            },
                            {
                                "name": "http_timeout_milliseconds",
                                "description": "milliseconds for publish timeout",
                                "value": "1500"
                            },
                            {
                                "name": "max_milliseconds_between_publishes",
                                "description": "max milliseconds between publishes",
                                "value": "10000"
                            },
                            {
                                "name": "max_traps_between_publishes",
                                "description": "max traps between publishes",
                                "value": "10"
                            }
                        ]
                    }
                ],
        "auxilary": {
                "healthcheck": {
                        "type": "docker",
                        "interval": "300s",
                        "timeout": "120s",
                        "script": "/opt/app/snmptrap/bin/healthcheck.sh"
                },
                "reconfigs": {
                        "dti": "/opt/app/snmptrap/bin/snmptrapd.sh reloadCfg"
                },
                "ports": [
                        "6162:162"
                ]
        },
        "artifacts": [
                {
                        "type": "docker image",
                        "uri": "nexus.onap.org:10001/snapshots/onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0"
                }
        ]
}