Skip to main content

Spark SLA CLI

Translation in progressThis guide is currently available in Simplified Chinese. A translated version will be added later.

Spark SLA CLI 分为两个入口：

命令空间作用
spark-designer sla读取某个 App 设计版本中的 SLA 策略、指标、日历、目标和动作目录
spark sla诊断 DEV、TEST、PROD 中实际运行的 SLA 实例、信号、风险、违约和动作队列

1. 选择 SLA 设计上下文​

spark-designer sla app list
spark-designer sla app use spark-sample
spark-designer sla current
spark-designer sla version list
spark-designer sla version entry

SLA 与 Page、Data、Task CLI 共用当前 Spark Designer App 和版本。

2. SLA 设计摘要​

spark-designer sla summary

摘要返回当前设计版本中的策略、指标、日历、目标和注册动作数量。详细数据可以分别读取：

spark-designer sla policies
spark-designer sla indicators
spark-designer sla calendars
spark-designer sla targets
spark-designer sla actions

3. 查看日历明细​

spark-designer sla calendar Default_Calendar

日历明细包括时区、每周工作日、工作时间段和例外日期。租户级默认日历也会出现在可用日历中，即使当前 App 尚未创建 SLA Policy。

4. 运行期任务诊断​

spark sla task DEV-PURCHASE-18 --app spark-sample --env dev

任务诊断会展示关联 SLA Instance、Target、Breach 和 Escalation。需要扫描过程和属性时：

spark sla task DEV-PURCHASE-18 \
  --app spark-sample \
  --env dev \
  --verbose

5. 运行期列表与 Dashboard​

spark sla instances --app spark-sample --env dev
spark sla summary --app spark-sample --env dev
spark sla at-risk --app spark-sample --env dev
spark sla breach-top --app spark-sample --env dev
spark sla trend --app spark-sample --env dev --days 30
spark sla action-queue --app spark-sample --env dev

设计态 spark-designer sla summary 和运行态 spark sla summary 含义不同：前者统计配置资产，后者统计已经运行的 SLA 数据。

6. 信号与策略状态​

spark sla signals DEV-PURCHASE-18 --app spark-sample --env dev
spark sla policy-states --app spark-sample --env dev

signals 用于判断某个任务当前处于正常、风险或违约状态；policy-states 用于检查策略在指定运行环境中是否启用。

7. 维护命令安全​

spark sla cleanup 是运行期维护命令，不属于普通查询。默认执行 dry-run：

spark sla cleanup task DEV-PURCHASE-18 --app spark-sample --env dev

只有明确传入 --execute 才会执行清理：

spark sla cleanup task DEV-PURCHASE-18 \
  --app spark-sample \
  --env dev \
  --execute

执行前必须核对 App、环境、任务 Key 和 dry-run 结果。

8. 输出格式​

spark-designer sla policies --format table
spark-designer sla summary --json
spark sla task DEV-PURCHASE-18 --app spark-sample --env dev --format markdown
spark sla instances --app spark-sample --env dev --csv
Last updated on