README.md

Tutorials

This section contains tutorials on how to use Searchlight. Please visit the links below to learn more:

• ClusterAlerts - This article introduces the concept of ClusterAlert to periodically run various checks on a Kubernetes cluster. Also, visit the links below to learn about the available check commands for a cluster:

  • ca_cert - To check expiration of CA certificate used by Kubernetes api server.
  • component_status - To check Kubernetes component status.
  • event - To check Kubernetes Warning events.
  • json_path - To check any JSON HTTP response using jq.
  • node_exists - To check existence of Kubernetes nodes.
  • pod_exists - To check existence of Kubernetes pods.

• NodeAlerts - This article introduces the concept of NodeAlert to periodically run various checks on nodes in a Kubernetes cluster. Also, visit the links below to learn about the available check commands for nodes:

  • influx_query - To check InfluxDB query result.
  • node_status - To check Kubernetes Node status.
  • node_volume - To check Node Disk stat.

• PodAlerts - This article introduces the concept of PodAlert to periodically run various checks on pods in a Kubernetes cluster. Also, visit the links below to learn about the available check commands for pods:

  • influx_query - To check InfluxDB query result.
  • pod_exec - To check Kubernetes exec command. Returns OK if exit code is zero, otherwise, returns CRITICAL
  • pod_status - To check Kubernetes pod status.
  • pod_volume - To check Pod volume stat.

• Supported Notifiers: This article documents how to configure Searchlight to send notifications via Email, SMS or Chat.