Skip to content

Commit

Permalink
update(metrics): add Falco metrics docs
Browse files Browse the repository at this point in the history
Signed-off-by: Gianmatteo Palmieri <[email protected]>
  • Loading branch information
mrgian authored and poiana committed Jun 24, 2024
1 parent 33a6f96 commit 0bec1cb
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion content/en/docs/metrics/falco-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ metrics:
state_counters_enabled: true
kernel_event_counters_enabled: true
libbpf_stats_enabled: true
plugins_metrics_enabled: true
convert_memory_to_mb: true
include_empty_values: true
```
Expand Down Expand Up @@ -1258,7 +1259,21 @@ However, following the Prometheus recommendations, there might be some slight di

## Plugins Metrics

As of Falco 0.38.0, it is not possible to use the metrics feature when running plugins without the syscalls source. Near-term improvements in this regard are tracked in the following [issue](https://github.com/falcosecurity/falco/issues/3194#issuecomment-2111009270).
Since version 0.38.1, Falco allows plugins to provide their own set of [custom metrics](/docs/reference/plugins/plugin-api-reference/#get-metrics).

In order to enable plugins metrics, the following configuration elements must be set in the [falco.yaml][1]:

```yaml
metrics:
enabled: true
...
plugins_metrics_enabled: true
...
```

Please note that this doesn't provide default metrics about the plugin itself, and it will show metrics only if the plugin is providing them.

Currently, none of the officially maintained plugins provides any metric, but this will change in the future.

## Breaking Changes

Expand Down

0 comments on commit 0bec1cb

Please sign in to comment.