Add the documentation into crowdsec repo

2020-05-15 16:58:24 +02:00

Observability Overview

Observability in security software is crucial, especially when this software might take important decision such as blocking IP addresses.

We attempt to provide good observability of {{crowdsec.name}}'s behavior :

{{crowdsec.name}} itself exposes a prometheus instrumentation
{{cli.Name}} allows you to view part of prometheus metrics in cli ({{cli.bin}} metrics)
{{crowdsec.name}} logging is contextualized for easy processing
for humans, {{cli.name}} allows you to trivially start a service exposing dashboards (using metabase)

Furthermore, most of {{crowdsec.name}} configuration should allow you to enable partial debug (ie. per-scenario, per-parser etc.)