ajunlonglive / kwatch

:eyes: monitor & detect crashes in your Kubernetes(K8s) cluster instantly

kwatch helps you monitor all changes in your Kubernetes(K8s) cluster, detects crashes in your running apps in realtime, and publishes notifications to your channels (Slack, Discord, etc.) instantly

⚡️ Getting Started

Install

You need to get config template to add your configs

curl  -L https://raw.githubusercontent.com/abahmed/kwatch/v0.3.0/deploy/config.yaml -o config.yaml

Then edit config.yaml file and apply your configuration

kubectl apply -f config.yaml

To deploy kwatch, execute following command:

kubectl apply -f https://raw.githubusercontent.com/abahmed/kwatch/v0.3.0/deploy/deploy.yaml

Configuration

General

Parameter	Description
maxRecentLogLines	Optional Max tail log lines in messages, if it's not provided it will get all log lines
namespaces	Optional list of namespaces that you want to watch, if it's not provided it will watch all namespaces

Slack

If you want to enable Slack, provide the webhook with optional text and title

Parameter	Description
alert.slack.webhook	Slack webhook URL
alert.slack.title	Customized title in slack message
alert.slack.text	Customized text in slack message

Discord

If you want to enable Discord, provide the webhook with optional text and title

Parameter	Description
alert.discord.webhook	Discord webhook URL
alert.discord.title	Customized title in discord message
alert.discord.text	Customized text in discord message

PagerDuty

If you want to enable PagerDuty, provide the integration key

Parameter	Description
alert.pagerduty.integrationKey	PagerDuty integration key more info

Telegram

If you want to enable Telegram, provide a valid token and the chat Id.

Parameter	Description
alert.telegram.token	Telegram token
alert.telegram.chatId	Telegram chat id

Microsoft Teams

If you want to enable Microsoft Teams, provide the channel webhook.

Parameter	Description
alert.teams.webhook	webhook Microsoft team
alert.teams.title	Customized title in Microsoft teams message
alert.teams.text	Customized title in Microsoft teams message

Rocket Chat

If you want to enable Rocket Chat, provide the webhook with optional text

Parameter	Description
alert.rocketchat.webhook	Rocket Chat webhook URL
alert.rocketchat.text	Customized text in rocket chat message

Cleanup

kubectl delete -f https://raw.githubusercontent.com/abahmed/kwatch/v0.3.0/deploy/config.yaml
kubectl delete -f https://raw.githubusercontent.com/abahmed/kwatch/v0.3.0/deploy/deploy.yaml

👍 Contribute & Support

• Add a GitHub Star
• Suggest new features, ideas and optimizations
• Report issues

🚀 Who uses kwatch?

kwatch is being used by multiple entities including, but not limited to

If you want to add your entity, open issue to add it

💻 Contributors

⭐️ Stargazers

👋 Get in touch!

Feel free to chat with us on Discord if you have questions, or suggestions

⚠️ License

kwatch is licensed under MIT License