编写第一个 Prober

Prober 探测集主要包含具体的探测逻辑以及探测结果的上报，下文将通过一个简单的 Demo 介绍 Prober 的使用与开发方法。

Prober 示例

如下为一个简单的 Prober 示例，其 Spec 主要包含两部分内容：Policy 和 Template。

  • Policy 用于定义 Prober 的运行方式，单次运行或周期运行。若未定义 Policy，则将以 Job 方式运行该 Prober；若定义了 Policy，则将以 Cronjob 的方式运行该 Prober。
  • Template 即 PodSpec，用于描述具体的运行负载 Pod，其探测上报逻辑以镜像的方式保存于 Pod Image 中。
  1. # prober-demo-example.yaml
  3. apiVersion: kubeprober.erda.cloud/v1
  4. kind: Probe
  5. metadata:
  6.   name: prober-demo-example
  7.   namespace: kubeprober
  8. spec:
  9.   # if remove policy block, prober will run as a job; else it will run as a cronjob
  10.   policy:
  11.     # unit: minute
  12.     runInterval: 30
  13.   # template block is podSpec in fact
  14.   template:
  15.     containers:
  16.       - name: prober-demo-example
  17.         image: kubeprober/demo-example:v0.0.1
  18.         resources:
  19.           requests:
  20.             cpu: 10m
  21.             memory: 50Mi
  22.     restartPolicy: Never

运行该 Prober 前，需先 安装 prober-agent 。随后运行该 Prober 执行具体的探测逻辑并上报探测结果，示例如下：

  1. ## 运行上文中的 prober-demo-example.yaml，去掉 policy, 以 job 的方式运行一次
  2. # kubectl apply -f prober-demo-example.yaml
  4. ## 查看 prober
  5. # kubectl -n kubeprober get probe
  6. NAME                  RUNINTERVAL   IMAGE                            AGE
  7. prober-demo-example                 kubeprober/demo-example:v0.0.1   10m
  9. ## 查看 job
  10. # kubectl -n kubeprober get job
  11. NAME                  COMPLETIONS   DURATION   AGE
  12. prober-demo-example   1/1           3s         10m
  14. ## 查看 pod
  15. # kubectl -n kubeprober get pod|grep -i demo
  16. prober-demo-example-jzmnv      0/1     Completed   0          11m
  18. ## 查看运行结果 probestatus
  19. # kubectl -n kubeprober get probestatus
  20. NAME                  STATUS   MESSAGE                              LASTRUN   AGE
  21. prober-demo-example   ERROR    do check item2 failed, reason: ...             11m
  23. # kubectl -n kubeprober get probestatus prober-demo-example -o yaml
  24. apiVersion: kubeprober.erda.cloud/v1
  25. kind: ProbeStatus
  26. metadata:
  27.   name: prober-demo-example
  28.   namespace: kubeprober
  29. spec:
  30.   checkers:
  31.   - name: checker1 item1
  32.     status: PASS
  33.   - message: 'do check item2 failed, reason: ...'
  34.     name: checker1 item2
  35.     status: ERROR
  36. status:
  37.   message: 'do check item2 failed, reason: ...'
  38.   status: ERROR

Prober 编写

上文通过一个已有的 Prober 介绍基本使用方法，下文将通过具体案例介绍如何编写一个简单的 Prober。

Prober 主要包含具体的探测逻辑以及探测结果的上报，其中探测逻辑需要开发者根据具体需求实现，而结果的上报则调用已有的状态上报接口即可。该接口将自动获取注入到该 Prober Pod 的状态上报地址（默认为 prober-agent），随后上报状态。

通过 Golang 编写

  2. package main
  4. import (
  5.     "github.com/sirupsen/logrus"
  7.     kubeproberv1 "github.com/erda-project/kubeprober/apis/v1"
  8.     probestatus "github.com/erda-project/kubeprober/pkg/probe-status"
  9. )
  11. func main() {
  12.     // checker1 item1
  13.     // do real check ..., and get check status
  14.     // prober status shoud be stored in struc: kubeproberv1.ProbeCheckerStatus
  15.     item1 := kubeproberv1.ProbeCheckerStatus{
  16.         Name:    "checker1 item1",
  17.         Status:  kubeproberv1.CheckerStatusPass,
  18.         Message: "",
  19.     }
  21.     // checker1 item2
  22.     // do real check ..., and get check status
  23.     item2 := kubeproberv1.ProbeCheckerStatus{
  24.         Name:    "checker1 item2",
  25.         Status:  kubeproberv1.CheckerStatusError,
  26.         Message: "do check item2 failed, reason: ...",
  27.     }
  29.     // send prober status using: func probestatus.ReportProbeStatus([]kubeproberv1.ProbeCheckerStatus) error
  30.     err := probestatus.ReportProbeStatus([]kubeproberv1.ProbeCheckerStatus{item1, item2})
  31.     if err != nil {
  32.         logrus.Errorf("report probe status failed, error: %v", err)
  33.     }
  34. }

通过 Shell 编写

  1. #!/bin/bash
  3. function checker2_item1_check() {
  4.   # checker2 item1
  5.     # do real check ..., and report check status
  6.     report-status --name=checker2_item1 --status=pass --message="-"
  7. }
  9. function checker2_item2_check() {
  10.   # checker2 item2
  11.     # do real check ..., and report check status
  12.     report-status --name=checker2_item2 --status=error --message="checker2 item2 failed, reason: ..."
  13. }
  15. checker2_item1_check
  16. checker2_item2_check

该 Shell Prober 需使用 Prober 基础镜像 kubeprober/probe-base:v0.1.2，镜像中包含上报接口程序 report-status。

将上述 Prober Demo 打包到镜像并执行，即可执行探测逻辑并上报探测结果。