正常性ルール API

Related pages：

正常性ルール

このページでは、複数のアプリケーションの正常性ルールを同時に作成、構成、更新、および削除するために使用できる正常性ルール API メソッドについて説明します。この API を使用すると、1 つまたは複数の正常性ルールをプログラムで更新および保守したり、アプリケーション間やコントローラ間で移行したりすることができます。

JSON ペイロードの最小構文検証は、正常性ルールの作成時に実行されます。
指定されたメトリックのパス検証は実行されません。定義したすべてのメトリックに対して有効なパスが提供されていることを確認します。
正常性ルールの評価中にメトリックが解決されない場合、正常性ルールは不明（?）状態になります。定義した影響を受けるすべてのエンティティに対して有効なメトリックが提供されていることを確認します。

正常性ルールの作成

指定された JSON ペイロードから新しい正常性ルールを作成します。「プロパティの詳細」を参照してください。

リソースURL

POST <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules

要求/応答の形式

JSON

例

この例では、影響を受けるエンティティタイプ business transaction performance を含む正常性ルールを作成し、正常性ルールの評価基準を定義します。「例のダウンロード」を参照してください。

{
  "name": "My new health rule",
  "enabled": true,
  "useDataFromLastNMinutes": 30,
  "waitTimeAfterViolation": 5,
  "affects": {
    "affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
    "affectedBusinessTransactions": {
      "businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
    }
  },
  "evalCriterias": {
    "criticalCriteria": {
      "conditionAggregationType": "ALL",
      "conditions": [
        {
          "name": "Condition 1",
          "shortName": "A",
          "evaluateToTrueOnNoData": false,
          "evalDetail": {
            "evalDetailType": "SINGLE_METRIC",
            "metricAggregateFunction": "VALUE",
            "metricPath": "Average CPU Used (ms)",
            "metricEvalDetail": {
              "metricEvalDetailType": "BASELINE_TYPE",
              "baselineCondition": "WITHIN_BASELINE",
              "baselineName": "All Data - Last 15 Days",
              "baselineUnit": "PERCENTAGE",
              "compareValue": 30.5
            }
          }
        }
      ]
    },
    "warningCriteria": {
      "conditionAggregationType": "ALL",
      "conditions": [
        {
          "name": "Condition 1",
          "shortName": "A",
          "evalDetail": {
            "evalDetailType": "METRIC_EXPRESSION",
            "metricExpression": "({metric1} + ({metric2} * 3))",
            "metricExpressionVariables": [
              {
                "variableName": "metric1",
                "metricAggregateFunction": "VALUE",
                "metricPath": "95th Percentile Response Time (ms)"
              },
              {
                "variableName": "metric2",
                "metricAggregateFunction": "MAXIMUM",
                "metricPath": "Average CPU Used (ms)"
              }
            ],
            "metricEvalDetail": {
              "metricEvalDetailType": "SPECIFIC_TYPE",
              "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
              "compareValue": 10
            }
          }
        }
      ]
    }
  }
}

YML

{
    "id": 26,
    "name": "My new health rule",
    "enabled": false,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 5,
    "scheduleName": "Weeknights: 11pm-6am, Mon-Fri",
    "affects": {
        "affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
        "affectedBusinessTransactions": {
            "businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Average CPU Used (ms)",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "BASELINE_TYPE",
                            "baselineCondition": "WITHIN_BASELINE",
                            "baselineName": "All data - Last 15 days",
                            "compareValue": 30.5,
                            "baselineUnit": "PERCENTAGE"
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        },
        "warningCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "METRIC_EXPRESSION",
                        "metricExpression": "({metric1} + ({metric2} * 3))",
                        "metricExpressionVariables": [
                            {
                                "variableName": "metric1",
                                "metricAggregateFunction": "VALUE",
                                "metricPath": "95th Percentile Response Time (ms)"
                            },
                            {
                                "variableName": "metric2",
                                "metricAggregateFunction": "MAXIMUM",
                                "metricPath": "Average CPU Used (ms)"
                            }
                        ],
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 10
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        }
    }
}

YML

アプリケーションの正常性ルールのリストの取得

この API は、指定されたアプリケーション ID に対して、すべての正常性ルール ID と名前のリストを返します。正常性ルールの完全な詳細を取得するには、GET //health-rule/{health-rule-id} を使用します。「プロパティの詳細」を参照してください。

リソースURL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules

応答形式

JSON

応答の例

[
    {
        "id": 1,
        "name": "Machine Availability is too low",
        "enabled": true
    },
    {
        "id": 2,
        "name": "Overall Disk Space Available is too low",
        "enabled": true
    },
    {
        "id": 3,
        "name": "CPU Usage is too high",
        "enabled": true
    },
    {
        "id": 4,
        "name": "Memory Usage is too high",
        "enabled": true
    },
    {
        "id": 5,
        "name": "Swap Usage is too high",
        "enabled": true
    },
    {
        "id": 6,
        "name": "Disk Usage is too high on at least one partition",
        "enabled": false
    }
]

YML

指定された正常性ルールの詳細の取得

この API は、指定された正常性ルール ID に対して正常性ルールの詳細を返します。

JMX 正常性ルールはサポートされていません。

リソースURL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/{health-rule-id}

応答形式

JSON

応答の例

{
    "id": 26,
    "name": "My new health rule",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 5,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
        "affectedBusinessTransactions": {
            "businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Average CPU Used (ms)",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "BASELINE_TYPE",
                            "baselineCondition": "WITHIN_BASELINE",
                            "baselineName": "All data - Last 15 days",
                            "compareValue": 30.5,
                            "baselineUnit": "PERCENTAGE"
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        },
        "warningCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "METRIC_EXPRESSION",
                        "metricExpression": "({metric1} + ({metric2} * 3))",
                        "metricExpressionVariables": [
                            {
                                "variableName": "metric1",
                                "metricAggregateFunction": "VALUE",
                                "metricPath": "95th Percentile Response Time (ms)"
                            },
                            {
                                "variableName": "metric2",
                                "metricAggregateFunction": "MAXIMUM",
                                "metricPath": "Average CPU Used (ms)"
                            }
                        ],
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 10
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        }
    }
}

YML

正常性ルールの更新

この API は、既存の正常性ルール（必須フィールド）を、指定された正常性ルール ID の詳細で更新します。「プロパティの詳細」を参照してください。

リソースURL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/{health-rule-id}

要求/応答の形式

JSON

例

{
  "name": "My new health rule",
  "enabled": true,
  "useDataFromLastNMinutes": 30,
  "waitTimeAfterViolation": 5,
  "affects": {
    "affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
    "affectedBusinessTransactions": {
      "businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
    }
  },
  "evalCriterias": {
    "criticalCriteria": {
      "conditionAggregationType": "ALL",
      "conditions": [
        {
          "name": "Condition 1",
          "shortName": "A",
          "evaluateToTrueOnNoData": false,
          "evalDetail": {
            "evalDetailType": "SINGLE_METRIC",
            "metricAggregateFunction": "VALUE",
            "metricPath": "Average CPU Used (ms)",
            "metricEvalDetail": {
              "metricEvalDetailType": "BASELINE_TYPE",
              "baselineCondition": "WITHIN_BASELINE",
              "baselineName": "All Data - Last 15 Days",
              "baselineUnit": "PERCENTAGE",
              "compareValue": 30.5
            }
          }
        }
      ]
    },
    "warningCriteria": {
      "conditionAggregationType": "ALL",
      "conditions": [
        {
          "name": "Condition 1",
          "shortName": "A",
          "evalDetail": {
            "evalDetailType": "METRIC_EXPRESSION",
            "metricExpression": "({metric1} + ({metric2} * 3))",
            "metricExpressionVariables": [
              {
                "variableName": "metric1",
                "metricAggregateFunction": "VALUE",
                "metricPath": "95th Percentile Response Time (ms)"
              },
              {
                "variableName": "metric2",
                "metricAggregateFunction": "MAXIMUM",
                "metricPath": "Average CPU Used (ms)"
              }
            ],
            "metricEvalDetail": {
              "metricEvalDetailType": "SPECIFIC_TYPE",
              "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
              "compareValue": 10
            }
          }
        }
      ]
    }
  }
}

YML

{
  "name": "My new health rule",
  "enabled": true,
  "useDataFromLastNMinutes": 30,
  "waitTimeAfterViolation": 5,
  "affects": {
    "affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
    "affectedBusinessTransactions": {
      "businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
    }
  },
  "evalCriterias": {
    "criticalCriteria": {
      "conditionAggregationType": "ALL",
      "conditions": [
        {
          "name": "Condition 1",
          "shortName": "A",
          "evaluateToTrueOnNoData": false,
          "evalDetail": {
            "evalDetailType": "SINGLE_METRIC",
            "metricAggregateFunction": "VALUE",
            "metricPath": "Average CPU Used (ms)",
            "metricEvalDetail": {
              "metricEvalDetailType": "BASELINE_TYPE",
              "baselineCondition": "WITHIN_BASELINE",
              "baselineName": "All Data - Last 15 Days",
              "baselineUnit": "PERCENTAGE",
              "compareValue": 30.5
            }
          }
        }
      ]
    },
    "warningCriteria": {
      "conditionAggregationType": "ALL",
      "conditions": [
        {
          "name": "Condition 1",
          "shortName": "A",
          "evalDetail": {
            "evalDetailType": "METRIC_EXPRESSION",
            "metricExpression": "({metric1} + ({metric2} * 3))",
            "metricExpressionVariables": [
              {
                "variableName": "metric1",
                "metricAggregateFunction": "VALUE",
                "metricPath": "95th Percentile Response Time (ms)"
              },
              {
                "variableName": "metric2",
                "metricAggregateFunction": "MAXIMUM",
                "metricPath": "Average CPU Used (ms)"
              }
            ],
            "metricEvalDetail": {
              "metricEvalDetailType": "SPECIFIC_TYPE",
              "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
              "compareValue": 10
            }
          }
        }
      ]
    }
  }
}

YML

正常性ルールの削除

指定された ID を持つ既存の正常性ルールを削除します。

リソースURL

DELETE <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/{health-rule-id}

正常性ルール構成の更新

この API は、正常性ルールの 1 つ以上の構成設定を更新します。「プロパティの詳細」を参照してください。

要求の次のフィールドのいずれかまたは両方に入力できます。

正常性ルールを有効/無効にします。
正常性ルールのスケジュールを更新します。

リソースURL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/health-rules/{health-rule-id}/configuration

要求/応答の形式

JSON

例

{
  "enabled": "false",
  "scheduleName": "Weeknights: 11pm-6am, Mon-Fri"
}

YML

{
    "id": 26,
    "name": "My new health rule",
    "enabled": false,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 5,
    "scheduleName": "Weeknights: 11pm-6am, Mon-Fri",
    "affects": {
        "affectedEntityType": "BUSINESS_TRANSACTION_PERFORMANCE",
        "affectedBusinessTransactions": {
            "businessTransactionScope": "ALL_BUSINESS_TRANSACTIONS"
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Average CPU Used (ms)",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "BASELINE_TYPE",
                            "baselineCondition": "WITHIN_BASELINE",
                            "baselineName": "All data - Last 15 days",
                            "compareValue": 30.5,
                            "baselineUnit": "PERCENTAGE"
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        },
        "warningCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "METRIC_EXPRESSION",
                        "metricExpression": "({metric1} + ({metric2} * 3))",
                        "metricExpressionVariables": [
                            {
                                "variableName": "metric1",
                                "metricAggregateFunction": "VALUE",
                                "metricPath": "95th Percentile Response Time (ms)"
                            },
                            {
                                "variableName": "metric2",
                                "metricAggregateFunction": "MAXIMUM",
                                "metricPath": "Average CPU Used (ms)"
                            }
                        ],
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 10
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        }
    }
}

YML

応答コード

コード	説明
200	正常に取得されました
201	正常に作成されました
204	正常に削除されました
400	Bad request
401	未認証
403	Forbidden
404	リソースが見つかりません
409	すでに存在します

Property Details

HealthRule

Property Name

Type and Valid Values

Description

id

整数

システムによって自動生成され、応答で返されます。

これは readOnly 値です。

name

string

最小長：1

正常性ルールの名前。

enabled

boolean

デフォルト値： true

正常性ルールを有効/無効の状態に設定します。正常性ルールは、enabled 状態の場合にのみ評価されます。

useDataFromLastNMinutes

整数

最小値：1

最大値：360

収集されたデータが正常性ルールの評価の対象となる時間間隔（分単位）。1 ～ 9 の範囲の値または 10 の倍数（360 未満）を入力します。

waitTimeAfterViolation

整数

最小時間：1 分

違反後の待機時間（分単位）。

scheduleName

string

デフォルトオプション： Always

評価のために正常性ルールに関連付けられるスケジュールの名前。

affects^*

正常性ルールの影響を受けるエンティティについて説明します。たとえば、ビジネストランザクション、サーバ、データベースなどです。

影響

プロパティ

Type

Enums

affectedEntity型

string

OVERALL_APPLICATION_PERFORMANCE

BUSINESS_TRANSACTION_PERFORMANCE

TIER_NODE_TRANSACTION_PERFORMANCE

TIER_NODE_HARDWARE

SERVERS_IN_APPLICATION

BACKENDS

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

CUSTOM

DATABASES

SERVERS

evalCriterias^*

正常性ルールを評価するためのブール式として表現された条件または一連の条件（最大 8 個）を定義します。affectedEntityType によっては、条件に evalMatchingCriteria が含まれる場合と含まれない場合があります。条件は次のように分類されます。

critical または
警告

重大条件は警告条件より前に評価されます。重大条件と警告条件が同じ正常性ルールで定義されていると、警告条件は重大条件が true でない場合のみに評価されます。

プロパティ

Description

Type/Enums

conditionAggregationType

正常性ルール違反を構成する条件評価基準。

String

default: ALL

Enums

ALL

ANY

CUSTOM

conditionExpression

conditionAggregationType 変数を CUSTOM に設定する場合にのみ使用します。ブール式を定義するには、条件の ShortName を使用します。

文字列

minLength: 1

conditions^*

true または false に個別に評価できる単一の条件。

または

条件のリスト（最大 8 つ）と、基準を形成するための他のプロパティ。

文字列

minItems：1

条件

プロパティ説明タイプ/列挙体

name^* 条件の名前。 string

shortname^*

CUSTOM conditionType の評価に conditionExpression で使用される短縮名。

string

パターン：^[A-Z]{1,3}$

Enums

A

B

C

D

E

F

G

H

evaluateToTrueOnNoData

条件がベースになっている任意のメトリックがデータを返さない場合の条件の評価を制御します。データが返されない場合、条件はデフォルトで unknown と評価されます。正常性ルールが true に評価されるすべての条件に基づいている場合、データが返されないと、正常性ルールがアクションをトリガーするかどうかに影響を与える可能性があります。

boolean

デフォルト：false

evalDetail^*

条件の評価対象として考慮されるメトリックの詳細。SINGLE_METRIC は単一のメトリックを評価するために使用します。METRIC_EXPRESSION はメトリック式を評価するために使用します。

ConditionEvalDetail

プロパティ	タイプ	Enums
evalDetailType	string	SINGLE_METRIC METRIC_EXPRESSION

triggerEnabled

true に設定すると、フィールド minimumTriggers の値が評価対象と見なされます。

boolean

デフォルト： false

minimumTriggers ゼロ以外の値を設定すると、条件を評価するときに永続的しきい値が考慮されます。useDataFromLastNMinutes より小さい値を定義していることを確認します。 integer
デフォルト：0
最小値：0
最大値：30

evalMatchingCriteria

次の正常性ルールタイプの条件を評価する基準。

ビジネストランザクション
ノードの正常性ハードウェア
ノードの正常性トランザクションパフォーマンス

正常性ルールに違反したと見なされるために必要な、影響を受けたエンティティで条件に違反しているノードの数を定義します。

NodeEvalMatchingCriteria

プロパティ説明タイプ/列挙体

matchType

正常性ルールに違反したと見なされるために必要な、影響を受けたエンティティで条件に違反しているノードの数を定義する評価範囲タイプ。

matchType として PERCENTAGE_NODES または NUMBER_OF_NODES を選択した場合にのみ一致基準を入力します。

文字列

Enums

AVERAGE

ANY_NODE

PERCENTAGE_NODES NUMBER_OF_NODES

value

正常性ルール違反を構成するために条件に違反する必要があるノードの数または割合。NUMBER_OF_NODES を選択した場合は、整数を入力します。PERCENTAGE_NODES を選択した場合は、番号を入力します。

数字

最小値：0

重大条件と警告条件が同じ正常性ルールで定義されていると、警告条件は重大条件が true でない場合のみに評価されます。

Property

Description

Type/Enums

conditionAggregationType

正常性ルール違反を構成する条件評価基準。

文字列

デフォルト：ALL

Enums

ALL

ANY

CUSTOM

conditionExpression

conditionAggregationType 変数を CUSTOM に設定する場合にのみ使用します。ブール式を定義するには、条件の ShortName を使用します。

文字列

minLength: 1

conditions^*

true または false に個別に評価できる単一の条件。または

条件のリスト（最大 8 つ）と、基準を形成するための他のプロパティ。

文字列

minItems：1

条件

プロパティ説明タイプ/列挙体

name^* 条件の名前。 string

shortname^*

CUSTOM conditionType の評価に conditionExpression で使用される短縮名。

string

パターン：^[A-Z]{1,3}$

Enums

A

B

C

D

E

F

G

H

evaluateToTrueOnNoData

条件がベースになっている任意のメトリックがデータを返さない場合の条件の評価を制御します。データが返されない場合のデフォルトは、条件が unknown と評価されます。正常性ルールが true に評価されるすべての条件に基づいている場合、データが返されないと、正常性ルールがアクションをトリガーするかどうかに影響を与える可能性があります。

boolean

デフォルト：false

evalDetail^*

条件の評価対象として考慮されるメトリックの詳細。SINGLE_METRIC は単一のメトリックを評価するために使用します。METRIC_EXPRESSION はメトリック式を評価するために使用します。

ConditionEvalDetail

プロパティ	タイプ	Enums
`evalDetailType`	string	`SINGLE_METRIC` `METRIC_EXPRESSION`

triggerEnabled

true に設定すると、フィールド minimumTriggers の値が評価対象と見なされます。

boolean

デフォルト： false

minimumTriggers

ゼロ以外の値を設定すると、条件を評価するときに永続的しきい値が考慮されます。useDataFromLastNMinutes より小さい値を定義していることを確認します。

integer
デフォルト：0
最小値：0
最大値：30

evalMatchingCriteria

次の正常性ルールタイプの条件を評価する基準。

ビジネストランザクション
ノードの正常性ハードウェア
ノードの正常性トランザクションパフォーマンス

正常性ルールに違反したと見なされるために必要な、影響を受けたエンティティで条件に違反しているノードの数を定義します。

NodeEvalMatchingCriteria

プロパティ説明タイプ/列挙体

matchType

正常性ルールに違反したと見なされるために必要な、影響を受けたエンティティで条件に違反しているノードの数を定義する評価範囲タイプ。

matchType として PERCENTAGE_NODES または NUMBER_OF_NODES を選択した場合にのみ一致基準を入力します。

文字列

Enums

AVERAGE

ANY_NODE

PERCENTAGE_NODES NUMBER_OF_NODES

value

正常性ルール違反を構成するために条件に違反する必要があるノードの数または割合。NUMBER_OF_NODES を選択した場合は、整数を入力します。PERCENTAGE_NODES を選択した場合は、番号を入力します。

数字

最小値：0

HealthRuleSummaryArray

プロパティタイプ

id^* 整数

name

文字列

minLength: 1

enabled^* boolean

HealthRuleConfiguration

正常性ルールの JSON ペイロード全体を送信する必要なく、個別に更新できる正常性ルールの構成詳細。1 つ以上のプロパティを指定することができ、それらのプロパティはすべて新しい指定値に設定されます。

プロパティ	タイプ
`enabled`	boolean
`scheduleName`	string

MetricEvalDetail

プロパティタイプ Enums

metricEvalDetailType^*

string

BASELINE_TYPE

SPECIFIC_TYPE

BaselineMetricEvalDetail

正常性ルールを評価するために使用されるベースラインからのメトリックの偏差。

プロパティ	タイプ	Enums
`metricEvalDetailType^*`	string	`BASELINE_TYPE` `SPECIFIC_TYPE`
`baselineCondition^*`	string	`WITHIN_BASELINE` `NOT_WITHIN_BASELINE` `GREATER_THAN_BASELINE` `LESS_THAN_BASELINE`
`baselineName^*`	string minLength: 1
`compareValue^*`	数字最小値：0
`baselineUnit^*`	string	`STANDARD_DEVIATIONS` `PERCENTAGE`

SpecificValueMetricEvalDetail

正常性ルールを評価するために使用される特定値からのメトリックの偏差。

プロパティタイプ Enums

metricEvalDetailType^*

string

BASELINE_TYPE

SPECIFIC_TYPE

compareCondition^*

string

GREATER_THAN_SPECIFIC_VALUE

LESS_THAN_SPECIFIC_VALUE

compareValue^*

数字

最小値：0

MetricAggregateFunction

偏差を判別して正常性ルールを評価するために集約されたメトリック。

プロパティタイプ Enums

MetricAggregateFunction*

string

MINIMUM

MAXIMUM

VALUE

SUM

COUNT

CURRENT

GROUP_COUNT

SingleMetricEvalDetail

正常性ルールを評価するために使用される「集約値」からの単一メトリックの偏差。

プロパティ	タイプ	Enums
`evalDetailType^*`	string	`SINGLE_METRIC` `METRIC_EXPRESSION`
`metricAggregateFunction^*`	string	`MINIMUM` `MAXIMUM` `VALUE` `SUM` `COUNT` `CURRENT` `GROUP_COUNT`
`metricPath^*`	string minLength: 1
`metricEvalDetail^*`	string	`BASELINE_TYPE` `SPECIFIC_TYPE`

MetricExpressionEvalDetail

正常性ルールを評価するために使用されるメトリック式。

プロパティタイプ Enums

evalDetailType^*

string

SINGLE_METRIC

METRIC_EXPRESSION

metricExpression^*

string

minLength: 1

metricExpressionVariables^*

string

minItems：2

MetricDetailWithVariableName

プロパティタイプ Enums

variableName^*

string

minLength: 1

metricAggregateFunction^*

string

MINIMUM

MAXIMUM

VALUE

SUM

COUNT

CURRENT

GROUP_COUNT

metricPath^*

string

minLength: 1

metricEvalDetail^*

string

SpecificValueMetricEvalDetail

プロパティタイプ Enums

metricEvalDetailType^*

string

BASELINE_TYPE

SPECIFIC_TYPE

compareCondition^*

string

GREATER_THAN_SPECIFIC_VALUE

LESS_THAN_SPECIFIC_VALUE

compareValue^*

数字

最小値：0

MetricDetailWithVariableName

プロパティタイプ Enums

variableName^*

string

minLength: 1

metricAggregateFunction^*

string

MINIMUM

MAXIMUM

VALUE

SUM

COUNT

CURRENT

GROUP_COUNT

metricPath^*

string

minLength: 1

NodeEvalMatchingCriteria

Property タイプ Enums

matchType

string

AVERAGE

ANY_NODE

PERCENTAGE_NODES

NUMBER_OF_NODES

value

matchType として PERCENTAGE_NODES または NUMBER_OF_NODES を選択した場合にのみ一致基準を入力します。NUMBER_OF_NODES を選択した場合は、整数を入力します。それ以外の場合は、PERCENTAGE_NODES を選択して番号を入力します。

数字

最小値：0

Condition

true または false に個別に評価できる単一の条件。条件のリスト（最大 8 つ）と、基準を形成するための他のプロパティ。

プロパティ説明タイプ/列挙体

name^* 条件の名前。 string

shortname^*

CUSTOM conditionType の評価に conditionExpression で使用される短縮名。

string

パターン：^[A-Z]{1,3}$

Enums

A

B

C

D

E

F

G

H

evaluateToTrueOnNoData

条件がベースになっている任意のメトリックがデータを返さない場合の条件の評価を制御します。データが返されない場合、条件はデフォルトで unknown と評価されます。正常性ルールが true に評価されるすべての条件に基づいている場合、データが返されないと、正常性ルールがアクションをトリガーするかどうかに影響を与える可能性があります。

boolean

デフォルト：false

evalDetail^*

条件の評価対象として考慮されるメトリックの詳細。SINGLE_METRIC は単一のメトリックを評価するために使用します。METRIC_EXPRESSION はメトリック式を評価するために使用します。

ConditionEvalDetail

プロパティ	タイプ	Enums
`evalDetailType`	string	`SINGLE_METRIC` `METRIC_EXPRESSION`

triggerEnabled

true に設定すると、フィールド minimumTriggers の値が評価対象と見なされます。

boolean

デフォルト： false

minimumTriggers ゼロ以外の値を設定すると、条件を評価するときに永続的しきい値が考慮されます。useDataFromLastNMinutes より小さい値を定義していることを確認します。 integer
デフォルト：0
最小値：0
最大値：30

ConditionEvalDetail

プロパティ	タイプ	Enums
`evalDetailType`	string	`SINGLE_METRIC` `METRIC_EXPRESSION`

基準

Property

Description

Type/Enums

conditionAggregationType

正常性ルール違反を構成する条件評価基準。

string

デフォルト：ALL

Enums

ALL

ANY

CUSTOM

conditionExpression

conditionAggregationType 変数を CUSTOM に設定する場合にのみ使用します。ブール式を定義するには、条件の ShortName を使用します。

文字列

minLength: 1

conditions^*

true または false に個別に評価できる単一の条件。または

条件のリスト（最大 8 つ）と、基準を形成するための他のプロパティ。

文字列

minItems：1

条件

プロパティ説明タイプ/列挙体

name^* 条件の名前。 string

shortname^*

CUSTOM conditionType の評価に conditionExpression で使用される短縮名。

string

パターン：^[A-Z]{1,3}$

Enums

A

B

C

D

E

F

G

H

evaluateToTrueOnNoData

条件がベースになっている任意のメトリックがデータを返さない場合の条件の評価を制御します。データが返されない場合のデフォルトは、条件が unknown と評価されます。正常性ルールが true に評価されるすべての条件に基づいている場合、データが返されないと、正常性ルールがアクションをトリガーするかどうかに影響を与える可能性があります。

boolean

デフォルト：false

evalDetail^*

条件の評価対象として考慮されるメトリックの詳細。SINGLE_METRIC は単一のメトリックを評価するために使用します。METRIC_EXPRESSION はメトリック式を評価するために使用します。

ConditionEvalDetail

プロパティ	タイプ	Enums
`evalDetailType`	string	`SINGLE_METRIC` `METRIC_EXPRESSION`

triggerEnabled

true に設定すると、フィールド minimumTriggers の値が評価対象と見なされます。

boolean

デフォルト： false

minimumTriggers

ゼロ以外の値を設定すると、条件を評価するときに永続的しきい値が考慮されます。useDataFromLastNMinutes より小さい値を定義していることを確認します。

integer
デフォルト：0
最小値：0
最大値：30

evalMatchingCriteria

次の正常性ルールタイプの条件を評価する基準。

ビジネストランザクション
ノードの正常性ハードウェア
ノードの正常性トランザクションパフォーマンス

正常性ルールに違反したと見なされるために必要な、影響を受けたエンティティで条件に違反しているノードの数を定義します。

NodeEvalMatchingCriteria

プロパティ説明タイプ/列挙体

matchType

正常性ルールに違反したと見なされるために必要な、影響を受けたエンティティで条件に違反しているノードの数を定義する評価範囲タイプ。

matchType として PERCENTAGE_NODES または NUMBER_OF_NODES を選択した場合にのみ一致基準を入力します。

文字列

Enums

AVERAGE

ANY_NODE

PERCENTAGE_NODES NUMBER_OF_NODES

value

正常性ルール違反を構成するために条件に違反する必要があるノードの数または割合。NUMBER_OF_NODES を選択した場合は、整数を入力します。PERCENTAGE_NODES を選択した場合は、番号を入力します。

数字

最小値：0

EntityMatchingPattern

プロパティタイプ Enums

matchTo^*

string

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot boolean

AffectedTiers

プロパティタイプ Enums

affectedTierScope^*

string

ALL_TIERS

SPECIFIC_TIERS

AllTiers

影響を受ける階層の範囲は、影響を受けるエンティティのすべての階層に設定されます。

プロパティタイプ Enums

affectedTierScope^*

string

ALL_TIERS

SPECIFIC_TIERS

SpecificTiers

影響を受ける階層の範囲は、影響を受けるエンティティの特定の階層に設定されます。

プロパティタイプ Enums

affectedTierScope^*

string

ALL_TIERS

SPECIFIC_TIERS

tiers^*

string

minItems: 1

AffectedNodes

プロパティタイプ Enums

affectedNodeScope^*

string

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

AllNodes

影響を受けるノードの範囲は、影響を受けるエンティティのすべてのノードに設定されます。

`Property`	`Type`	`Enums`
`affectedNodeScope^*`	string	`ALL_NODES`

SpecificNodes

影響を受けるノードの範囲は、影響を受けるエンティティのすべてのノードに設定されます。

プロパティタイプ Enums

affectedNodeScope^*

string

SPECIFIC_NODES

nodes^*

string

minItems: 1

NodesOfSpecificTiers

影響を受けるノードの範囲は、影響を受けるエンティティの特定の階層のノードに設定されます。

プロパティタイプ Enums

affectedNodeScope^*

string

NODES_OF_SPECIFIC_TIERS

specificTiers^*

string

minItems: 1

NodesMatchingPattern

影響を受けるノードの範囲は、影響を受けるエンティティのパターンに一致するノードに設定されます。

プロパティタイプ Enums

affectedNodeScope^*

string

NODES_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

プロパティタイプ Enums

matchTo^*

string

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot boolean

NodePropertyVariableMatcher

影響を受けるノードの範囲は、影響を受けるエンティティの変数のプロパティと一致するノードに設定されます。

プロパティタイプ Enums

affectedNodeScope^*

string

NODE_PROPERTY_VARIABLE_MATCHER

propVarPairs^*

アレイ

minItems：1

プロパティタイプ Enums

propertyType

string

META

ENV

JVM

name

string

minLength: 1

value

string

minLength: 1

OverallApplicationPerformance

影響を受けるエンティティの範囲は、全体的なアプリケーションパフォーマンスに設定されます。

プロパティ	タイプ	Enums
`affectedEntityType^*`	string	`OVERALL_APPLICATION_PERFORMANCE`

BusinessTransactionPerformance

影響を受けるエンティティの範囲は、ビジネストランザクションパフォーマンスに設定されます。

プロパティタイプ Enums

affectedEntityType^*

string

BUSINESS_TRANSACTION_PERFORMANCE

affectedBusinessTransactions^*

string

AffectedBusinessTransactions

プロパティタイプ Enums

businessTransactionScope^*

string

ALL_BUSINESS_TRANSACTIONS

SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

AffectedBusinessTransactions

プロパティタイプ Enums

businessTransactionScope^*

string

ALL_BUSINESS_TRANSACTIONS

SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

AllBusinessTransactions

ビジネストランザクションの範囲が、すべてのビジネストランザクションに設定されます。

プロパティ	タイプ	Enums
`businessTransactionScope^*`	string	`ALL_BUSINESS_TRANSACTIONS`

SpecificBusinessTransactions

ビジネストランザクションの範囲は、特定のビジネストランザクションに設定されます。

プロパティタイプ Enums

businessTransactionScope^*

string

SPECIFIC_BUSINESS_TRANSACTIONS

businessTransactions^*

string

minItems: 1

BusinessTransactionsInSpecificTiers

ビジネストランザクションの範囲は、特定の階層のビジネストランザクションに設定されます。

プロパティタイプ Enums

businessTransactionScope^*

string

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

specificTiers^*

string

minItems: 1

BusinessTransactionsMatchingPattern

ビジネストランザクションの範囲は、特定のパターンに一致するビジネストランザクションに設定されます。

プロパティタイプ Enums

businessTransactionScope^*

string

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

specificTiers^*

string

EntityMatchingPattern

プロパティタイプ Enums

matchTo^*

string

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot boolean

TierNodeTransactionPerformance

影響を受けるエンティティのタイプは、階層およびノードトランザクションのパフォーマンスに設定されます。

プロパティタイプ Enums

affectedEntityType^*

string

TIER_NODE_TRANSACTION_PERFORMANCE

affectedEntities^*

string

AffectedTierOrNodeEntities

プロパティタイプ Enums

tierOrNode^*

string

TIER_AFFECTED_ENTITIES

NODE_AFFECTED_ENTITIES

AffectedTierOrNodeEntities

プロパティタイプ Enums

tierOrNode^*

string

TIER_AFFECTED_ENTITIES

NODE_AFFECTED_ENTITIES

TierAffectedEntities

影響を受けるエンティティの範囲は、階層に設定されます。

プロパティタイプ Enums

tierOrNode*

string

TIER_AFFECTED_ENTITIES

NODE_AFFECTED_ENTITIES

affectedTiers*

string

AffectedTiers

プロパティタイプ Enums

affectedTierScope^*

string

ALL_TIERS

SPECIFIC_TIERS

NodeAffectedEntities

影響を受けるエンティティの範囲は、ノードに設定されます。

プロパティタイプ Enums

tierOrNode^*

string

TIER_AFFECTED_ENTITIES

NODE_AFFECTED_ENTITIES

typeofNode^*

string

ALL_NODES

JAVA_NODES

DOT_NET_NODES

PHP_NODES

affectedNodes^*

string

AffectedNodes

プロパティタイプ Enums

affectedNodeScope^*

string

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

TierNodeHardware

影響を受けるエンティティタイプは、階層ノードハードウェアに設定されます。

プロパティタイプ Enums

affectedEntityType^*

string

TIER_NODE_HARDWARE

affectedEntities^*

string

AffectedTierOrNodeEntities

プロパティタイプ Enums

tierOrNode^*

string

TIER_AFFECTED_ENTITIES

NODE_AFFECTED_ENTITIES

ServersInApplication

影響を受けるエンティティタイプは、servers in the applicationに設定されます。

プロパティタイプ Enums

affectedEntityType^*

string

SERVERS_IN_APPLICATION

affectedServers^*

string

ApplicationAffectedServers

プロパティタイプ Enums

serversScope^*

string

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

ApplicationAffectedServers

プロパティタイプ Enums

serversScope^*

string

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

AllServersInApplication

サーバの範囲は、アプリケーション内のすべてのサーバに設定されます。

プロパティ	タイプ	Enums
`serversScope^*`	string	`ALL_SERVERS_IN_APPLICATION`

SpecificServersInApplication

サーバの範囲は、アプリケーション内の特定のサーバに設定されます。

プロパティタイプ Enums

serversScope^*

string

SPECIFIC_SERVERS_IN_APPLICATION

specificServers^*

string

minLength: 1

AllServersInSpecificTiers

サーバの範囲は、特定の階層内のすべてのサーバに設定されます。

プロパティタイプ Enums

serversScope^*

string

ALL_SERVERS_IN_SPECIFIC_TIERS

specificTiers^*

string

minItems: 1

Backends

影響を受けるエンティティタイプは、バックエンドに設定されます。

プロパティタイプ Enums

affectedEntityType^*

string

BACKENDS

affectedBackends^*

string

AffectedBackends

プロパティタイプ Enums

backendScope^*

string

ALL_BACKENDS

SPECIFIC_BACKENDS

BACKENDS_MATCHING_PATTERN

AffectedBackends

プロパティタイプ Enums

backendScope^*

string

ALL_BACKENDS

SPECIFIC_BACKENDS

BACKENDS_MATCHING_PATTERN

AllBackends

バックエンドの範囲は、すべてのバックエンドに設定されます。

プロパティ	タイプ	Enums
`backendScope^*`	string	`ALL_BACKENDS`

SpecificBackends

バックエンドの範囲は、特定のバックエンドに設定されます。

プロパティタイプ Enums

backendScope^*

string

SPECIFIC_BACKENDS

backends^*

string

minItems: 1

BackendsMatchingPattern

バックエンドの範囲は、特定のパターンに一致するバックエンドに設定されます。

プロパティタイプ Enums

backendScope^*

string

BACKENDS_MATCHING_PATTERN

patternMatcher^*

string

EntityMatchingPattern

プロパティタイプ Enums

matchTo^*

string

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot boolean

Errors

影響を受けるエンティティタイプは、エラーに設定されます。

プロパティタイプ Enums

affectedEntityType^*

string

ERRORS

affectedErrors^*

string

AffectedErrors

プロパティタイプ Enums

errorScope^*

string

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

AffectedErrors

プロパティタイプ Enums

errorScope^*

string

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

AllErrors

エラーの範囲は、すべてのエラーに設定されます。

プロパティ	タイプ	Enums
`errorScope^*`	string	`ALL_ERRORS`

SpecificErrors

エラーの範囲は、特定のエラーに設定されます。

プロパティ	タイプ	説明/列挙型
`errorScope^*`	string	`SPECIFIC_ERRORS`
errors^*。	string minItems: 1
階層	string minItems: 1	エラー名が複数の階層に属する場合に使用します。エラー名と同じ順序で階層名を `affects.affectedErrors.tiers` でリストとして指定します。次の例では、「Page Not Found：404」が `Tier1`、「Error2」が `SomeOtherTier` に対応しています。エラー名が各階層に固有の場合、階層はエラーを 1 対 1 でマッピングします。この場合、階層名を指定する必要はありません。エラーが同じ名前で異なる階層に属している場合は、階層名に区切り文字「\|」を付けて重複する名前を処理します。エラー名と階層名の数が一致しない場合、リスト `affects.affectedErrors.tiers` は無視されます。エラーが複数の階層に属し、階層名を指定しない場合、エラー名は一意に識別できません。そのため、エラーが表示されます。
{ "id": 33, "name": "Specific Error", "enabled": true, "useDataFromLastNMinutes": 1, "waitTimeAfterViolation": 1, "scheduleName": "Always", "affects": { "affectedEntityType": "ERRORS", "affectedErrors": { "errorScope": "SPECIFIC_ERRORS", "errors": [ "Page Not Found : 404", "Error2" ], "tiers": [ "Tier1", "SomeOtherTier" ] } }, "evalCriterias": { "criticalCriteria": { "conditionAggregationType": "ALL", "conditionExpression": null, "conditions": [ { "name": "Condition 1", "shortName": "A", "evaluateToTrueOnNoData": false, "evalDetail": { "evalDetailType": "SINGLE_METRIC", "metricAggregateFunction": "VALUE", "metricPath": "Errors per Minute", "metricEvalDetail": { "metricEvalDetailType": "SPECIFIC_TYPE", "compareCondition": "GREATER_THAN_SPECIFIC_VALUE", "compareValue": 10 } }, "triggerEnabled": false, "minimumTriggers": 1 } ], "evalMatchingCriteria": { "matchType": "ANY_NODE", "value": null } }, "warningCriteria": null } } YML

ErrorsOfSpecificTiers

エラーの範囲は、特定の階層に関連するエラーに設定されます。

プロパティタイプ Enums

errorScope^*

string

ERRORS_OF_SPECIFIC_TIERS

specificTiers^*

string

minItems: 1

ErrorsMatchingPattern

エラーの範囲は、特定のパターンに一致するエラーに設定されます。

プロパティタイプ Enums

errorScope^*

string

ERRORS_MATCHING_PATTERN

patternMatcher

string

EntityMatchingPattern

プロパティタイプ Enums

matchTo^*

string

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot boolean

ServiceEndpoints

影響を受けるエンティティタイプは、サービスエンドポイントに設定されます。

プロパティタイプ Enums

affectedEntityType^*

string

SERVICE_ENDPOINTS

affectedServiceEndpoints^*

AffectedServiceEndpoints

プロパティタイプ Enums

serviceEndpointScope^*

string

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

AffectedServiceEndpoints

プロパティタイプ Enums

serviceEndpointScope^*

string

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

AllServiceEndpoints

サービスエンドポイントの範囲は、すべてのサービスエンドポイントに設定されます。

プロパティ	タイプ	Enums
`serviceEndpointScope^*`	string	`ALL_SERVICE_ENDPOINTS`

SpecificServiceEndpoints

サービスエンドポイントの範囲は、特定のサービスエンドポイントに設定されます。

プロパティタイプ Enums

serviceEndpointScope^*

string

SPECIFIC_SERVICE_ENDPOINTS

serviceEndpoints^*

string

minItems: 1

ServiceEndpointsInSpecificTiers

サービスエンドポイントの範囲は、特定のサービスエンドポイントに設定されます。

プロパティタイプ Enums

serviceEndpointScope^*

string

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

specificTiers^*

string

minItems: 1

ServiceEndpointsMatchingPattern

サービスエンドポイントの範囲は、特定のパターンに一致するサービスエンドポイントに設定されます。

プロパティタイプ Enums

serviceEndpointScope^*

string

SERVICE_ENDPOINTS_MATCHING_PATTERN

patternMatcher^*

string

minItems: 1

EntityMatchingPattern

プロパティタイプ Enums

matchTo^*

string

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot boolean

InformationPoints

影響を受けるエンティティタイプは、情報ポイントに設定されます。

プロパティタイプ Enums

affectedEntityType^*

string

INFORMATION_POINTS

affectedInformationPoints^*

string

AffectedInformationPoints

プロパティタイプ Enums

informationPointScope^*

string

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

AffectedInformationPoints

プロパティタイプ Enums

informationPointScope^*

string

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

AllInformationPoints

情報ポイントの範囲は、すべての情報ポイントに設定されます。

プロパティ	タイプ	Enums
`informationPointScope^*`	string	`ALL_INFORMATION_POINTS`

SpecificInformationPoints

情報ポイントの範囲は、特定の情報ポイントに設定されます。

プロパティタイプ Enums

informationPointScope^*

string

SPECIFIC_INFORMATION_POINTS

informationPoints^*

string

minItems: 1

InformationPointsMatchingPattern

情報ポイントの範囲は、パターンに一致する情報ポイントに設定されます。

プロパティタイプ Enums

informationPointScope^*

string

INFORMATION_POINTS_MATCHING_PATTERN

patternMatcher^*

string

minItems: 1

EntityMatchingPattern

プロパティタイプ Enums

matchTo^*

string

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot boolean

Custom

影響を受けるエンティティタイプは、カスタムに設定されます。

プロパティタイプ Enums

affectedEntityType^*

string

CUSTOM

affectedEntityScope^*

string

AffectedEntityScope

プロパティタイプ Enums

entityScope^*

string

APPLICATION_PERFORMANCE

SPECIFIC_ENTITY_PERFORMANCE

AffectedEntityScope

プロパティタイプ Enums

entityScope^*

string

APPLICATION_PERFORMANCE

SPECIFIC_ENTITY_PERFORMANCE

ApplicationPerformance

影響を受けるエンティティの範囲は、アプリケーションパフォーマンスに設定されます。

プロパティ	タイプ	Enums
`entityScope^*`	string	`APPLICATION_PERFORMANCE`

SpecificEntityPerformance

影響を受けるエンティティの範囲は、特定のエンティティパフォーマンスに設定されます。

プロパティタイプ Enums

entityScope^*

string

SPECIFIC_ENTITY_PERFORMANCE

entityType^*

string

BUSINESS_TRANSACTION

NODE

SERVER

affectedEntityName^*

string

minLength: 1

Databases

影響を受けるエンティティタイプは、データベースに設定されます。

プロパティタイプ Enums

affectedEntityType^*

string

DATABASES

databaseType^*

string

ALL_DATABASE_TYPES

COUCHBASE

DB2

MONGO_DB

MICROSOFT_SQL_SERVER

MYSQL

ORACLE

POSTGRE_SQL

AZURE_SQL

SYBASE

affectedDatabases^*

string

AffectedDatabases

プロパティタイプ Enums

databaseScope

string

ALL_DATABASES

SPECIFIC_DATABASES

AffectedDatabases

プロパティタイプ Enums

databaseScope^*

string

ALL_DATABASES

SPECIFIC_DATABASES

AllDatabases

影響を受けるデータベースの範囲は、すべてのデータベースに設定されます。

プロパティ	タイプ	Enums
`databaseScope^*`	string	`ALL_DATABASES`

SpecificDatabases

影響を受けるデータベースの範囲は、特定のデータベースに設定されます。

プロパティタイプ Enums

databaseScope^*

string

SPECIFIC_DATABASES

databases^*

string

minItems: 1

DbServer

プロパティタイプ

serverName^*

string

minLength: 1

collectorConfigName^*

string

minLength: 1

DbServer

プロパティタイプ

serverName^*

string

minLength: 1

collectorConfigName^*

string

minLength: 1

Servers

影響を受けるエンティティタイプは、サーバに設定されます。

プロパティタイプ Enums

affectedEntityType^*

string

SERVERS

serverSelectionCriteria^*

string

AffectedServersCriteria

プロパティタイプ Enums

selectServersBy^*

string

AFFECTED_SERVER_SUBGROUPS

AFFECTED_SERVERS

AffectedServersCriteria

プロパティタイプ Enums

selectServersBy^*

string

AFFECTED_SERVER_SUBGROUPS

AFFECTED_SERVERS

AffectedServers

プロパティタイプ Enums

selectServersBy^*

string

AFFECTED_SERVER_SUBGROUPS

AFFECTED_SERVERS

affectedServers^*

string

ServerSelectionCriteria

プロパティタイプ Enums

severSelectionScope^*

string

ALL_SERVERS_IN_ACCOUNT

SERVERS_WITHIN_SUBGROUP

SPECIFIC_SERVERS

SERVERS_MATCHING_PATTERN

ServerSelectionCriteria

プロパティタイプ Enums

severSelectionScope^*

string

ALL_SERVERS_IN_ACCOUNT

SERVERS_WITHIN_SUBGROUP

SPECIFIC_SERVERS

SERVERS_MATCHING_PATTERN

AllServersInAccount

サーバの範囲は、アカウント内のすべてのサーバに設定されます。

プロパティ	タイプ	Enums
`severSelectionScope^*`	string	`ALL_SERVERS_IN_ACCOUNT`

ServersWithinSubGroup

サーバの範囲は、サブグループ内のすべてのサーバに設定されます。

プロパティタイプ Enums

severSelectionScope^*

string

SERVERS_WITHIN_SUBGROUP

subGroups^*

string

minItems: 1

SpecificServers

サーバの範囲は、特定のサーバに設定されます。

プロパティタイプ Enums

severSelectionScope^*

string

SPECIFIC_SERVERS

servers^*

string

minItems: 1

ServersMatchingPattern

サーバの範囲は、特定のパターンに一致するサーバに設定されます。

プロパティタイプ Enums

severSelectionScope^*

string

SERVERS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

プロパティタイプ Enums

matchTo^*

string

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot boolean

AffectedServerSubGroups

影響を受けるサーバの範囲は、サブグループ内の影響を受けるサーバに設定されます。

プロパティタイプ Enums

selectServersBy^*

string

AFFECTED_SERVER_SUBGROUPS

subGroups^*

string

minItems: 1

AffectedSubGroups

プロパティタイプ Enums

subGroupScope^*

string

ALL_SUBGROUPS

SPECIFIC_SERVER_SUB_GROUPS

AffectedSubGroups

プロパティタイプ Enums

subGroupScope*

string

ALL_SUBGROUPS

SPECIFIC_SERVER_SUB_GROUPS

AllSubGroups

影響を受けるサーバの範囲は、すべてのサブグループ内のサーバに設定されます。

`Property`	`Type`	`Enums`
`subGroupScope^*`	string	`ALL_SUBGROUPS`

SpecificServerSubGroups

影響を受けるサーバの範囲は、servers within specific subgroupsに設定されます。

プロパティタイプ Enums

subGroupScope^*

string

SPECIFIC_SERVER_SUB_GROUPS

subGroupNames

string

minItems: 1

Affects

正常性ルールが影響するエンティティについて説明します。たとえば、ビジネストランザクション、サーバ、データベースなどです。

プロパティタイプ Enums

affectedEntityType^*

string

OVERALL_APPLICATION_PERFORMANCE

BUSINESS_TRANSACTION_PERFORMANCE

TIER_NODE_TRANSACTION_PERFORMANCE

TIER_NODE_HARDWARE

SERVERS_IN_APPLICATION

BACKENDS

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

CUSTOM

DATABASES

SERVERS

EvalCriterias

プロパティ

Type/Enums

criticalCriteria

基準

重大条件は警告条件より前に評価されます。重大条件と警告条件が同じ正常性ルールで定義されていると、警告条件は重大条件が true でない場合のみに評価されます。

プロパティ

Description

Type/Enums

conditionAggregationType

正常性ルール違反を構成する条件評価基準。

文字列

デフォルト：ALL

Enums

ALL

ANY

CUSTOM

conditionExpression

conditionAggregationType 変数を CUSTOM に設定する場合にのみ使用します。ブール式を定義するには、条件の ShortName を使用します。

文字列

minLength: 1

conditions^*

true または false に個別に評価できる単一の条件。または

条件のリスト（最大 8 つ）と、基準を形成するための他のプロパティ。

文字列

minItems：1

条件

プロパティ説明タイプ/列挙体

name^* 条件の名前。 string

shortname^*

CUSTOM conditionType. の評価に conditionExpression で使用される短縮名。

string

パターン：^[A-Z]{1,3}$

Enums

A

B

C

D

E

F

G

H

evaluateToTrueOnNoData

条件がベースになっている任意のメトリックがデータを返さない場合の条件の評価を制御します。データが返されない場合のデフォルトは、条件が unknown と評価されます。正常性ルールが true に評価されるすべての条件に基づいている場合、データが返されないと、正常性ルールがアクションをトリガーするかどうかに影響を与える可能性があります。

boolean

デフォルト：false

evalDetail^*

条件の評価対象として考慮されるメトリックの詳細。SINGLE_METRIC は単一のメトリックを評価するために使用します。METRIC_EXPRESSION はメトリック式を評価するために使用します。

ConditionEvalDetail

プロパティ	タイプ	Enums
`evalDetailType`	`string`	`SINGLE_METRIC` `METRIC_EXPRESSION`

triggerEnabled

true に設定すると、フィールド minimumTriggers の値が評価対象と見なされます。

boolean

default: false

minimumTriggers ゼロ以外の値を設定すると、条件を評価するときに永続的しきい値が考慮されます。useDataFromLastNMinutes より小さい値を定義していることを確認します。 integer
default: 0
minimum: 0
maximum: 30

evalMatchingCriteria

次の正常性ルールタイプの条件を評価する基準。

ビジネストランザクション
ノードの正常性ハードウェア
ノードの正常性トランザクションパフォーマンス

正常性ルールに違反したと見なされるために必要な、影響を受けたエンティティで条件に違反しているノードの数を定義します。

NodeEvalMatchingCriteria

プロパティタイプ/列挙体説明

matchType

文字列

Enums

AVERAGE

ANY_NODE

PERCENTAGE_NODES NUMBER_OF_NODES

正常性ルールに違反したと見なされるために必要な、影響を受けたエンティティで条件に違反しているノードの数を定義する評価範囲タイプ。

matchType として PERCENTAGE_NODES または NUMBER_OF_NODES を選択した場合にのみ一致基準を入力します。

value 正常性ルール違反を構成するために条件に違反する必要があるノードの数または割合。NUMBER_OF_NODES を選択した場合は、整数を入力します。PERCENTAGE_NODES を選択した場合は、番号を入力します。

warningCriteria

基準

重大条件と警告条件が同じ正常性ルールで定義されていると、警告条件は重大条件が true でない場合のみに評価されます。

プロパティ

Description

Type/Enums

conditionAggregationType

正常性ルール違反を構成する条件評価基準。

文字列

デフォルト：ALL

Enums

ALL

ANY

CUSTOM

conditionExpression

conditionAggregationType 変数を CUSTOM に設定する場合にのみ使用します。ブール式を定義するには、条件の ShortName を使用します。

文字列

minLength: 1

conditions^*

true または false に個別に評価できる単一の条件。または

条件のリスト（最大 8 つ）と、基準を形成するための他のプロパティ。

文字列

minItems：1

条件

プロパティ説明タイプ/列挙体

name^* 条件の名前。 string

shortname^*

CUSTOM conditionType. の評価に conditionExpression で使用される短縮名。

string

パターン：^[A-Z]{1,3}$

Enums

A

B

C

D

E

F

G

H

evaluateToTrueOnNoData

条件がベースになっている任意のメトリックがデータを返さない場合の条件の評価を制御します。データが返されない場合のデフォルトは、条件が unknown と評価されます。正常性ルールが true に評価されるすべての条件に基づいている場合、データが返されないと、正常性ルールがアクションをトリガーするかどうかに影響を与える可能性があります。

boolean

デフォルト：false

evalDetail^*

条件の評価対象として考慮されるメトリックの詳細。SINGLE_METRIC は単一のメトリックを評価するために使用します。METRIC_EXPRESSION はメトリック式を評価するために使用します。

ConditionEvalDetail

プロパティ	タイプ	Enums
`evalDetailType`	string	`SINGLE_METRIC` `METRIC_EXPRESSION`

triggerEnabled

true に設定すると、フィールド minimumTriggers の値が評価対象と見なされます。

boolean

デフォルト： false

minimumTriggers ゼロ以外の値を設定すると、条件を評価するときに永続的しきい値が考慮されます。useDataFromLastNMinutes より小さい値を定義していることを確認します。 integer
デフォルト：0
最小値：0
最大値：30

evalMatchingCriteria

次の正常性ルールタイプの条件を評価する基準。

ビジネストランザクション
ノードの正常性ハードウェア
ノードの正常性トランザクションパフォーマンス

正常性ルールに違反したと見なされるために必要な、影響を受けたエンティティで条件に違反しているノードの数を定義します。

NodeEvalMatchingCriteria

プロパティ説明タイプ/列挙体

matchType

正常性ルールに違反したと見なされるために必要な、影響を受けたエンティティで条件に違反しているノードの数を定義する評価範囲タイプ。

matchType として PERCENTAGE_NODES または NUMBER_OF_NODES を選択した場合にのみ一致基準を入力します。

文字列

Enums

AVERAGE

ANY_NODE

PERCENTAGE_NODES NUMBER_OF_NODES

value

正常性ルール違反を構成するために条件に違反する必要があるノードの数または割合。NUMBER_OF_NODES を選択した場合は、整数を入力します。PERCENTAGE_NODES を選択した場合は、番号を入力します。

HealthRuleSummary

プロパティ	タイプ
`id^*`	整数
`name`	文字列
`enabled^*`	boolean

ErrorResponse

プロパティ	タイプ
`statusCode`	整数
`message`	文字列

^*This property is required (mandatory).

例のダウンロード

正常性ルール health_rule_request_examples.zip を設定するのに役立つ一連の例をダウンロードします。

Swagger YAML 仕様のダウンロード

Swagger YAML 仕様 health_rule_openapi.yml をダウンロードします。