【Azure Redis 缓存】使用Python代码获取Azure Redis的监控指标值 (含Powershell脚本方式)

问题描述

通过Metrics监控页面，我们能得知当前资源(如Redis)的运行情况与各种指标。如果我们需要把指标下载到本地或者生成JSON数据导入到第三方的监控平台呢？Azure是否可以通过Python代码或者时Powershell脚本导出各种指标数据呢？

解决办法

可以！ PowerShell命令可以使用Get-AzMetric 或者是 az monitor metrics list命令来获取资源的Metrics值。

Get-AzMetric：Gets the metric values of a resource. https://docs.microsoft.com/en-us/powershell/module/az.monitor/get-azmetric?view=azps-5.4.0&viewFallbackFrom=azps-5.2.0
az monitor metrics list: List the metric values for a resource. https://docs.microsoft.com/en-us/cli/azure/monitor/metrics?view=azure-cli-latest#az_monitor_metrics_list

而使用Python代码，可以使用Metrics的REST API来实现

Metrics - List：Lists the metric values for a resource. https://docs.microsoft.com/en-us/rest/api/monitor/metrics/list
在AAD中注册应用获取在Python代码中访问Redis Metrics的Access Token: (将应用程序注册到 Microsoft 标识平台: https://docs.azure.cn/zh-cn/active-directory/develop/quickstart-register-app)

注：使用Powershell必须先登录到Azure。使用命令 Connect-AzAccount -Environment AzureChinaCloud 或 az cloud set --name AzureChinaCloud 和 az login。

使用Python代码则需要先获取到访问Redis Metrics的Token。获取Token可以在Azure AD中注册一个应用，然后给该应用在Redis的访问控制中赋予reader的权限即可读取Metris数据。

执行步骤

Python

步骤一：注册AAD应用，复制应用ID，客户端访问密码

登录Azure平台，进入AAD页面，点击App registrations： https://portal.azure.cn/?l=en.en-us#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps
点击“New Registration” 按钮，输入应用名称，其他值保留默认，点击保存
创建成功后，进入应用页面，导入到“Certificates & secrets”页面，创建需要使用的Client Secret并复制出来，第三步需要使用
在应用页面复制出Tenant ID, Applicaiton ID需要在第三步代码中使用

具体操作过程见如下动图：

步骤二：赋予获取Metrics的权限

在Redis的Access control (IAM)页面中，通过步骤一的应用名搜索并赋予Monitoring Reader权限

注：如没有赋予权限，则代码中会报出类似错误：

Status Code: <Response [403]>
Response Content: b'{"error":{"code":"AuthorizationFailed","message":"The client \'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\' with object id \'xxxxxxxx-xxxx-xxxx-xxxx-36166b5f7276\' does not have authorization to perform action \'microsoft.insights/metrics/read\' over scope \'/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/xxxx-rg/providers/Microsoft.Cache/Redis/xxxx/providers/microsoft.insights\' or the scope is invalid. If access was recently granted, please refresh your credentials."}}'

步骤三：编写Python代码，使用requests来发送psot，get请求

代码中主要有两部分内容：一是获取Access Token，二是获取Metrics Data
高亮中的内容都是需要替换成相应的资源信息和第一步中准备的信息
在获取Access Token的Body内容中，grant_type是固定值，为client_credentials。resource的值为中国区azure的管理终结点：https://management.chinacloudapi.cn

import requests

import json

##Part 1: Get Access Token

aadurl="https://login.chinacloudapi.cn/<your aad tenant id>/oauth2/token"

aadbody={

    'grant_type':'client_credentials',

    'client_id':'your aad client id',

    'client_secret':'your aad client secret',

    'resource':'https://management.chinacloudapi.cn'

}

rtoken= requests.post(aadurl, data=aadbody)

##print(rtoken)

objtoken = json.loads(rtoken.text)

##print(obj['access_token'])

##Part 2: Get the Metrics Value by Token

headers = {'content-type': "application/json",

           'Authorization': 'Bearer '+objtoken['access_token']

        }

url= "https://management.chinacloudapi.cn/subscriptions/<subscriptions>/resourceGroups/<resourceGroups>/providers/Microsoft.Cache/Redis/<your redis name>/providers/microsoft.insights/metrics?api-version=2018-01-01&metricnames=expiredkeys,usedmemory"

r = requests.get(url, headers=headers)

print('Status Code: ' + str(r))

print('Response Content: ' + str(r.content))

运行效果如：

Powershell

登录azure
准备az monitor metrics list命令

az cloud set --name AzureChinaCloud

az login

az monitor metrics list --resource /subscriptions/<your subscriptions>/resourceGroups/<resourceGroups>/providers/Microsoft.Cache/Redis/<your redis name> --metric usedmemory --aggregation Maximum --interval PT1M

执行效果如下：

参考资料

将应用程序注册到 Microsoft 标识平台：https://docs.azure.cn/zh-cn/active-directory/develop/quickstart-register-app

REST API Metrics - List: https://docs.microsoft.com/en-us/rest/api/monitor/metrics/list

Get-AzMetric: https://docs.microsoft.com/en-us/powershell/module/az.monitor/get-azmetric?view=azps-5.4.0&viewFallbackFrom=azps-5.2.0

az monitor metrics list: https://docs.microsoft.com/en-us/cli/azure/monitor/metrics?view=azure-cli-latest#az_monitor_metrics_list