Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/appscode/searchlight

🔦 Alerts for Kubernetes
https://github.com/appscode/searchlight

alerting appscode cloud-native docker icinga2 kubernetes nagios

Last synced: 3 months ago
JSON representation

🔦 Alerts for Kubernetes

Host: GitHub
URL: https://github.com/appscode/searchlight
Owner: ops-center
License: apache-2.0
Created: 2016-12-21T07:21:34.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2023-03-04T22:57:47.000Z (over 1 year ago)
Last Synced: 2024-05-03T04:53:36.251Z (6 months ago)
Topics: alerting, appscode, cloud-native, docker, icinga2, kubernetes, nagios
Language: Go
Homepage: https://appscode.com/products/searchlight
Size: 43.5 MB
Stars: 320
Watchers: 18
Forks: 24
Open Issues: 35
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

k8s_awesome_document - Searchlight - --Searchlight by AppsCode是Kubernetes的Icinga运营商。Searchlight定期对Kubernetes集群进行各种检查，如果出现问题，会通过电子邮件、短信或聊天提醒你。Searchlight包括一套默认的支票，专门为Kubernetes写的。此外，它还可以通过外部黑箱监视增强Prometheus监视，并在内部系统完全失败时充当后备。 (🏗相关开源项目 / 监控工具)

README

        [![Go Report Card](https://goreportcard.com/badge/github.com/appscode/searchlight)](https://goreportcard.com/report/github.com/appscode/searchlight)

[![Build Status](https://travis-ci.org/searchlight/searchlight.svg?branch=master)](https://travis-ci.org/searchlight/searchlight)

[![codecov](https://codecov.io/gh/searchlight/searchlight/branch/master/graph/badge.svg)](https://codecov.io/gh/searchlight/searchlight)

[![Docker Pulls](https://img.shields.io/docker/pulls/appscode/searchlight.svg)](https://hub.docker.com/r/appscode/searchlight/)

[![Slack](https://slack.appscode.com/badge.svg)](https://slack.appscode.com)

[![Twitter](https://img.shields.io/twitter/follow/appscodehq.svg?style=social&logo=twitter&label=Follow)](https://twitter.com/intent/follow?screen_name=AppsCodeHQ)

# Searchlight



Searchlight by AppsCode is a Kubernetes operator for [Icinga](https://www.icinga.com/). If you are running production workloads in Kubernetes, you probably want to be alerted when things go wrong. Icinga periodically runs various checks on a Kubernetes cluster and sends notifications if detects an issue. It also nicely supplements whitebox monitoring tools like, [Prometheus](https://prometheus.io/) with blackbox monitoring can catch problems that are otherwise invisible, and also serves as a fallback in case internal systems completely fail. Searchlight is a CRD controller for Kubernetes built around Icinga to address these issues. Searchlight can do the following things for you:

 - Periodically run various checks on a Kubernetes cluster and its nodes or pods.

 - Includes a [suite of check commands](/docs/reference/hyperalert/hyperalert.md) written specifically for Kubernetes.

 - Searchlight can send notifications via Email, SMS or Chat.

 - [Supplements](https://prometheus.io/docs/practices/alerting/#metamonitoring) the whitebox monitoring tools like [Prometheus](https://prometheus.io).

## Supported Versions

Please pick a version of Searchlight that matches your Kubernetes installation.

| Searchlight Version                                                                      | Docs                                                                       | Kubernetes Version |

|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|--------------------|

| [8.0.0](https://github.com/appscode/searchlight/releases/tag/8.0.0) (uses CRD) | [User Guide](https://appscode.com/products/searchlight/8.0.0/welcome/)| 1.9.x+ (test/qa clusters) |

| [7.0.0](https://github.com/appscode/searchlight/releases/tag/7.0.0) (uses CRD)           | [User Guide](https://appscode.com/products/searchlight/7.0.0/welcome/)     | 1.8.x              |

| [5.1.1](https://github.com/appscode/searchlight/releases/tag/5.1.1) (uses CRD)           | [User Guide](https://appscode.com/products/searchlight/5.1.1/welcome/)     | 1.7.x+             |

| [3.0.1](https://github.com/appscode/searchlight/releases/tag/3.0.1) (uses TPR)           | [User Guide](https://github.com/appscode/searchlight/tree/3.0.1/docs)      | 1.5.x - 1.7.x      |

## Installation

To install Searchlight, please follow the guide [here](https://appscode.com/products/searchlight/8.0.0/setup/install).

## Using Searchlight

Want to learn how to use Searchlight? Please start [here](https://appscode.com/products/searchlight/8.0.0).

## Searchlight API Clients

You can use Searchlight api clients to programmatically access its CRD objects. Here are the supported clients:

- Go: [https://github.com/appscode/searchlight](/client/clientset/versioned)

- Java: https://github.com/searchlight-client/java

## Contribution guidelines

Want to help improve Searchlight? Please start [here](https://appscode.com/products/searchlight/8.0.0/welcome/contributing).

---

**Searchlight binaries collects anonymous usage statistics to help us learn how the software is being used and

how we can improve it. To disable stats collection, run the operator with the flag** `--enable-analytics=false`.

---

## Acknowledgement

 - Many thanks to [Icinga](https://www.icinga.com/) project.

## Support

We use Slack for public discussions. To chit chat with us or the rest of the community, join us in the [AppsCode Slack team](https://appscode.slack.com/messages/C8M7LT2QK/details/) channel `#searchlight_`. To sign up, use our [Slack inviter](https://slack.appscode.com/).

If you have found a bug with Searchlight or want to request for new features, please [file an issue](https://github.com/appscode/searchlight/issues/new).