File: README.md

package info (click to toggle)
ntopng 5.2.1%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 121,832 kB
  • sloc: javascript: 143,431; cpp: 71,175; ansic: 11,108; sh: 4,687; makefile: 911; python: 587; sql: 512; pascal: 234; perl: 118; ruby: 52; exp: 4
file content (22 lines) | stat: -rw-r--r-- 1,718 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Plugins
-------

This is the root plugins folder. Plugins can be placed directly into this folder or inside sub-folders. Sub-folders can have any name, however, to keep plugins logically organized, the following sub-folders have been defined:

- `alerts`. Contains plugins whose main function is to generate alerts. As alerts can be broadly divided into categories, additional sub-folders have been defined for alerts:

  - `security`: Security behaviors and anomalies (e.g, contacts from or to a blacklisted host, TCP and UDP scans)
  - `system`: Functionalities of the system on top of which ntopng is running (e.g, disk space full, load too high)
  - `network`: Network behaviors and anomalies (e.g., traffic above a certain threshold, TCP not working as expected) 
  - `internals`: Internal functionalitis of ntopng (e.g., memory management and host and flows lifecycles) 
  
- `endpoints`. Contains plugins implementing alert endpoints, that is, plugins in charge of delivering alerts to external endpoints (e.g., to Discord, Slack and Telegram).
  
- `collectors`. Contains plugins for the collection of external data. These are basically input-plugins which receive external data and combine it with ntopng network data. Examples are the Suricata and the Fortinet collectors.

- `monitors`. Contains plugins for the monitoring the system and the network. For this reason, two additional sub-folders have been defined for monitors:

  - `system`: For monitors of the system on top of which ntopng is running (e.g., a Redis monitor, and a Disk space monitor)
  - `network`: For monitors of the network (e.g., an active monitor which implements icmp/http/https pings).
  
 - `examples`. Contains example plugins.