正常性ルール API

Related pages

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

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

Create a Health Rule

Creates a new health rule from the specified JSON payload. See Property Details.

Resource URL

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

Request/Response Format

JSON

Example

This example creates a health rule with an affected entity type business transaction performance and defines the evaluation criteria for the health rule. See Download Examples.

Request
{
  "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
            }
          }
        }
      ]
    }
  }
}
Response
{
    "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
            }
        }
    }
}

Retrieve a List of Health Rules for an Application

This API returns a list of all the health rule IDs and names for the specified application ID. To retrieve complete details of the health rule, use GET //health-rule/{health-rule-id}. See Property Details.

Resource URL

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

Response Format

JSON

Example Response

[
    {
        "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
    }
]

Retrieve Details of a Specified Health Rule

This API Returns the health rule details for the specified health rule ID.

Resource URL

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

Response Format

JSON

Example Response

{
    "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
            }
        }
    }
}

Update a Health Rule

This API updates an existing health rule (required fields) with details from the specified health rule ID. See Property Details.

警告: To safeguard against potential API abuse of Splunk AppDynamics SaaS , you must limit the API calls to no more than 100 requests per minute to the specified API endpoint. Exceeding this threshold limit may result in the blocking of additional call requests to Splunk AppDynamics SaaS to maintain system integrity.

Resource URL

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

Request/Response Format

JSON

Example

Request
{
  "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
            }
          }
        }
      ]
    }
  }
}
Response
{
  "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
            }
          }
        }
      ]
    }
  }
}

Delete a Health Rule

Deletes an existing health rule with the specified ID.

Resource URL

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

Update a Health Rule Configuration

This API updates one or more configuration setting(s) of a health rule. See Property Details

You can enter one or both of the following field(s) in the request:

  • Enable/disable the health rule.
  • Update the schedule of the health rule.

Resource URL

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

Request/Response Format

JSON

Example

Request
{
  "enabled": "false",
  "scheduleName": "Weeknights: 11pm-6am, Mon-Fri"
}
Response
{
    "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
            }
        }
    }
}

Enable All Health Rules

Enables all the health rules of an application.

Resource URL

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

Disable All Health Rules

Disable all the health rules of an application.

Resource URL

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

応答コード

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

Property Details

HealthRule

プロパティ名 タイプと有効な値説明
id 整数

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

これは readOnly 値です。

name

文字列

最小長:1

正常性ルールの名前。

enabled

boolean

デフォルト値:true

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

useDataFromLastNMinutes

整数

最小値:1

最大値:360

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

waitTimeAfterViolation

整数

最小時間:1 分

違反後の待機時間(分単位)。

scheduleName

文字列

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

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

affects*

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

影響
プロパティタイプEnums
affectedEntity タイプ文字列

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

EUM_API_MON

EUM_BROWSER_APPS

EUM_MOBILE_APPS

ADVANCED_NETWORK

OVERAGE_EVENT_TYPE

JMX

evalCriterias*

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

  • critical または
  • warning
criticalCriteria

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

プロパティ 説明 タイプ/列挙体
conditionAggregationType正常性ルール違反を構成する条件評価基準。

String

default: ALL

Enums

ALL

ANY

CUSTOM

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

文字列

minLength: 1

conditions*

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

または

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

文字列

minItems: 1

条件
プロパティ 説明 タイプ/列挙体
name* 条件の名前。文字列
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
プロパティ 説明 タイプ/列挙体
evalDetailType文字列

SINGLE_METRIC

METRIC_EXPRESSION

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

boolean

デフォルト:false

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

整数

デフォルト:0

最小値:0

最大値:30

evalMatchingCriteria 次の正常性ルールタイプの条件を評価する基準。
  • ビジネストランザクション
  • ノードの正常性ハードウェア
  • ノードの正常性トランザクション パフォーマンス

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

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

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

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

文字列

Enums

AVERAGE

ANY_NODE

PERCENTAGE_NODESNUMBER_OF_NODES

value

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

最小値:0

warningCriteria

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

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

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

文字列

デフォルト:ALL

Enums

ALL

ANY

カスタム

conditionExpression

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

文字列

minLength: 1

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

文字列

minLength: 1

条件

プロパティ説明タイプ/列挙体
name*条件の名前。文字列
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
プロパティ 説明 タイプ/列挙体
evalDetailType文字列

SINGLE_METRIC

METRIC_EXPRESSION

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

boolean

デフォルト:false

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

整数

デフォルト: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

文字列

MetricEvalDetail

プロパティタイプEnums
metricEvalDetailType*

文字列

BASELINE_TYPE

SPECIFIC_TYPE

BaselineMetricEvalDetail

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

プロパティタイプEnums
metricEvalDetailType*

文字列

BASELINE_TYPE

SPECIFIC_TYPE

baselineCondition* 文字列

WITHIN_BASELINE

NOT_WITHIN_BASELINE

GREATER_THAN_BASELINE

LESS_THAN_BASELINE

baselineName*

文字列

minLength: 1

compareValue*

最小値:0

baselineUnit* 文字列

STANDARD_DEVIATIONS

パーセンテージ

SpecificValueMetricEvalDetail

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

プロパティタイプEnums
metricEvalDetailType*

文字列

BASELINE_TYPE

SPECIFIC_TYPE

compareCondition* 文字列

GREATER_THAN_SPECIFIC_VALUE

LESS_THAN_SPECIFIC_VALUE

compareValue*

最小値:0

MetricAggregateFunction

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

プロパティタイプEnums

MetricAggregateFunction*

文字列

MINIMUM

最大

VALUE

SUM

COUNT

CURRENT

GROUP_COUNT

SingleMetricEvalDetail

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

プロパティタイプEnums

evalDetailType

文字列

SINGLE_METRIC

METRIC_EXPRESSION

metricAggregateFunction* 文字列

MINIMUM

最大

VALUE

SUM

COUNT

CURRENT

GROUP_COUNT

metricPath*

文字列

minLength: 1

注:

マシンエージェント階層を含む正常性ルールのメトリックパスが適切に解決されるようにするには、カスタムメトリックの縦棒の前にエスケープ文字「\\」を追加します。例:

Application Infrastructure Performance|Root\\|Containers\\|Fulfillment-Service|Individual Nodes|9b711cda4a83|Hardware Resources|CPU|%Busy
metricEvalDetail* 文字列

BASELINE_TYPE

SPECIFIC_TYPE

MetricExpressionEvalDetail

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

プロパティタイプEnums

evalDetailType

文字列

SINGLE_METRIC

METRIC_EXPRESSION

metricExpression*

文字列

minLength: 1

metricExpressionVariables*

文字列

minItems: 1

MetricDetailWithVariableName
プロパティタイプEnums
variableName*

文字列

minLength: 1

metricAggregateFunction* 文字列

MINIMUM

最大

VALUE

SUM

COUNT

CURRENT

GROUP_COUNT

metricPath*

文字列

minLength: 1

metricEvalDetail* 文字列 SpecificValueMetricEvalDetail
プロパティタイプEnums
metricEvalDetailType*

文字列

BASELINE_TYPE

SPECIFIC_TYPE

compareCondition* 文字列

GREATER_THAN_SPECIFIC_VALUE

LESS_THAN_SPECIFIC_VALUE

compareValue*

最小値:0

MetricDetailWithVariableName

プロパティタイプEnums
variableName*

文字列

minLength: 1

metricAggregateFunction* 文字列

MINIMUM

最大

VALUE

SUM

COUNT

CURRENT

GROUP_COUNT

metricPath*

文字列

minLength: 1

NodeEvalMatchingCriteria

プロパティ タイプEnums
matchType

文字列

AVERAGE

ANY_NODE

PERCENTAGE_NODES

NUMBER_OF_NODES

value

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

最小値:0

状態

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

プロパティ説明タイプ/列挙体
name* 条件の名前。文字列
shortname* CUSTOM conditionType の評価に conditionExpression で使用される短縮名。

文字列

パターン:^[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 文字列

SINGLE_METRIC

METRIC_EXPRESSION

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

boolean

デフォルト:false

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

整数

デフォルト:0

最小値:0

最大値:30

ConditionEvalDetail

プロパティタイプEnums
evalDetailType 文字列

SINGLE_METRIC

METRIC_EXPRESSION

基準

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

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

文字列

デフォルト:ALL

Enums

ALL

ANY

カスタム

conditionExpression

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

文字列

minLength: 1

conditions*

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

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

文字列

minItems: 1

条件
プロパティ説明タイプ/列挙体
name*条件の名前。文字列
shortname*CUSTOM conditionType を評価するために、conditionExpression で使用される短い名前。

文字列

パターン:^[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 文字列

SINGLE_METRIC

METRIC_EXPRESSION

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

boolean

デフォルト:false

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

整数

デフォルト: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* 文字列

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue*

文字列

minLength: 1

shouldNot boolean

AffectedTiers

プロパティタイプEnums
affectedTierScope* 文字列

ALL_TIERS

SPECIFIC_TIERS

TIERS_BY_TAGS

AllTiers

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

プロパティタイプEnums
affectedTierScope* 文字列

ALL_TIERS

SpecificTiers

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

プロパティタイプEnums
affectedTierScope* 文字列

SPECIFIC_TIERS

tiers*

文字列

minItems: 1

TiersByTags

影響を受ける階層の範囲が、タグ条件に一致するすべての階層に設定されます。

プロパティタイプEnums
affectedTierScope* 文字列TIERS_BY_TAGS
tagVarPairs*

配列

minItems: 1

プロパティタイプEnums
propertyType* 文字列

TAG

name*

文字列

minLength: 1

value*

文字列

minLength: 1

AffectedNodes

プロパティタイプEnums
affectedNodeScope* 文字列

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

AffectedNodes

AffectedNodes
プロパティタイプEnums
affectedNodeScope* 文字列

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

NODES_BY_TAGS

AllNodes

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

プロパティタイプEnums
affectedNodeScope* 文字列

ALL_NODES

SpecificNodes

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

プロパティタイプEnums
affectedNodeScope* 文字列

SPECIFIC_NODES

nodes*

文字列

minItems: 1

NodesOfSpecificTiers

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

プロパティタイプEnums
affectedNodeScope* 文字列

NODES_OF_SPECIFIC_TIERS

specificTiers*

文字列

minItems: 1

NodesMatchingPattern

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

プロパティタイプEnums
affectedNodeScope* 文字列

NODES_MATCHING_PATTERN

patternMatcher* EntityMatchingPattern
プロパティタイプEnums
matchTo* 文字列

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue*

文字列

minLength: 1

shouldNot boolean

NodePropertyVariableMatcher

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

プロパティタイプEnums
affectedNodeScope* 文字列

NODE_PROPERTY_VARIABLE_MATCHER

propVarPairs*

配列

minItems: 1

プロパティタイプEnums
propertyType 文字列

META

ENV

JVM

TAG

name

文字列

minLength: 1

value

文字列

minLength: 1

OverallApplicationPerformance

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

プロパティタイプEnums
affectedEntityType* 文字列

OVERALL_APPLICATION_PERFORMANCE

BusinessTransactionPerformance

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

プロパティタイプEnums
affectedEntityType* 文字列

BUSINESS_TRANSACTION_PERFORMANCE

affectedBusinessTransactions* 文字列 AffectedBusinessTransactions
プロパティタイプEnums
businessTransactionScope* 文字列

ALL_BUSINESS_TRANSACTIONS

SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

BUSINESS_TRANSACTIONS_BY_TAGS

AffectedBusinessTransactions

プロパティタイプEnums
businessTransactionScope* 文字列

ALL_BUSINESS_TRANSACTIONS

SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

BUSINESS_TRANSACTIONS_BY_TAGS

AllBusinessTransactions

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

プロパティタイプEnums
businessTransactionScope* 文字列

ALL_BUSINESS_TRANSACTIONS

SpecificBusinessTransactions

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

プロパティタイプEnums
businessTransactionScope* 文字列

SPECIFIC_BUSINESS_TRANSACTIONS

businessTransactions*

文字列

minItems: 1

BusinessTransactionsInSpecificTiers

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

プロパティタイプEnums
businessTransactionScope* 文字列

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

specificTiers*

文字列

minItems: 1

BusinessTransactionsMatchingPattern

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

プロパティタイプEnums
businessTransactionScope* 文字列

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

specificTiers*

文字列

EntityMatchingPattern
プロパティタイプEnums
matchTo* 文字列

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue*

文字列

minLength: 1

shouldNot boolean

BUSINESS_TRANSACTIONS_BY_TAGS

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

プロパティタイプEnum
businessTransactionScope*文字列

BUSINESS_TRANSACTIONS_BY_TAGS

tagVarPairs*

配列

minItems: 1

プロパティタイプEnum
propertyType*文字列TAG
name*

文字列

minLength: 1

value*

文字列

minLength: 1

TierNodeTransactionPerformance

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

プロパティタイプEnums
affectedEntityType* 文字列

TIER_NODE_TRANSACTION_PERFORMANCE

affectedEntities* 文字列 AffectedTierOrNodeEntities
プロパティタイプEnums
tierOrNode* 文字列

TIER_AFFECTED_ENTITIES

NODE_AFFECTED_ENTITIES

AffectedTierOrNodeEntities

プロパティタイプEnums
tierOrNode* 文字列

TIER_AFFECTED_ENTITIES

NODE_AFFECTED_ENTITIES

TierAffectedEntities

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

プロパティタイプEnums
tierOrNode* 文字列

TIER_AFFECTED_ENTITIES

NODE_AFFECTED_ENTITIES

affectedTiers* 文字列 AffectedTiers
プロパティタイプEnums
affectedTierScope* 文字列

ALL_TIERS

SPECIFIC_TIERS

NodeAffectedEntities

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

プロパティタイプEnums
tierOrNode* 文字列

TIER_AFFECTED_ENTITIES

NODE_AFFECTED_ENTITIES

typeofNode* 文字列

ALL_NODES

JAVA_NODES

DOT_NET_NODES

PHP_NODES

affectedNodes* 文字列 AffectedNodes
プロパティタイプEnums
affectedNodeScope* 文字列

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

NODES_BY_TAGS

TierNodeHardware

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

プロパティタイプEnums
affectedEntityType* 文字列

TIER_NODE_HARDWARE

affectedEntities* 文字列 AffectedTierOrNodeEntities
プロパティタイプEnums
tierOrNode* 文字列

TIER_AFFECTED_ENTITIES

NODE_AFFECTED_ENTITIES

ServersInApplication

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

プロパティタイプEnums
affectedEntityType* 文字列

SERVERS_IN_APPLICATION

affectedServers* 文字列 ApplicationAffectedServers
プロパティタイプEnums
serversScope* 文字列

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

APM_SERVERS_BY_TAGS

ApplicationAffectedServers

プロパティタイプEnums
s erversScope* 文字列

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

APM_SERVERS_BY_TAGS

AllServersInApplication

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

プロパティタイプEnums
serversScope* 文字列

ALL_SERVERS_IN_APPLICATION

SpecificServersInApplication

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

プロパティタイプEnums
serversScope* 文字列

SPECIFIC_SERVERS_IN_APPLICATION

specificServers*

文字列

minLength: 1

AllServersInSpecificTiers

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

プロパティタイプEnums
serversScope* 文字列

ALL_SERVERS_IN_SPECIFIC_TIERS

specificTiers*

文字列

minItems: 1

ApmServersByTags

サーバーの範囲が、タグ条件に一致するすべてのサーバーに設定されます。

プロパティタイプEnums
serversScope* 文字列 APM_SERVERS_BY_TAGS
tagVarPairs*

配列

minItems: 1

プロパティタイプEnums
propertyType* 文字列

TAG

name*

文字列

minLength: 1

value*

文字列

minLength: 1

バックエンド

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

プロパティタイプEnums
affectedEntityType* 文字列

BACKENDS

affectedBackends* 文字列 AffectedBackends
プロパティタイプEnums
backendScope* 文字列

ALL_BACKENDS

SPECIFIC_BACKENDS

BACKENDS_MATCHING_PATTERN

AffectedBackends

プロパティタイプEnums
backendScope* 文字列

ALL_BACKENDS

SPECIFIC_BACKENDS

BACKENDS_MATCHING_PATTERN

AllBackends

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

プロパティタイプEnums
backendScope* 文字列

ALL_BACKENDS

SpecificBackends

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

プロパティタイプEnums
backendScope* 文字列

SPECIFIC_BACKENDS

backends*

文字列

minItems: 1

BackendsMatchingPattern

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

プロパティタイプEnums
backendScope* 文字列

BACKENDS_MATCHING_PATTERN

patternMatcher*

文字列

EntityMatchingPattern
プロパティタイプEnums
matchTo*文字列

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue*

文字列

minLength: 1

shouldNotboolean

エラー

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

プロパティタイプEnums
affectedEntityType* 文字列

エラー

affectedErrors* 文字列 AffectedErrors
プロパティタイプEnums
errorScope* 文字列

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

AffectedErrors

プロパティタイプEnums
errorScope* 文字列

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

AllErrors

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

プロパティタイプEnums
errorScope* 文字列

ALL_ERRORS

SpecificErrors

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

プロパティタイプ説明/列挙型
errorScope* 文字列

SPECIFIC_ERRORS

errors*

文字列

minItems: 1

階層

文字列

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
}
}

ErrorsOfSpecificTiers

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

プロパティタイプEnums
errorScope* 文字列

ERRORS_OF_SPECIFIC_TIERS

specificTiers*

文字列

minItems: 1

ErrorsMatchingPattern

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

プロパティタイプEnums
errorScope* 文字列

ERRORS_MATCHING_PATTERN

patternMatcher 文字列 EntityMatchingPattern
プロパティタイプEnums
matchTo*文字列

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue*

文字列

minLength: 1

shouldNotboolean

ServiceEndpoints

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

プロパティタイプEnums
affectedEntityType* 文字列

SERVICE_ENDPOINTS

affectedServiceEndpoints* AffectedServiceEndpoints
プロパティタイプEnums
serviceEndpointScope* 文字列

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

AffectedServiceEndpoints

プロパティタイプEnums
serviceEndpointScope* 文字列

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

AllServiceEndpoints

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

プロパティタイプEnums
serviceEndpointScope* 文字列

ALL_SERVICE_ENDPOINTS

SpecificServiceEndpoints

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

プロパティタイプEnums
serviceEndpointScope* 文字列

SPECIFIC_SERVICE_ENDPOINTS

serviceEndpoints*

文字列

minItems: 1

ServiceEndpointsInSpecificTiers

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

プロパティタイプEnums
serviceEndpointScope* 文字列

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

specificTiers*

文字列

minItems: 1

ServiceEndpointsMatchingPattern

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

プロパティタイプEnums
serviceEndpointScope* 文字列

SERVICE_ENDPOINTS_MATCHING_PATTERN

patternMatcher*

文字列

minItems: 1

EntityMatchingPattern
プロパティタイプEnums
matchTo*文字列

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue*

文字列

minLength: 1

shouldNotboolean

InformationPoints

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

プロパティタイプEnums
affectedEntityType* 文字列

INFORMATION_POINTS

affectedInformationPoints* 文字列
AffectedInformationPoints
プロパティタイプEnums
informationPointScope* 文字列

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

AffectedInformationPoints

プロパティタイプEnums
informationPointScope* 文字列

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

AllInformationPoints

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

プロパティタイプEnums
informationPointScope* 文字列

ALL_INFORMATION_POINTS

SpecificInformationPoints

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

プロパティタイプEnums
informationPointScope* 文字列

SPECIFIC_INFORMATION_POINTS

informationPoints*

文字列

minItems: 1

InformationPointsMatchingPattern

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

プロパティタイプEnums
informationPointScope* 文字列

INFORMATION_POINTS_MATCHING_PATTERN

patternMatcher*

文字列

minItems: 1

EntityMatchingPattern
プロパティタイプEnums
matchTo*文字列

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue*

文字列

minLength: 1

shouldNotboolean

カスタム

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

プロパティタイプEnums
affectedEntityType* 文字列

カスタム

affectedEntityScope* 文字列 AffectedEntityScope
プロパティタイプEnums
entityScope* 文字列

APPLICATION_PERFORMANCE

SPECIFIC_ENTITY_PERFORMANCE

AffectedEntityScope

プロパティタイプEnums
entityScope* 文字列

APPLICATION_PERFORMANCE

SPECIFIC_ENTITY_PERFORMANCE

ApplicationPerformance

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

プロパティタイプEnums
entityScope* 文字列

APPLICATION_PERFORMANCE

SpecificEntityPerformance

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

プロパティタイプEnums
entityScope* 文字列

SPECIFIC_ENTITY_PERFORMANCE

entityType* 文字列

BUSINESS_TRANSACTION

ノード

SERVER

affectedEntityName*

文字列

minLength: 1

データベース

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

プロパティタイプEnums
affectedEntityType* 文字列

DATABASES

databaseType* 文字列

ALL_DATABASE_TYPES

COUCHBASE

DB2

MONGO_DB

MICROSOFT_SQL_SERVER

MYSQL

ORACLE

POSTGRE_SQL

AZURE_SQL

SYBASE

affectedDatabases* 文字列 AffectedDatabases
プロパティタイプEnums
databaseScope 文字列

ALL_DATABASES

SPECIFIC_DATABASES

AffectedDatabases

プロパティタイプEnums
databaseScope* 文字列

ALL_DATABASES

SPECIFIC_DATABASES

AllDatabases

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

プロパティタイプEnums
databaseScope* 文字列

ALL_DATABASES

SpecificDatabases

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

プロパティタイプEnums
databaseScope* 文字列

SPECIFIC_DATABASES

databases*

文字列

minItems: 1

DbServer
プロパティタイプ
serverName*

文字列

minLength: 1

collectorConfigName*

文字列

minLength: 1

DbServer

プロパティタイプ
serverName*

文字列

minLength: 1

collectorConfigName*

文字列

minLength: 1

サーバー

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

プロパティタイプEnums
affectedEntityType* 文字列

サーバー

serverSelectionCriteria* 文字列 AffectedServersCriteria
プロパティタイプEnums
selectServersBy* 文字列

AFFECTED_SERVER_SUBGROUPS

AFFECTED_SERVERS

AffectedServersCriteria

プロパティタイプEnums
selectServersBy* 文字列

AFFECTED_SERVER_SUBGROUPS

AFFECTED_SERVERS

AffectedServers

プロパティタイプEnums
selectServersBy* 文字列

AFFECTED_SERVER_SUBGROUPS

AFFECTED_SERVERS

affectedServers* 文字列 ServerSelectionCriteria
プロパティタイプEnums
severSelectionScope* 文字列

ALL_SERVERS_IN_ACCOUNT

SERVERS_WITHIN_SUBGROUP

SPECIFIC_SERVERS

SERVERS_MATCHING_PATTERN

SERVERS_BY_TAGS

ServerSelectionCriteria

プロパティタイプEnums
severSelectionScope* 文字列

ALL_SERVERS_IN_ACCOUNT

SERVERS_WITHIN_SUBGROUP

SPECIFIC_SERVERS

SERVERS_MATCHING_PATTERN

SERVERS_BY_TAGS

AllServersInAccount

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

プロパティタイプEnums
severSelectionScope* 文字列

ALL_SERVERS_IN_ACCOUNT

ServersWithinSubGroup

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

プロパティタイプEnums
severSelectionScope* 文字列

SERVERS_WITHIN_SUBGROUP

subGroups*

文字列

minItems: 1

SpecificServers

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

プロパティタイプEnums
severSelectionScope* 文字列

SPECIFIC_SERVERS

servers*

文字列

minItems: 1

ServersMatchingPattern

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

プロパティタイプEnums
severSelectionScope* 文字列

SERVERS_MATCHING_PATTERN

patternMatcher* EntityMatchingPattern
プロパティタイプEnums
matchTo*文字列

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue*

文字列

minLength: 1

shouldNotboolean

ServersByTags

影響を受けるサーバーの範囲が、タグ条件と一致するサーバーになります。

プロパティタイプEnums
severSelectionScope* 文字列 SERVERS_BY_TAGS
tagVarPairs*

配列

minItems: 1

プロパティタイプEnum
propertyType*文字列

TAG

name*

文字列

minLength: 1

value*

文字列

minLength: 1

AffectedServerSubGroups

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

プロパティタイプEnums
selectServersBy* 文字列

AFFECTED_SERVER_SUBGROUPS

subGroups*

文字列

minItems: 1

AffectedSubGroups
プロパティタイプEnums
subGroupScope* 文字列

ALL_SUBGROUPS

SPECIFIC_SERVER_SUB_GROUPS

AffectedSubGroups

プロパティタイプEnums
subGroupScope* 文字列

ALL_SUBGROUPS

SPECIFIC_SERVER_SUB_GROUPS

AllSubGroups

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

subGroupScope* 文字列

ALL_SUBGROUPS

SpecificServerSubGroups

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

プロパティタイプEnums
subGroupScope* 文字列

SPECIFIC_SERVER_SUB_GROUPS

subGroupNames

文字列

minItems: 1

AffectedEumBrowserEntities

正常性ルールが影響を与えることができるエンドユーザーモニタリング(EUM)ブラウザエンティティについて説明します。

プロパティタイプEnum
affectedEumEntityType* 文字列

EUM_PAGES

EUM_VIRTUAL_PAGES

EUM_IFRAMES

EUM_AJAX_REQUESTS

EumPages

正常性ルールがモニターできるエンドユーザーモニタリング(EUM)ページについて説明します。

プロパティタイプEnum
affectedPages* 文字列
プロパティタイプEnum
affectedPageScope* 文字列

ALL_PAGES

SPECIFIC_PAGES

PAGES_MATCHING_PATTERN

PAGES_BY_TAGS

AllPages

影響を受けるページの範囲が、すべてのページに設定されます。

プロパティタイプEnum
affectedPageScope* 文字列 ALL_PAGES

SpecificPages

影響を受けるページの範囲が、特定のページに設定されます。

プロパティタイプEnum
affectedPageScope* 文字列 SPECIFIC_PAGES
pages*

文字列

minItems: 1

PagesMatchingPattern

影響を受けるページの範囲が、パターンに一致するページに設定されます。

プロパティタイプEnum
affectedPageScope* 文字列 PAGES_MATCHING_PATTERN
patternMatcher* EntityMatchingPattern
プロパティタイプEnums
matchTo*文字列

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue*

文字列

minLength: 1

shouldNotboolean

PagesByTags

影響を受けるページの範囲が、タグ条件に一致するページに設定されます。

プロパティタイプEnum
affectedPageScope* 文字列 PAGES_BY_TAGS
tagVarPairs*

配列

minItems: 1

プロパティタイプEnum
propertyType* 文字列

TAG

name

文字列

minLength: 1

value

文字列

minLength: 1

JMX

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

プロパティタイプEnum

affectedEntityType

文字列JMX

affectedEntities*

文字列

AffectedJmxEntities

プロパティタイプEnum

jmxOrNode*

文字列

JMX_INSTANCE_NAME

ノード

metricPath*

文字列

affectedNodes*

JmxNodeAffectedEntities

プロパティタイプEnum

affectedNodes*

AffectedNodes

affectedJmxInstanceNames*

JmxInstanceNameAffectedEntities

プロパティタイプEnum

affectedJmx*

AffectedJmxInstance

プロパティタイプEnum
affectedJmxInstanceScope*文字列ALL_JMX_INSTANCESPECIFIC_JMX_INSTANCE

影響を受ける JMX インスタンス

影響を受ける JMX インスタンスの範囲は、すべての JMX インスタンスと特定の JMX インスタンスに設定されます。

プロパティタイプEnum

affectedJmxInstanceScope

文字列

ALL_JMX_INSTANCE

SPECIFIC_JMX_INSTANC

すべての JMX インスタンス

JMX インスタンスの範囲は、エンティティのすべての JMX インスタンスに設定されます。

プロパティタイプEnum

affectedJmxInstanceScope*

文字列

ALL_JMX_INSTANCE

特定の JMX インスタンス

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

プロパティタイプEnum

affectedJmxInstanceScope

文字列

SPECIFIC_JMX_INSTANCE

jmxInstance*

配列

minItems: 1

例:

できません

direct

PS Scavenge

HealthRuleSummary

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

ErrorResponse

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

*このプロパティは必須です。

例のダウンロード

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

例:タグを使用した正常性ルール

次のセクションでは、タグを使用した正常性ルールに関連するいくつかの例を示します。

警告: カスタムタグ付け機能を使用するには、アカウントレベルの設定 entity.tagging.enabled を有効にする必要があります。これはデフォルトで無効になっています。この機能を使用するには、管理コンソールで entity.tagging.enabled アカウントレベルプロパティを true に設定します。「カスタムタグ API」を参照してください。

タグを使用した階層の正常性ルールの作成

この例では、タグ条件に一致する影響を受けるエンティティタイプ TIER_NODE_TRANSACTION_PERFORMANCE を使用して正常性ルールを作成します。

Resource URL

POST <controller_url>/controller/alerting/rest/v1/applications/10/health-rules
リクエスト
{
    "name": "Health rule for tiers with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "TIER_NODE_TRANSACTION_PERFORMANCE",
        "affectedEntities": {
            "tierOrNode": "TIER_AFFECTED_ENTITIES",
            "affectedTiers": {
                "affectedTierScope": "TIERS_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
 
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Calls per Minute",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 11
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        },
        "warningCriteria": null
    }
}
レスポンス
{
    "id": 63,
    "name": "Health rule for tiers with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "TIER_NODE_TRANSACTION_PERFORMANCE",
        "affectedEntities": {
            "tierOrNode": "TIER_AFFECTED_ENTITIES",
            "affectedTiers": {
                "affectedTierScope": "TIERS_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Calls per Minute",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 11
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        },
        "warningCriteria": null
    }
}

タグを使用した階層の正常性ルールの取得

この例では、タグを使用して階層の正常性を取得します。

Resource URL

 GET <controller_url>/controller/alerting/rest/v1/applications/10/health-rules/63
{
    "id": 63,
    "name": "Health rule for tiers with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "TIER_NODE_TRANSACTION_PERFORMANCE",
        "affectedEntities": {
            "tierOrNode": "TIER_AFFECTED_ENTITIES",
            "affectedTiers": {
                "affectedTierScope": "TIERS_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Calls per Minute",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 11
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": {
                "matchType": "ANY_NODE",
                "value": null
            }
        },
        "warningCriteria": null
    }
}

タグを使用したサーバーの正常性ルールの作成

この例では、タグを使用してサーバーの正常性を作成します。

Resource URL

 POST <controller_url>/controller/alerting/rest/v1/applications/3/health-rules/
リクエスト
{
    "name": "Health rule for servers with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "SERVERS",
        "serverSelectionCriteria": {
            "selectServersBy": "AFFECTED_SERVERS",
            "affectedServers": {
                "severSelectionScope": "SERVERS_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Hardware Resources|CPU|%Busy",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 5
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": null
        },
        "warningCriteria": null
    }
}
レスポンス
{
    "id": 64,
    "name": "Health rule for servers with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "SERVERS",
        "serverSelectionCriteria": {
            "selectServersBy": "AFFECTED_SERVERS",
            "affectedServers": {
                "severSelectionScope": "SERVERS_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Hardware Resources|CPU|%Busy",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 5
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": null
        },
        "warningCriteria": null
    }
}

タグを使用したサーバーの正常性ルールの取得

この例では、タグを使用してサーバーの正常性を取得します。

Resource URL

 GET <controller_url>/controller/alerting/rest/v1/applications/3/health-rules/64
{
    "id": 64,
    "name": "Health rule for servers with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 30,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "SERVERS",
        "serverSelectionCriteria": {
            "selectServersBy": "AFFECTED_SERVERS",
            "affectedServers": {
                "severSelectionScope": "SERVERS_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Hardware Resources|CPU|%Busy",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 5
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 0
                }
            ],
            "evalMatchingCriteria": null
        },
        "warningCriteria": null
    }
}

タグを使用したベースページの正常性ルールの作成

この例では、タグを使用してベースページの正常性を作成します。

Resource URL

 POST <controller_url>/controller/alerting/rest/v1/applications/16/health-rules/
リクエスト
{
    "name": "Health rule for base pages with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 1,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "EUM_BROWSER_APPS",
        "affectedEntities": {
            "affectedEumEntityType": "EUM_PAGES",
            "affectedPages": {
                "affectedPageScope": "PAGES_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "violationStatusOnNoData": "UNKNOWN",
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Application Server Time (ms)",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 1
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 1
                }
            ],
            "evalMatchingCriteria": null
        },
        "warningCriteria": null
    }
}                     
レスポンス
{
    "id": 37,
    "name": "Health rule for base pages with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 1,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "EUM_BROWSER_APPS",
        "affectedEntities": {
            "affectedEumEntityType": "EUM_PAGES",
            "affectedPages": {
                "affectedPageScope": "PAGES_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "violationStatusOnNoData": "UNKNOWN",
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Application Server Time (ms)",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 1
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 1
                }
            ],
            "evalMatchingCriteria": null
        },
        "warningCriteria": null
    }
}                   

タグを使用したベースページの正常性ルールの取得

この例では、タグを使用したベースページの正常性を取得します。

Resource URL

 GET <controller_url>/controller/alerting/rest/v1/applications/16/health-rules/37
{
    "id": 37,
    "name": "Health rule for base pages with tags",
    "enabled": true,
    "useDataFromLastNMinutes": 1,
    "waitTimeAfterViolation": 30,
    "scheduleName": "Always",
    "affects": {
        "affectedEntityType": "EUM_BROWSER_APPS",
        "affectedEntities": {
            "affectedEumEntityType": "EUM_PAGES",
            "affectedPages": {
                "affectedPageScope": "PAGES_BY_TAGS",
                "tagVarPairs": [
                    {
                        "propertyType": "TAG",
                        "name": "i_app_support_org",
                        "value": "Enterprise Platforms"
                    },
                    {
                        "propertyType": "TAG",
                        "name": "i_manufacturer",
                        "value": "Cisco"
                    }
                ]
            }
        }
    },
    "evalCriterias": {
        "criticalCriteria": {
            "conditionAggregationType": "ALL",
            "conditionExpression": null,
            "conditions": [
                {
                    "name": "Condition 1",
                    "shortName": "A",
                    "evaluateToTrueOnNoData": false,
                    "violationStatusOnNoData": "UNKNOWN",
                    "evalDetail": {
                        "evalDetailType": "SINGLE_METRIC",
                        "metricAggregateFunction": "VALUE",
                        "metricPath": "Application Server Time (ms)",
                        "metricEvalDetail": {
                            "metricEvalDetailType": "SPECIFIC_TYPE",
                            "compareCondition": "GREATER_THAN_SPECIFIC_VALUE",
                            "compareValue": 1
                        }
                    },
                    "triggerEnabled": false,
                    "minimumTriggers": 1
                }
            ],
            "evalMatchingCriteria": null
        },
        "warningCriteria": null
    }
}