Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Botkube specific metrics missing #860

Open
bygui86 opened this issue Nov 22, 2022 · 1 comment
Open

Botkube specific metrics missing #860

bygui86 opened this issue Nov 22, 2022 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@bygui86
Copy link

bygui86 commented Nov 22, 2022

Overview

Botkube doesn't expose any specific metrics related to itself, for example:

  • number of configured communications
  • number of configured sources
  • number of configured executors
  • total events evaluated by botkube
  • total events evaluated by each single source
  • total commands executed by botkube
  • total commands executed by each single executor

Acceptance Criteria

  • Botkube exposes custom, specific metrics related to itself
  • metrics must have botkube_ as prefix
  • metrics to be exposed:
    • botkube_configured_communications as gauge with labels like "id=communication-id"
    • botkube_configured_sources as gauge with labels like "id=source-id"
    • botkube_configured_executors as gauge with labels like "id=executor-id"
    • botkube_total_evaluated_events_count as counter
    • botkube_source_evaluated_events_count as counter with labels like "source=source-id"
    • botkube_total_executed_commands_count as counter
    • botkube_executor_executed_commands_count as counter with labels like "executor=executor-id"

Most probably the list of possible metrics is not complete, so I invite maintainers and users to extend this list :)

Reason

A big piece of Botkube observability is missing, together with the possibility to define alarms based on specific aspects of Botkube.
Examples of alarm:

  • I define a source that is too permissive and risk to overwhelmed the Slack channel
  • I define a source that is too restrictive, not delivering any notifications in last 1h
@bygui86 bygui86 added the enhancement New feature or request label Nov 22, 2022
@pkosiec pkosiec added this to Botkube Jun 1, 2023
@pkosiec pkosiec added the good first issue Good for newcomers label Jun 1, 2023
@swastik959
Copy link

@pkosiec hello I want to work on the issue can you please guide to the file where I have to perform the action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
Status: No status
Development

No branches or pull requests

3 participants