Sign inSign up

gameguyalien/clamav_exporter

By gameguyalien

Updated about 1 month ago

Export ClamAV daemon stats via a TCP socket to Prometheus.

Image
Monitoring & observability
0

764

gameguyalien/clamav_exporter repository overview

ClamAV Exporter

Fork of ClamAV Exporter from sergeymakinen

I plan to keep this project in more of a maintenance mode, unless PRs are submitted with vaild new features. I'll do My best to keep the project updated to maintain good cyber posture.

tests Go Reference Go Report Card codecov Docker Pulls

Export ClamAV daemon stats via a TCP socket to Prometheus.

To run it:

make
./clamav_exporter [flags]

Using Docker

You can deploy this exporter using the gameguyalien/clamav_exporter Docker image.

For example:

docker pull gameguyalien/clamav_exporter

docker run -d -p 9906:9906 gameguyalien/clamav_exporter\
  --clamav.address tcp://clamav:3310

Exported metrics

MetricMeaningLabels
clamav_upWas the last scrape successful.
clamav_versionThe version of this ClamAV.version
clamav_db_versionCurrently installed ClamAV Virus Database version.
clamav_db_timestamp_secondsUnix timestamp of the ClamAV Virus Database build time.
clamav_pool_stateState of the thread pool.index, primary
clamav_pool_live_threadsNumber of live threads in the pool.index, primary
clamav_pool_idle_threadsNumber of idle threads in the pool.index, primary
clamav_pool_max_threadsMaximum number of threads in the pool.index, primary
clamav_pool_idle_timeout_threadsNumber of idle timeout threads in the pool.index, primary
clamav_pool_queue_lengthNumber of items in the pool queue.index, primary
clamav_pool_queue_min_wait_secMinimum time a currently queued item has been waiting.index, primary
clamav_pool_queue_max_wait_secMaximum time a currently queued item has been waiting.index, primary
clamav_pool_queue_avg_wait_secAverage time that currently queued items have been waiting.index, primary
clamav_memory_heap_bytesNumber of bytes allocated on the heap.
clamav_memory_mmap_bytesNumber of bytes currently allocated using mmap.
clamav_memory_used_bytesNumber of bytes used by in-use allocations.
clamav_memory_free_bytesNumber of bytes in free blocks.
clamav_memory_releasable_bytesNumber of bytes releasable at the heap.
clamav_memory_pools_used_bytesNumber of bytes currently used by all pools.
clamav_memory_pools_total_bytesNumber of bytes available to all pools.
Pool state mapping
NameState value
INVALID0
VALID1
EXIT2

Flags

./clamav_exporter --help
  • clamav.address: ClamAV daemon socket address. Example: tcp://127.0.0.1:3310.
  • clamav.timeout: ClamAV daemon socket timeout.
  • clamav.retries: ClamAV daemon socket connect retries. 0 by default.
  • web.listen-address: Address to listen on for web interface and telemetry.
  • web.telemetry-path: Path under which to expose metrics.
  • log.level: Logging level. info by default.
  • log.format: Set the log target and format. Example: logger:syslog?appname=bob&local=7 or logger:stdout?json=true.
TLS and basic authentication

The clamav_exporter supports TLS and basic authentication. To use TLS and/or basic authentication, you need to pass a configuration file using the --web.config.file parameter. The format of the file is described in the exporter-toolkit repository.

Tag summary

Content type

Image

Digest

sha256:1241a5269

Size

5.9 MB

Last updated

about 1 month ago

docker pull gameguyalien/clamav_exporter