Skip to content

Outdated documentation of Prometheus metrics #1024

@bastienlc

Description

@bastienlc

The version 1.7 of the documentation on Prometheus metrics (here or here) doesn't correspond to the actual metrics exposed by the Prometheus endpoint.

Using crowdsec Docker image v1.7.6 the following metrics appear to exist but are not documented:

  • cs_active_decisions
  • cs_alerts
  • cs_appsec_block_total
  • cs_appsec_inband_parsing_time_seconds_bucket
  • cs_appsec_inband_parsing_time_seconds_count
  • cs_appsec_inband_parsing_time_seconds_sum
  • cs_appsec_outband_parsing_time_seconds_bucket
  • cs_appsec_outband_parsing_time_seconds_count
  • cs_appsec_outband_parsing_time_seconds_sum
  • cs_appsec_parsing_time_seconds_bucket
  • cs_appsec_parsing_time_seconds_count
  • cs_appsec_parsing_time_seconds_sum
  • cs_appsec_reqs_total
  • cs_appsec_rule_hits
  • cs_lapi_request_duration_seconds_bucket
  • cs_lapi_request_duration_seconds_count
  • cs_lapi_request_duration_seconds_sum
  • cs_node_wl_hits_ok_total
  • cs_node_wl_hits_total
  • cs_parsing_time_seconds_bucket
  • cs_parsing_time_seconds_count
  • cs_parsing_time_seconds_sum
  • cs_regexp_cache_size

The following metrics are documented but don't seem to exist anymore:

  • cs_bucket_created_total

The following metrics are documented, exist in the source code, but were not reported by my endpoint (optional metrics ?):

  • cs_buckets
  • cs_bucket_overflowed_total
  • cs_bucket_underflowed_total
  • cs_bucket_poured_total
  • cs_cloudwatch_openstreams_total
  • cs_cloudwatch_stream_hits_total
  • cs_journalctlsource_hits_total
  • cs_syslogsource_hits_total
  • cs_syslogsource_parsed_total
  • cs_lapi_decisions_ko_total
  • cs_lapi_decisions_ok_total

The following metrics are documented and exist (no change needed):

  • cs_filesource_hits_total
  • cs_info
  • cs_lapi_bouncer_requests_total
  • cs_lapi_machine_requests_total
  • cs_lapi_route_requests_total
  • cs_node_hits_ko_total
  • cs_node_hits_ok_total
  • cs_node_hits_total
  • cs_parser_hits_ko_total
  • cs_parser_hits_ok_total
  • cs_parser_hits_total

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions