folderstats_exporter

= folderstats exporter
man-at-home
v1.1, 2016-11-10

:icons: font

image:https://badge.waffle.io/man-at-home/folderstats_exporter.svg?label=ready&title=Ready["Stories in Ready",link="http://waffle.io/man-at-home/folderstats_exporter"] 
image:https://goreportcard.com/badge/github.com/man-at-home/folderstats_exporter["goreport",link="https://goreportcard.com/report/github.com/man-at-home/folderstats_exporter]


image:https://circleci.com/gh/man-at-home/folderstats_exporter/tree/master.svg?style=svg["CircleCI", link="https://circleci.com/gh/man-at-home/folderstats_exporter/tree/master"]
linux:
image:https://drone.io/github.com/man-at-home/folderstats_exporter/status.png["Build Status",link="https://drone.io/github.com/man-at-home/folderstats_exporter/latest"]
windows:
image:https://ci.appveyor.com/api/projects/status/65hxk8erdjl86gyg/branch/master?svg=true["Build status",link="https://ci.appveyor.com/project/man-at-home/folderstats-exporter/branch/master"]


A https://prometheus.io/[prometheus.io] exporter for directory contents.

NOTE: this prometheus exporter is not in use anymore.


== Metrics

The following metrics for a monitored directory path are currently exposed:

* _folderstats_files_created_  monitored file creation events in path counter
* _folderstats_files_modified_ monitored file modification events in path counter
* _folderstats_files_deleted_  monitored file deletion (or moved out of path) events counter
* _folderstats_files_in_path_  (up to a limit of 1024) current children in path gauge

== Install

[source, bash]
----
go get -u github.com/man-at-home/folderstats_exporter
----

== Running

[source, bash]
----
/../folderstats -path-to-watch c:\EEK -web.listen-address :9109
----

|===
| argument                  | value 

|-path-to-watch             | Full (existing) directory path to watch for changes (defaults to "c:/temp", sorry), multiple paths possible
|-suffix                    | Restrict Counting to specific File Suffixes like *.pdf, (defaults to .*) 
|-web.listen-address        | Address to listen on for web interface and telemetry. (defaults to ":9161")
|-web.telemetry-path string | Path under which to expose metrics. (defaults to "/metrics")
|===

[NOTE]
====
at the moment only built and used on m$ win server 2012.
====