Настройка оповещений о работоспособности ресурсов с помощью шаблонов Resource Manager
В этой статье показано, как создать оповещения журнала действий службы "Работоспособность ресурсов" программным образом, используя шаблоны Azure Resource Manager и Azure PowerShell.
Служба "Работоспособность ресурсов Azure" позволяет получать сведения о текущем и прошлых состояниях работоспособности ресурсов Azure. Оповещения службы "Работоспособность ресурсов Azure" помогают практически в реальном времени сообщить вам об изменении состояния работоспособности этих ресурсов. Используя программные средства, клиенты могут создать и настроить оповещения службы "Работоспособность ресурсов" в пакетном режиме.
Примечание.
Мы рекомендуем использовать модуль Azure Az PowerShell для взаимодействия с Azure. Чтобы начать работу, см. статью Установка Azure PowerShell. Дополнительные сведения см. в статье Перенос Azure PowerShell с AzureRM на Az.
Необходимые компоненты
Чтобы следовать инструкциям на этой странице, необходимо заранее сделать следующее:
- Установите модуль Azure PowerShell.
- Создать или повторно использовать группу действий, настроенную на уведомление.
Instructions
С помощью PowerShell войдите в Azure с помощью учетной записи и выберите нужную подписку.
Login-AzAccount Select-AzSubscription -Subscription <subscriptionId>С помощью командлета
Get-AzSubscriptionможно перечислить подписки, к которым у вас есть доступ.Найдите полный идентификатор Azure Resource Manager для вашей группы действий и сохраните его:
(Get-AzActionGroup -ResourceGroupName <resourceGroup> -Name <actionGroup>).IdСоздайте шаблон Resource Manager для оповещения службы "Работоспособность ресурсов" в виде файла
resourcehealthalert.json(подробности см. ниже) и сохраните его:Создайте развертывание Azure Resource Manager с помощью этого шаблона:
New-AzResourceGroupDeployment -Name ExampleDeployment -ResourceGroupName <resourceGroup> -TemplateFile <path\to\resourcehealthalert.json>Вам будет предложено ввести имя оповещения и идентификатор ресурса группы действий, скопированные ранее:
Supply values for the following parameters: (Type !? for Help.) activityLogAlertName: <Alert Name> actionGroupResourceId: /subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/microsoft.insights/actionGroups/<actionGroup>Если все вышло, вы получите подтверждение в PowerShell:
DeploymentName : ExampleDeployment ResourceGroupName : <resourceGroup> ProvisioningState : Succeeded Timestamp : 11/8/2017 2:32:00 AM Mode : Incremental TemplateLink : Parameters : Name Type Value =============== ========= ========== activityLogAlertName String <Alert Name> activityLogAlertEnabled Bool True actionGroupResourceId String /... Outputs : DeploymentDebugLogLevel :
Обратите внимание, что если вы планируете полностью автоматизировать процесс, вам нужно просто изменить шаблон Resource Manager, чтобы он не выводил запрос на ввод значения на шаге 5.
Варианты шаблона Resource Manager для оповещений службы "Работоспособность ресурсов"
Этот базовый шаблон можно использовать в качестве отправной точки для создания оповещений службы "Работоспособность ресурсов". Он будет работать так, как написано. Вы подпишетесь на получение оповещений для всех только что активированных событий работоспособности ресурсов во всех ресурсах подписки.
В нижней части этой статьи мы также включили более сложный шаблон оповещения, который должен увеличить соотношение сигнала и помех для оповещений службы "Работоспособность ресурсов" по сравнению с этим шаблоном.
{
"$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"activityLogAlertName": {
"type": "string",
"metadata": {
"description": "Unique name (within the Resource Group) for the Activity log alert."
}
},
"actionGroupResourceId": {
"type": "string",
"metadata": {
"description": "Resource Id for the Action group."
}
}
},
"resources": [
{
"type": "Microsoft.Insights/activityLogAlerts",
"apiVersion": "2017-04-01",
"name": "[parameters('activityLogAlertName')]",
"location": "Global",
"properties": {
"enabled": true,
"scopes": [
"[subscription().id]"
],
"condition": {
"allOf": [
{
"field": "category",
"equals": "ResourceHealth"
},
{
"field": "status",
"equals": "Active"
}
]
},
"actions": {
"actionGroups":
[
{
"actionGroupId": "[parameters('actionGroupResourceId')]"
}
]
}
}
}
]
}
Тем не менее такое широкое оповещение обычно не рекомендуется использовать. В следующем разделе вы узнаете, как можно ограничить область этого оповещения и сосредоточиться на событиях, которые нас интересуют.
Корректировка области оповещения
Службу "Работоспособность ресурсов" можно настроить для мониторинга событий в трех различных областях:
- Уровень подписки
- уровень группы ресурсов;
- уровень ресурса.
Приведенный здесь шаблон оповещения настроен на уровне подписки, но если необходимо настроить оповещение только для определенных ресурсов или ресурсов в определенной группе ресурсов, нужно просто изменить раздел scopes в шаблоне выше.
Раздел с заданной областью на уровне группы ресурсов должен выглядеть так:
"scopes": [
"/subscriptions/<subscription id>/resourcegroups/<resource group>"
],
А раздел с заданной областью на уровне ресурса должен выглядеть так:
"scopes": [
"/subscriptions/<subscription id>/resourcegroups/<resource group>/providers/<resource>"
],
Пример: "/subscriptions/d37urb3e-ed41-4670-9c19-02a1d2808ff9/resourcegroups/myRG/providers/microsoft.compute/virtualmachines/myVm"
Чтобы получить эту строку, перейдите на портал Azure и посмотрите на URL-адрес в разделе ресурса Azure.
Корректировка типов ресурсов, о которых приходят оповещения
Оповещения на уровне подписки или группы ресурсов могут иметь различные типы ресурсов. Если вы хотите, чтобы оповещения поступали только из определенного подмножества типов ресурсов, это можно определить в разделе condition шаблона следующим образом:
"condition": {
"allOf": [
...,
{
"anyOf": [
{
"field": "resourceType",
"equals": "MICROSOFT.COMPUTE/VIRTUALMACHINES",
"containsAny": null
},
{
"field": "resourceType",
"equals": "MICROSOFT.STORAGE/STORAGEACCOUNTS",
"containsAny": null
},
...
]
}
]
},
Здесь мы используем оболочку anyOf, чтобы оповещение о работоспособности ресурса сопоставлялось с одним из указанных условий и отправлялись оповещения, предназначенные для определенных типов ресурсов.
Корректировка событий службы "Работоспособность ресурсов", о которых поступают оповещения
Когда в ресурсах происходит событие работоспособности, они могут проходить через ряд шагов, представляющих состояния событий работоспособности: Active, In Progress, Updated и Resolved.
Вам может требоваться уведомление только в том случае, если ресурс становится неработоспособным. В этом случае нужно настроить срабатывание оповещения, только когда status имеет значение Active. Однако, если вы хотите получать уведомления и на других этапах, эти сведения можно добавить следующим образом:
"condition": {
"allOf": [
...,
{
"anyOf": [
{
"field": "status",
"equals": "Active"
},
{
"field": "status",
"equals": "In Progress"
},
{
"field": "status",
"equals": "Resolved"
},
{
"field": "status",
"equals": "Updated"
}
]
}
]
}
Если необходимо получать уведомления для всех четырех этапов событий работоспособности, можно удалить это условие, и вы будете получать оповещение независимо от свойства status.
Примечание.
Каждый раздел anyOf должен содержать только одно значение типа поля.
Корректировка оповещений службы "Работоспособность ресурсов" во избежание событий Unknown (Неизвестно)
Служба "Работоспособность ресурсов" может сообщить последние сведения о работоспособности ресурсов, постоянно отслеживая их с помощью тестовых запусков. Соответствующие состояния работоспособности: Available (Доступно), Unavailable (Недоступно) и Degraded (Пониженная функциональность). Однако, в ситуациях, когда запускатель и ресурс Azure не могут обмениваться данными, для ресурса сообщается состояние работоспособности Unknown (Неизвестно), и это считается активным событием работоспособности.
Тем не менее когда ресурс сообщает о состоянии Unknown (Неизвестно), вполне вероятно, что состояние работоспособности не изменилось с момента последнего точного отчета. Если вы хотите исключить оповещения о событиях Unknown (Неизвестно), можно указать эту логику в шаблоне:
"condition": {
"allOf": [
...,
{
"anyOf": [
{
"field": "properties.currentHealthStatus",
"equals": "Available",
"containsAny": null
},
{
"field": "properties.currentHealthStatus",
"equals": "Unavailable",
"containsAny": null
},
{
"field": "properties.currentHealthStatus",
"equals": "Degraded",
"containsAny": null
}
]
},
{
"anyOf": [
{
"field": "properties.previousHealthStatus",
"equals": "Available",
"containsAny": null
},
{
"field": "properties.previousHealthStatus",
"equals": "Unavailable",
"containsAny": null
},
{
"field": "properties.previousHealthStatus",
"equals": "Degraded",
"containsAny": null
}
]
},
]
},
В этом примере мы уведомляем только о событиях, у которых текущее и будущее состояния работоспособности не соответствуют состоянию Unknown (Неизвестно). Это изменение может быть полезным дополнением, если оповещения отправляются непосредственно на мобильный телефон или на электронную почту.
Обратите внимание, что в некоторых событиях свойства currentHealthStatus и previousHealthStatus могут иметь значение null. Например, при возникновении обновленного события вполне вероятно, что состояние работоспособности ресурса не изменилось с момента последнего отчета и доступны только дополнительные сведения о событии (например, причина). Поэтому использование предложения выше может привести к тому, что некоторые предупреждения не будут активированы, так как свойства properties.currentHealthStatus и properties.previousHealthStatus будут иметь значение null.
Корректировка оповещения, чтобы избежать событий, инициированных пользователем
События службы "Работоспособность ресурсов" могут вызываться инициированной платформой и событиями, инициированными пользователем. Оповещение имеет смысл отправлять только тогда, когда событие работоспособности вызвано платформой Azure.
Для оповещения можно легко настроить фильтрацию событий только этих типов:
"condition": {
"allOf": [
...,
{
"field": "properties.cause",
"equals": "PlatformInitiated",
"containsAny": null
}
]
}
Обратите внимание, что в некоторых событиях поле "Причина" может иметь значение null. Это значит, что происходит переход состояния работоспособности (например, из доступного в недоступный) и событие немедленно заносится в журнал, чтобы предотвратить задержки в уведомлениях. Поэтому использование приведенного выше предложения может привести к тому, что предупреждение не будет активировано, так как свойство properties.clause имеет значение NULL.
Полный шаблон оповещений для службы "Работоспособность ресурсов"
С использованием различных корректировок, описанных в предыдущем разделе, имеется шаблон выборки, настроенный для обеспечения максимального соотношения сигнала и помех. Имейте в виду, что в некоторых событиях свойства currentHealthStatus, previousHealthStatusс, а также свойства причины могут иметь значение null.
{
"$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
"contentVersion": "1.0.0.0",
"parameters": {
"activityLogAlertName": {
"type": "string",
"metadata": {
"description": "Unique name (within the Resource Group) for the Activity log alert."
}
},
"actionGroupResourceId": {
"type": "string",
"metadata": {
"description": "Resource Id for the Action group."
}
}
},
"resources": [
{
"type": "Microsoft.Insights/activityLogAlerts",
"apiVersion": "2017-04-01",
"name": "[parameters('activityLogAlertName')]",
"location": "Global",
"properties": {
"enabled": true,
"scopes": [
"[subscription().id]"
],
"condition": {
"allOf": [
{
"field": "category",
"equals": "ResourceHealth",
"containsAny": null
},
{
"anyOf": [
{
"field": "properties.currentHealthStatus",
"equals": "Available",
"containsAny": null
},
{
"field": "properties.currentHealthStatus",
"equals": "Unavailable",
"containsAny": null
},
{
"field": "properties.currentHealthStatus",
"equals": "Degraded",
"containsAny": null
}
]
},
{
"anyOf": [
{
"field": "properties.previousHealthStatus",
"equals": "Available",
"containsAny": null
},
{
"field": "properties.previousHealthStatus",
"equals": "Unavailable",
"containsAny": null
},
{
"field": "properties.previousHealthStatus",
"equals": "Degraded",
"containsAny": null
}
]
},
{
"anyOf": [
{
"field": "properties.cause",
"equals": "PlatformInitiated",
"containsAny": null
}
]
},
{
"anyOf": [
{
"field": "status",
"equals": "Active",
"containsAny": null
},
{
"field": "status",
"equals": "Resolved",
"containsAny": null
},
{
"field": "status",
"equals": "In Progress",
"containsAny": null
},
{
"field": "status",
"equals": "Updated",
"containsAny": null
}
]
}
]
},
"actions": {
"actionGroups": [
{
"actionGroupId": "[parameters('actionGroupResourceId')]"
}
]
}
}
}
]
}
Тем не менее вам лучше знать, какие конфигурации эффективны для вас, поэтому используйте инструменты, приведенные в этой документации, чтобы настроить свою собственную конфигурацию.
Следующие шаги
Дополнительная информация о службе "Работоспособность ресурсов".
- Обзор службы "Работоспособность ресурсов Azure"
- Типы ресурсов и проверок работоспособности, доступные в службе "Работоспособность ресурсов Azure"
Создание оповещений службы "Работоспособность служб":