New to Searchlight? Please start here.
Check json_path
Check command json_path is used to check JSON HTTP response using jq queries.
Spec
json_path check command has no variables.
url - URL to get datasecretName - Name of Kubernetes Secret used to call HTTP api.inClusterConfig - Use InClusterConfig if hosted in Kuberneteswarning - Warning jq query which returns [true/false]critical - Critical jq query which returns [true/false]
The following keys are supported for Secret passed via secretName flag.
| Key | Description |
|---|
USERNAME | Optional Username used with Basic auth for HTTP URL. |
PASSWORD | Optional Password used with Basic auth for HTTP URL. |
TOKEN | Optional Token used as Bearer auth for HTTP URL. |
CA_CERT_DATA | Optional PEM encoded CA certificate used by HTTP URL. |
CLIENT_CERT_DATA | Optional PEM encoded Client certificate used by HTTP URL. |
CLIENT_KEY_DATA | Optional PEM encoded Client private key used by HTTP URL. |
INSECURE_SKIP_VERIFY | Optional If set to true, skip certificate verification. |
Execution of this command can result in following states:
Tutorial
Before You Begin
At first, you need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. If you do not already have a cluster, you can create one by using Minikube.
Now, install Searchlight operator in your cluster following the steps here.
To keep things isolated, this tutorial uses a separate namespace called demo throughout this tutorial. Run the following command to prepare your cluster for this tutorial:
$ kubectl create namespace demo
namespace "demo" created
$ kubectl get namespaces
NAME STATUS AGE
default Active 6h
kube-public Active 6h
kube-system Active 6h
demo Active 4m
Check JSON response of HTTP api
In this tutorial, a ClusterAlert will be used check JSON response of a HTTP api.
$ cat ./docs/examples/cluster-alerts/json_path/demo-0.yaml
apiVersion: monitoring.appscode.com/v1alpha1
kind: ClusterAlert
metadata:
name: json-path-demo-0
namespace: demo
spec:
check: json_path
vars:
url: https://api.appscode.com/health/json
critical: '.metadata.env!="prod"'
checkInterval: 30s
alertInterval: 2m
notifierSecretName: notifier-config
receivers:
- notifier: Mailgun
state: CRITICAL
to: ["[email protected]"]
$ kubectl apply -f ./docs/examples/cluster-alerts/json_path/demo-0.yaml
clusteralert "json-path-demo-0" created
$ kubectl describe clusteralert -n demo json-path-demo-0
Name: json-path-demo-0
Namespace: demo
Labels: <none>
Events:
FirstSeen LastSeen Count From SubObjectPath Type Reason Message
--------- -------- ----- ---- ------------- -------- ------ -------
16s 16s 1 Searchlight operator Warning BadNotifier Bad notifier config for ClusterAlert: "json-path-demo-0". Reason: secrets "notifier-config" not found
16s 16s 1 Searchlight operator Normal SuccessfulSync Applied ClusterAlert: "json-path-demo-0"
Voila! json_path command has been synced to Icinga2. Please visit here to learn how to configure notifier secret. Now, open IcingaWeb2 in your browser. You should see a Icinga host demo@cluster and Icinga service json-path-demo-0.
Cleaning up
To cleanup the Kubernetes resources created by this tutorial, run:
If you would like to uninstall Searchlight operator, please follow the steps here.
Next Steps
- To periodically run various checks on nodes in a Kubernetes cluster, use NodeAlerts.
- To periodically run various checks on pods in a Kubernetes cluster, use PodAlerts.
- See the list of supported notifiers here.
- Wondering what features are coming next? Please visit here.
- Want to hack on Searchlight? Check our contribution guidelines.
