웹후크 작업을 사용하는 로그 검색 경고에 대한 샘플 페이로드
로그 검색 경고 규칙에서 웹후크 작업을 사용하여 단일 HTTP POST 요청을 호출할 수 있습니다. 이 문서에서는 웹후크를 사용하도록 작업 그룹을 구성할 때 사용할 수 있는 속성에 대해 설명합니다. 호출되는 서비스는 웹후크를 지원하고 수신하는 페이로드를 사용하는 방법을 알고 있어야 합니다.
웹후크 통합에 공통 경고 스키마를 사용하는 것이 좋습니다. 일반적인 경고 스키마는 Azure Monitor의 모든 경고 서비스에 걸쳐 확장 가능하고 통합된 단일 경고 페이로드를 갖는 이점을 제공합니다.
사용자 지정 JSON 페이로드가 정의된 로그 검색 경고 규칙의 경우 일반적인 경고 스키마를 사용하도록 설정하면 일반 경고 스키마에 설명된 것과 되돌리기 페이로드 스키마가 사용됩니다. 사용자 지정 JSON 페이로드를 정의하려는 경우 웹후크는 일반적인 경고 스키마를 사용할 수 없습니다.
공통 스키마가 활성화된 경고는 경고당 256KB로 제한됩니다. 더 큰 경고에는 검색 결과가 포함되지 않습니다. 검색 결과가 포함되지 않은 경우 Log Analytics API를 통해 쿼리 결과를 사용 LinkToFilteredSearchResultsAPI 하거나 LinkToSearchResultsAPI 액세스합니다.
샘플 페이로드에는 페이로드가 표준이며 사용자 지정인 경우의 예제가 포함됩니다.
모든 리소스 로그에 대한 로그 검색 경고(API 버전 2021-08-01에서)
다음 샘플 페이로드는 리소스 로그를 기반으로 로그 검색 경고에 사용되는 경우 표준 웹후크에 대한 것입니다.
{
"schemaId": "azureMonitorCommonAlertSchema",
"data": {
"essentials": {
"alertId": "/subscriptions/12345a-1234b-123c-123d-12345678e/providers/Microsoft.AlertsManagement/alerts/12345a-1234b-123c-123d-12345678e",
"alertRule": "AcmeRule",
"severity": "Sev4",
"signalType": "Log",
"monitorCondition": "Fired",
"monitoringService": "Log Alerts V2",
"alertTargetIDs": [
"/subscriptions/12345a-1234b-123c-123d-12345678e/resourcegroups/ai-engineering/providers/microsoft.compute/virtualmachines/testvm"
],
"originAlertId": "123c123d-1a23-1bf3-ba1d-dd1234ff5a67",
"firedDateTime": "2020-07-09T14:04:49.99645Z",
"description": "log alert rule V2",
"essentialsVersion": "1.0",
"alertContextVersion": "1.0"
},
"alertContext": {
"properties": {
"name1": "value1",
"name2": "value2"
},
"conditionType": "LogQueryCriteria",
"condition": {
"windowSize": "PT10M",
"allOf": [
{
"searchQuery": "Heartbeat",
"metricMeasureColumn": "CounterValue",
"targetResourceTypes": "['Microsoft.Compute/virtualMachines']",
"operator": "LowerThan",
"threshold": "1",
"timeAggregation": "Count",
"dimensions": [
{
"name": "ResourceId",
"value": "/subscriptions/12345a-1234b-123c-123d-12345678e/resourceGroups/TEST/providers/Microsoft.Compute/virtualMachines/testvm"
}
],
"metricValue": 0.0,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
},
"linkToSearchResultsUI": "https://portal.azure.com#@12f345bf-12f3-12af-12ab-1d2cd345db67/blade/Microsoft_Azure_Monitoring_Logs/LogsBlade/source/Alerts.EmailLinks/scope/%7B%22resources%22%3A%5B%7B%22resourceId%22%3A%22%2Fsubscriptions%2F12345a-1234b-123c-123d-12345678e%2FresourceGroups%2FTEST%2Fproviders%2FMicrosoft.Compute%2FvirtualMachines%2Ftestvm%22%7D%5D%7D/q/eJzzSE0sKklKTSypUSjPSC1KVQjJzE11T81LLUosSU1RSEotKU9NzdNIAfJKgDIaRgZGBroG5roGliGGxlYmJlbGJnoGEKCpp4dDmSmKMk0A/prettify/1/timespan/2020-07-07T13%3a54%3a34.0000000Z%2f2020-07-09T13%3a54%3a34.0000000Z",
"linkToFilteredSearchResultsUI": "https://portal.azure.com#@12f345bf-12f3-12af-12ab-1d2cd345db67/blade/Microsoft_Azure_Monitoring_Logs/LogsBlade/source/Alerts.EmailLinks/scope/%7B%22resources%22%3A%5B%7B%22resourceId%22%3A%22%2Fsubscriptions%2F12345a-1234b-123c-123d-12345678e%2FresourceGroups%2FTEST%2Fproviders%2FMicrosoft.Compute%2FvirtualMachines%2Ftestvm%22%7D%5D%7D/q/eJzzSE0sKklKTSypUSjPSC1KVQjJzE11T81LLUosSU1RSEotKU9NzdNIAfJKgDIaRgZGBroG5roGliGGxlYmJlbGJnoGEKCpp4dDmSmKMk0A/prettify/1/timespan/2020-07-07T13%3a54%3a34.0000000Z%2f2020-07-09T13%3a54%3a34.0000000Z",
"linkToSearchResultsAPI": "https://api.loganalytics.io/v1/subscriptions/12345a-1234b-123c-123d-12345678e/resourceGroups/TEST/providers/Microsoft.Compute/virtualMachines/testvm/query?query=Heartbeat%7C%20where%20TimeGenerated%20between%28datetime%282020-07-09T13%3A44%3A34.0000000%29..datetime%282020-07-09T13%3A54%3A34.0000000%29%29×pan=2020-07-07T13%3a54%3a34.0000000Z%2f2020-07-09T13%3a54%3a34.0000000Z",
"linkToFilteredSearchResultsAPI": "https://api.loganalytics.io/v1/subscriptions/12345a-1234b-123c-123d-12345678e/resourceGroups/TEST/providers/Microsoft.Compute/virtualMachines/testvm/query?query=Heartbeat%7C%20where%20TimeGenerated%20between%28datetime%282020-07-09T13%3A44%3A34.0000000%29..datetime%282020-07-09T13%3A54%3A34.0000000%29%29×pan=2020-07-07T13%3a54%3a34.0000000Z%2f2020-07-09T13%3a54%3a34.0000000Z"
}
],
"windowStartTime": "2020-07-07T13:54:34Z",
"windowEndTime": "2020-07-09T13:54:34Z"
}
}
}
}
Log Analytics에 대한 로그 검색 경고(최대 API 버전 2018-04-16)
다음 샘플 페이로드는 Log Analytics 기반 경고에 사용되는 표준 웹후크 작업에 대한 것입니다.
{
"SubscriptionId": "12345a-1234b-123c-123d-12345678e",
"AlertRuleName": "AcmeRule",
"SearchQuery": "Perf | where ObjectName == \"Processor\" and CounterName == \"% Processor Time\" | summarize AggregatedValue = avg(CounterValue) by bin(TimeGenerated, 5m), Computer",
"SearchIntervalStartTimeUtc": "2018-03-26T08:10:40Z",
"SearchIntervalEndtimeUtc": "2018-03-26T09:10:40Z",
"AlertThresholdOperator": "Greater Than",
"AlertThresholdValue": 0,
"ResultCount": 2,
"SearchIntervalInSeconds": 3600,
"LinkToSearchResults": "https://portal.azure.com/#Analyticsblade/search/index?_timeInterval.intervalEnd=2018-03-26T09%3a10%3a40.0000000Z&_timeInterval.intervalDuration=3600&q=Usage",
"LinkToFilteredSearchResultsUI": "https://portal.azure.com/#Analyticsblade/search/index?_timeInterval.intervalEnd=2018-03-26T09%3a10%3a40.0000000Z&_timeInterval.intervalDuration=3600&q=Usage",
"LinkToSearchResultsAPI": "https://api.loganalytics.io/v1/workspaces/workspaceID/query?query=Heartbeat×pan=2020-05-07T18%3a11%3a51.0000000Z%2f2020-05-07T18%3a16%3a51.0000000Z",
"LinkToFilteredSearchResultsAPI": "https://api.loganalytics.io/v1/workspaces/workspaceID/query?query=Heartbeat×pan=2020-05-07T18%3a11%3a51.0000000Z%2f2020-05-07T18%3a16%3a51.0000000Z",
"Description": "log alert rule",
"Severity": "Warning",
"AffectedConfigurationItems": [
"INC-Gen2Alert"
],
"Dimensions": [
{
"name": "Computer",
"value": "INC-Gen2Alert"
}
],
"SearchResult": {
"tables": [
{
"name": "PrimaryResult",
"columns": [
{
"name": "$table",
"type": "string"
},
{
"name": "Computer",
"type": "string"
},
{
"name": "TimeGenerated",
"type": "datetime"
}
],
"rows": [
[
"Fabrikam",
"33446677a",
"2018-02-02T15:03:12.18Z"
],
[
"Contoso",
"33445566b",
"2018-02-02T15:16:53.932Z"
]
]
}
]
},
"WorkspaceId": "12345a-1234b-123c-123d-12345678e",
"AlertType": "Metric measurement"
}
Application Insights에 대한 로그 검색 경고(최대 API 버전 2018-04-16)
다음 샘플 페이로드는 Application Insights 리소스를 기반으로 로그 검색 경고에 사용되는 표준 웹후크에 대한 것입니다.
{
"schemaId": "Microsoft.Insights/LogAlert",
"data": {
"SubscriptionId": "12345a-1234b-123c-123d-12345678e",
"AlertRuleName": "AcmeRule",
"SearchQuery": "requests | where resultCode == \"500\" | summarize AggregatedValue = Count by bin(Timestamp, 5m), IP",
"SearchIntervalStartTimeUtc": "2018-03-26T08:10:40Z",
"SearchIntervalEndtimeUtc": "2018-03-26T09:10:40Z",
"AlertThresholdOperator": "Greater Than",
"AlertThresholdValue": 0,
"ResultCount": 2,
"SearchIntervalInSeconds": 3600,
"LinkToSearchResults": "https://portal.azure.com/AnalyticsBlade/subscriptions/12345a-1234b-123c-123d-12345678e/?query=search+*+&timeInterval.intervalEnd=2018-03-26T09%3a10%3a40.0000000Z&_timeInterval.intervalDuration=3600&q=Usage",
"LinkToFilteredSearchResultsUI": "https://portal.azure.com/AnalyticsBlade/subscriptions/12345a-1234b-123c-123d-12345678e/?query=search+*+&timeInterval.intervalEnd=2018-03-26T09%3a10%3a40.0000000Z&_timeInterval.intervalDuration=3600&q=Usage",
"LinkToSearchResultsAPI": "https://api.applicationinsights.io/v1/apps/0MyAppId0/metrics/requests/count",
"LinkToFilteredSearchResultsAPI": "https://api.applicationinsights.io/v1/apps/0MyAppId0/metrics/requests/count",
"Description": null,
"Severity": "3",
"Dimensions": [
{
"name": "IP",
"value": "1.1.1.1"
}
],
"SearchResult": {
"tables": [
{
"name": "PrimaryResult",
"columns": [
{
"name": "$table",
"type": "string"
},
{
"name": "Id",
"type": "string"
},
{
"name": "Timestamp",
"type": "datetime"
}
],
"rows": [
[
"Fabrikam",
"33446677a",
"2018-02-02T15:03:12.18Z"
],
[
"Contoso",
"33445566b",
"2018-02-02T15:16:53.932Z"
]
]
}
]
},
"ApplicationId": "123123f0-01d3-12ab-123f-abc1ab01c0a1",
"AlertType": "Metric measurement"
}
}
사용자 지정 JSON 페이로드를 사용하여 로그 검색 경고(최대 API 버전 2018-04-16)
참고 항목
사용자 지정 JSON 기반 웹후크는 API 버전 2021-08-01에서 지원되지 않습니다.
다음 표에서는 기본 웹후크 작업 속성 및 사용자 지정 JSON 매개 변수 이름을 나열합니다.
| 매개 변수 | 변수 | 설명 |
|---|---|---|
AlertRuleName |
#alertrulename | 경고 규칙의 이름입니다. |
Severity |
#severity | 발생한 로그 검색 경고에 대한 심각도 집합입니다. |
AlertThresholdOperator |
#thresholdoperator | 경고 규칙에 대한 임계값 연산자입니다. |
AlertThresholdValue |
#thresholdvalue | 경고 규칙의 임계값입니다. |
LinkToSearchResults |
#linktosearchresults | 경고를 만든 쿼리에서 레코드를 반환하는 Analytics 포털에 연결합니다. |
LinkToSearchResultsAPI |
#linktosearchresultsapi | 경고를 만든 쿼리에서 레코드를 반환하는 Analytics API에 연결합니다. |
LinkToFilteredSearchResultsUI |
#linktofilteredsearchresultsui | 경고를 만든 차원 값 조합으로 필터링된 쿼리에서 레코드를 반환하는 Analytics 포털에 연결합니다. |
LinkToFilteredSearchResultsAPI |
#linktofilteredsearchresultsapi | 경고를 만든 차원 값 조합으로 필터링된 쿼리에서 레코드를 반환하는 Analytics API에 대한 링크입니다. |
ResultCount |
#searchresultcount | 검색 결과의 레코드 수입니다. |
Search Interval End time |
#searchintervalendtimeutc | 쿼리의 종료 시간(mm/dd/yyyy HH:mm:ss AM/PM 형식)입니다. |
Search Interval |
#searchinterval | 경고 규칙의 시간으로, HH:mm:ss 형식입니다. |
Search Interval StartTime |
#searchintervalstarttimeutc | MM/dd/yyyy HH:mm:ss AM/PM 형식의 UTC 쿼리 시작 시간입니다. |
SearchQuery |
#searchquery | 경고 규칙에서 사용하는 로그 검색 쿼리입니다. |
SearchResults |
"IncludeSearchResults": true | 쿼리에서 JSON 테이블로 반환된 레코드는 처음 1,000개의 레코드로 제한됩니다. "IncludeSearchResults": true는 사용자 지정 JSON 웹후크 정의에 최상위 속성으로 추가됩니다. |
Dimensions |
"IncludeDimensions": true | JSON 섹션으로 해당 경고를 트리거한 차원 값 조합입니다. "IncludeDimensions": true는 사용자 지정 JSON 웹후크 정의에 최상위 속성으로 추가됩니다. |
Alert Type |
#alerttype | 메트릭 측정값 또는 결과 수로 구성된 로그 검색 경고 규칙의 유형입니다. |
WorkspaceID |
#workspaceid | Log Analytics 작업 영역의 ID입니다. |
Application ID |
#applicationid | Application Insights 앱의 ID입니다. |
Subscription ID |
#subscriptionid | 사용된 Azure 구독의 ID입니다. |
웹후크에 사용자 지정 JSON 페이로드 포함을 사용하여 매개 변수를 사용하여 사용자 지정 JSON 페이로드를 가져올 수 있습니다. 더 많은 속성을 생성할 수도 있습니다.
예를 들어 호출 text된 단일 매개 변수를 포함하는 다음 사용자 지정 페이로드를 지정할 수 있습니다. 이 웹후크가 호출하는 서비스에는 다음 매개 변수가 포함됩니다.
{
"text":"#alertrulename fired with #searchresultcount over threshold of #thresholdvalue."
}
이 예제 페이로드는 웹후크로 전송될 때 다음 예제와 같이 확인됩니다.
{
"text":"My Alert Rule fired with 18 records over threshold of 10 ."
}
사용자 지정 웹후크의 변수는 JSON 엔클로저 내에서 지정해야 합니다. 예를 들어 웹후크 예제에서 참조하면 #searchresultcount 경고 결과에 따라 출력이 생성됩니다.
검색 결과를 포함하려면 사용자 지정 JSON에서 IncludeSearchResults를 최상위 속성으로 추가합니다. 검색 결과는 JSON 구조로 포함되므로 사용자 지정 정의 필드에서는 결과를 참조할 수 없습니다.
참고 항목
웹후크에 대한 사용자 지정 JSON 페이로드 포함 옵션 옆에 있는 웹후크 보기 단추는 제공된 내용의 미리 보기를 표시합니다. 실제 데이터는 포함되지 않지만 사용될 JSON 스키마를 대표합니다.
예를 들어 경고 이름 및 검색 결과만 포함하는 사용자 지정 페이로드를 만들려면 다음 구성을 사용합니다.
{
"alertname":"#alertrulename",
"IncludeSearchResults":true
}
다음 샘플 페이로드는 로그 검색 경고에 대한 사용자 지정 웹후크 작업에 대한 것입니다.
{
"alertname":"AcmeRule","IncludeSearchResults":true,
"SearchResults":
{
"tables":[
{"name":"PrimaryResult","columns":
[
{"name":"$table","type":"string"},
{"name":"Id","type":"string"},
{"name":"TimeGenerated","type":"datetime"}
],
"rows":
[
["Fabrikam","33446677a","2018-02-02T15:03:12.18Z"],
["Contoso","33445566b","2018-02-02T15:16:53.932Z"]
]
}
]
}
}