hub / github.com/kubeshop/botkube

github.com/kubeshop/botkube @v1.14.0 sqlite

repository ↗ · DeepWiki ↗ · release v1.14.0 ↗

3,054 symbols 9,053 edges 389 files 1,248 documented · 41%

README

Botkube is a messaging bot for monitoring and debugging Kubernetes clusters.

Overview

Botkube is a troubleshooting and monitoring solution that empowers DevOps teams to work more efficiently, enables developers to troubleshoot their applications without special Kubernetes access or knowledge, and improves reliability by delivering timely, context-enhanced notifications about events in your Kubernetes environments. It integrates with multiple communication platforms, such as Slack, Discord, or Mattermost. Botkube monitors events from various sources, allows you to securely run commands, and run automated actions triggered by any of the plugins Botkube supports or your own custom plugins.

You can also execute kubectl, helm and other commands on your K8s, which helps debugging an application or cluster.

Getting started

Follow the official Botkube installation guide to get started.

Features

💬 Connect to your clusters from anywhere at any time

Botkube integrates with all common messaging platforms including: - Slack - Discord - Mattermost

💡 Elevate your troubleshooting workflow with intelligent insights

Supercharge your technical workflow with our seamless alert consolidation and filtering. Gain automated intelligent insights to troubleshoot with precision and efficiency. Get alerted by Kubernetes, Prometheus, and other tools.

🚀 See alerts, Take action

Take your ChatOps experience to new heights and go beyond just monitoring. Seamlessly take action on your clusters with ease and efficiency. Access tools like kubectl and helm right from your collaboration workspace. Collaborate with other team members in real time.

Documentation

For full documentation, visit docs.botkube.io. The documentation sources reside on the botkube-docs repository.

Licence

This project is currently licensed under the MIT License.

Extension points exported contracts — how you extend this code

Executor (Interface)

Executor is an interface for processes to execute commands [6 implementers]

pkg/execute/factory.go

Executor (Interface)

Executor defines the Botkube executor plugin functionality. [6 implementers]

pkg/api/executor/grpc_adapter.go

Platform (Interface)

Platform represents platform notifier [8 implementers]

pkg/notifier/platform.go

Notifier (Interface)

Notifier represents notifier interface [10 implementers]

internal/health/health.go

Reloader (Interface)

Reloader is an interface for reloading configuration. [10 implementers]

internal/config/reloader/reloader.go

Bot (Interface)

Bot connects to communication channels and reads/sends messages. It is a two-way integration. [5 implementers]

pkg/bot/bot.go

Identifiable (Interface)

Identifiable exports an Identifier method. [5 implementers]

pkg/config/config.go

NamespaceLister (Interface)

NamespaceLister provides an option to list all namespaces in a given cluster. [5 implementers]

internal/executor/kubectl/builder/deps.go

Core symbols most depended-on inside this repo

Errorf

called by 338

test/commplatform/discord_tester.go

Errorf

called by 226

internal/analytics/segment_logger_adapter.go

internal/analytics/reporter.go

called by 120

test/commplatform/generic.go

New

called by 112

internal/source/kubernetes/source.go

FirstChannel

called by 102

test/commplatform/generic.go

Debugf

called by 86

internal/cli/printer/status.go

Shape

Method 1,447

Function 796

Struct 628

Interface 98

TypeAlias 66

FuncType 19

Languages

Go100%

Modules by API surface

internal/remote/graphql/models_gen.go228 symbols

pkg/api/source/source.pb.go117 symbols

pkg/api/executor/executor.pb.go98 symbols

pkg/config/config.go83 symbols

pkg/api/message.go50 symbols

test/commplatform/slack_tester.go46 symbols

test/commplatform/teams_tester.go41 symbols

test/commplatform/generic.go38 symbols

test/commplatform/discord_tester.go38 symbols

pkg/api/cloudteams/cloud_teams.pb.go36 symbols

pkg/api/source/source_grpc.pb.go33 symbols

internal/executor/kubectl/builder/kubectl_test.go32 symbols

Dependencies from manifests, versioned

cloud.google.com/gov0.110.10 · 1×

cloud.google.com/go/computev1.23.3 · 1×

cloud.google.com/go/compute/metadatav0.2.3 · 1×

cloud.google.com/go/iamv1.1.5 · 1×

cloud.google.com/go/pubsubv1.35.0 · 1×

cloud.google.com/go/storagev1.31.0 · 1×

github.com/99designs/gqlgenv0.17.45 · 1×

github.com/AdaLogics/go-fuzz-headersv0.0.0-2023081113042 · 1×

github.com/AlecAivazis/survey/v2v2.3.7 · 1×

github.com/Azure/azure-sdk-for-go/sdk/azcorev1.9.1 · 1×

github.com/Azure/azure-sdk-for-go/sdk/azidentityv1.5.1 · 1×

github.com/Azure/azure-sdk-for-go/sdk/internalv1.5.1 · 1×

For agents

$ claude mcp add botkube \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact