Skip to content

Commit f42d1ae

Browse files
chg: [user-manual] Added section about the monitoring of the system.
1 parent ac313ae commit f42d1ae

File tree

4 files changed

+66
-0
lines changed

4 files changed

+66
-0
lines changed

content/user-manual/_index.md

+1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@ The Vulnerability-Lookup software is a powerful tool designed to assist security
1111
- [Correlations](./correlations)
1212
- [Email notification](./email-notification)
1313
- [Sightings](./sightings)
14+
- [System monitoring](./system-monitoring)
1415
- [PyVulnerabilityLookup](./pyvulnerabilitylookup)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: "System monitoring"
3+
description: How to check the system health
4+
toc: true
5+
---
6+
7+
## Presentation
8+
9+
Vulnerability-Lookup offers multiple methods for assessing system health, including monitoring key satellite components such as sighting tools, the email notification system, and data feeders.
10+
11+
12+
## Admin Panel
13+
14+
### Processes heartbeat signals and logs
15+
16+
[![Processes heartbeat signals and logs](/images/user-manual/system-health/heartbeats.png)](/images/user-manual/system-health/heartbeats.png)
17+
18+
As shown in this example, the activity of all sighting tools is centralized in the Valkey keystore and displayed in the second table (*Logs*).
19+
The primary goal of the first table (*Heartbeats*) is to detect abnormal states in any of the feeders.
20+
21+
22+
### Feeders logs
23+
24+
[![Feeders logs](/images/user-manual/system-health/feeders.png)](/images/user-manual/system-health/feeders.png)
25+
26+
27+
## API
28+
29+
Various endpoints for checking the system health are also provided through the [API](https://vulnerability.circl.lu/api/).
30+
31+
Examples:
32+
33+
```bash
34+
$ curl https://vulnerability.circl.lu/api/system/redis_up
35+
true
36+
37+
$ curl https://vulnerability.circl.lu/api/system/checkSMTP -H 'X-API-KEY: <YOUR-API-KEY>'
38+
true
39+
40+
$ curl --silent https://vulnerability.circl.lu/api/system/checkProcess -H 'X-API-KEY: <YOUR-API-KEY>' | jq .
41+
{
42+
"process_heartbeat_BlueskySight": "2025-02-19T09:28:26.490720+00:00",
43+
"process_heartbeat_FediVuln": "2025-02-19T09:28:20.458222+00:00",
44+
"process_heartbeat_FediVuln-Publish_bundle": "2025-02-19T09:28:24.997171+00:00",
45+
"process_heartbeat_FediVuln-Publish_comment": "2025-02-19T09:28:24.429215+00:00",
46+
"process_heartbeat_GistSight": "2025-02-19T09:28:20.658896+00:00",
47+
"process_heartbeat_MISPSight": "2025-02-19T09:15:02.327831+00:00",
48+
"process_heartbeat_NucleiVuln": "2025-02-19T09:00:02.090251+00:00",
49+
"process_heartbeat_ShadowSight": "2025-02-18T10:15:02.197351+00:00",
50+
"process_heartbeat_email-notification": "2025-02-19T09:28:24.820832+00:00"
51+
}
52+
```
53+
54+
55+
## Files
56+
57+
Each feeder has a dedicated log file, stored in the ``logs/`` folder at the root of the project.
58+
59+
The configuration files for these log files can be found in:
60+
61+
- ``vulnerabilitylookup/feeders/*_logging.json``
62+
- or in ``vulnerabilitylookup/feeders/<source>/``
63+
64+
For example: ``vulnerabilitylookup/feeders/nvd_logging.json``
65+
Loading
Loading

0 commit comments

Comments
 (0)