ErXBout/clamav-rest
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README with Prometheus

Browse source
This commit is contained in:
Flavio Meyer 2020-09-01 13:08:10 +02:00
parent ae6687b7d2
commit 83906fe937
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -8,8 +8,9 @@
- [Configuration](#configuration) - [Configuration](#configuration)
- [Environment Variables](#environment-variables) - [Environment Variables](#environment-variables)
- [Networking](#networking) - [Networking](#networking)
- [Maintenance](#maintenance) - [Maintenance / Monitoring](#maintenance-/-monitoring)
- [Shell Access](#shell-access) - [Shell Access](#shell-access)
- [Developing](#developing) - [Developing](#developing)
- [References](#references) - [References](#references)
@ -134,7 +135,7 @@ Below is the complete list of available options that can be used to customize yo
|-----------|-------------| |-----------|-------------|
| `3310` | ClamD Listening Port | | `3310` | ClamD Listening Port |
# Maintenance # Maintenance / Monitoring
## Shell Access ## Shell Access
@ -143,6 +144,15 @@ For debugging and maintenance purposes you may want access the containers shell.
```bash ```bash
docker exec -it (whatever your container name is e.g. clamav-rest) /bin/sh docker exec -it (whatever your container name is e.g. clamav-rest) /bin/sh
``` ```
## Prometheus
[Prometheus metrics](https://prometheus.io/docs/guides/go-application/) were implemented, which can be retrieved as follows
**HTTP**:
curl http://localhost:9000/metrics
**HTTPS:**
curl https://localhost:9443/metrics
# Developing # Developing