SLO CRD フィールドリファレンス - Alibaba Cloud Service Mesh - Alibaba Cloud ドキュメントセンター

Service Mesh (ASM) では、ServiceLevelObjective カスタムリソース定義 (CRD) を使用して、サービスレベル目標 (SLO) とアラートルールを宣言的に定義できます。

以下のフィールドリファレンスの階層は次のとおりです： metadata > spec > slos[] > sli / alerting。

YAML の例

次のマニフェストは、default 名前空間の httpbin Service に対する可用性 SLO を定義しています。目標は 99.9% で、SLO は 30 日間にわたって有効となり、ページレベルとチケットレベルの両方のアラートが設定されています。

次の表は、主要なフィールドをまとめたものです。フィールドの詳細については、「CRD フィールドリファレンス」をご参照ください。

フィールド	説明
`namespace`	カスタムリソースの名前空間。ターゲット Service の名前空間と一致する必要があります。
`service`	ターゲット Service 名。
`period`	SLO の有効期間。有効な値： `30d`、`28d`、`14d`、`7d`。
`objective`	文字列形式の目標パーセンテージ。有効な範囲： (0, 100]。
`plugin`	SLI のタイプとオプションを定義します。`id` を `availability` または `latency` に設定し、対応するオプションを構成します。「Plugin フィールド」をご参照ください。

CRD フィールドリファレンス

`metadata` フィールド

フィールド	タイプ	必須	説明	例
`name`	文字列	はい	カスタムリソースの名前です。形式： `asm-slo-{namespace}-{service}`。	`asm-slo-default-httpbin`
`namespace`	文字列	はい	カスタムリソースの名前空間です。ターゲットサービスの名前空間と一致する必要があります。	`default`
`labels`	オブジェクト	いいえ	バックエンドによって自動入力されるため、手動で設定しないでください。システムは、`asm-target-namespace` (サービスの名前空間) と `asm-target-service` (サービス名、`spec.service` と同じ) の 2 つのラベルを追加します。	`labels:` `asm-target-namespace: default` `asm-target-service: httpbin`

`spec` のフィールド

フィールド	タイプ	必須	説明	例
`service`	文字列	はい	ターゲットサービス名です。	`httpbin`
`period`	文字列	はい	SLO の有効期間です。有効な値： `30d` (30 日)、`28d`、`14d`、`7d`。	`30d`
`labels`	オブジェクト	いいえ	グローバル label です。この CRD の SLO によって生成されるすべての記録ルールの `labels` フィールドに伝播します。	`labels:` `global: "some-label"`
`slos`	配列	はい	1 つ以上の SLO 定義です。少なくとも 1 つのエントリが必要です。	-

`slos[]` のフィールド

slos 配列の各エントリで、目標、SLI 設定、およびアラートルールを持つ単一の SLO を定義します。

フィールド	タイプ	必須	説明	例
`name`	文字列	はい	SLO 名。	`asm-slo`
`objective`	文字列	はい	浮動小数点数として解析可能な文字列で指定する目標パーセンテージ。有効範囲： (0, 100]	`"99.9"`
`labels`	オブジェクト	いいえ	SLO レベルの label。この SLO によって生成されるすべての記録ルールの `labels` フィールドに伝播します。	`labels:` `recordlabel: aaa`
`sli`	オブジェクト	はい	SLI 設定。詳細については、「`sli` のフィールド」をご参照ください。	-
`alerting`	オブジェクト	はい	アラート設定。詳細については、「`alerting` のフィールド」をご参照ください。	-

`sli` のフィールド

sli オブジェクトには、単一のフィールド plugin が含まれます。

フィールド	タイプ	必須	説明	例
`plugin`	オブジェクト	はい	サービスレベル指標 (SLI) の測定方法を定義するプラグイン設定。詳細については、「plugin のフィールド」をご参照ください。	-

プラグインフィールド

プラグインは SLI の測定タイプを決定します。 id を設定してプラグインを選択し、対応する options を構成します。

フィールド	型	必須	説明	例
`id`	文字列	はい	プラグインのタイプです。有効な値： `availability` (サービス可用性)、 `latency` (サービスレイテンシー)。	`latency`
`options`	Map	条件付き	プラグインのオプションです。選択したプラグインに必須フィールドがある場合に必須です。たとえば、 `latency` では `bucket` が必須です。以下のオプション表を参照してください。	`options:` `bucket: "300"`

`availability` のオプション

id を availability に設定した場合、次のオプションを使用できます：

フィールド	型	必須	説明	例
`filter`	文字列	いいえ	PromQL ラベルフィルターです。 Prometheus は、このフィルターに一致するリクエストのみのメトリクスを計算します。	`request_protocol="http"`

`latency` のオプション

id を latency に設定した場合、次のオプションを使用できます：

フィールド	型	必須	説明	例
`bucket`	文字列	はい	レイテンシーの目標値を、整数として解析できる文字列で指定します。	`"300"`
`filter`	文字列	いいえ	PromQL ラベルフィルターです。 Prometheus は、このフィルターに一致するリクエストのみのメトリクスを計算します。	`request_protocol="http"`
`exclude_errors`	ブール値	いいえ	レイテンシーの計算からエラーリクエストを除外するかどうかを指定します。デフォルト： `false`。 `true` の場合、 5XX レスポンスコードのリクエストは除外されます。 `false` の場合、すべてのリクエストが含まれます。	`false`

`alerting` のフィールド

フィールド	タイプ	必須	説明	例
`name`	文字列	はい	アラートルールの名前。	`asm-alert`
`labels`	マップ	いいえ	アラートルールに添付するラベル。	`labels:` `alertlabel: bbb`
`annotations`	マップ	いいえ	アラートルールに添付するアノテーション。	`annotations:` `alertanno: ccc`
`pageAlert`	オブジェクト	いいえ	ページレベルの高重大度のアラート設定。詳細については、`pageAlert` のフィールドをご参照ください。	-
`ticketAlert`	オブジェクト	いいえ	チケットレベルの低重大度のアラート設定。詳細については、`ticketAlert` のフィールドをご参照ください。	-

`pageAlert` フィールド

フィールド	タイプ	必須	説明	例
`disable`	ブール値	いいえ	このアラートを無効にするかどうかを指定します。デフォルト値は `false` (有効) です。無効にするには `true` に設定します。	`false`
`labels`	マップ	いいえ	このアラートに付加するラベル。	`labels:` `pagelabel: ddd`
`annotations`	マップ	いいえ	このアラートに付加するアノテーション。	`annotations:` `pageanno: eee`

`ticketAlert` フィールド

フィールド	タイプ	必須	説明	例
`disable`	ブール値	いいえ	このアラートを無効にするには `true` に設定します。デフォルトは `false` です (アラートは有効)。	`false`
`labels`	マップ	いいえ	このアラートに添付する `labels`。	`labels:` `pagelabel: ddd`
`annotations`	マップ	いいえ	このアラートに添付する `annotations`。	`annotations:` `pageanno: eee`

YAML の例

CRD フィールドリファレンス

metadata フィールド

spec のフィールド

slos[] のフィールド

sli のフィールド

プラグインフィールド

availability のオプション

latency のオプション

alerting のフィールド

pageAlert フィールド

ticketAlert フィールド