如何使用Python代码获取Azure Redis的监控指标值

问题描述

通过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

  • 如何用Python获取AzureRedis监控数据

    在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 requestsimport json##Part 1: Get Access Tokenaadurl="
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 Tokenheaders = {'
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

执行效果如下:



Azure Redis是微软提供的云缓存服务,为了保证其高效运行,我们需要对其运行状态进行监控和调优。本文将介绍如何使用Python代码获取Azure Redis的监控指标值。
1. 安装Azure SDK和redis-py
在使用Python代码获取Azure Redis的监控指标值之前,我们需要安装Azure SDK和redis-py。可以使用pip安装:
```
pip install azure
pip install redis
```
2. 配置Azure认证信息
在开始获取Azure Redis的监控指标值之前,我们需要配置Azure认证信息。可以通过Azure门户获取Azure服务的连接字符串。具体步骤如下:
- 登录Azure门户。
- 打开Azure Cache for Redis实例。
- 在“设置”中,点击“访问密钥”。
- 复制“主连接字符串”。
将这个连接字符串保存在代码中,以便后续使用。
3. 连接Redis实例
在获取Azure Redis的监控指标值之前,我们需要连接到Redis实例。可以使用redis-py库来连接:
```
import redis
cache = redis.StrictRedis(host='.redis.cache.windows.net',
port=6380,
password='',
ssl=True)
```
需要替换host和password参数中的内容为你实际的Redis地址及访问密钥。
4. 获取监控指标列表
现在我们已经连接到了Azure Redis实例,我们需要获取可用的监控指标列表。可以使用Azure SDK来获取这些指标:
```
from azure.mgmt.monitor import MonitorManagementClient
from azure.common.credentials import ServicePrincipalCredentials
subscription_id = ''
credentials = ServicePrincipalCredentials(
client_id='',
secret='',
tenant=''
)
monitor_client = MonitorManagementClient(
credentials,
subscription_id
)
namespaces = monitor_client.metric_definitions.list(resource_group_name='', resource_name='', resource_type='Microsoft.Cache/Redis')
for ns in namespaces:
print(ns.name.value)
```
需要替换subscription_id,client_id,secret,tenant,resource_group和redis_name参数中的内容为你实际的订阅、应用程序ID、秘密、租户、资源组和Redis名称。
5. 查询指标数据
现在我们已经获得了可用的监控指标列表,我们需要查询这些指标的实际数据。可以使用Azure SDK和redis-py来查询这些数据:
```
from azure.mgmt.monitor.models import *
import datetime
endtime = datetime.datetime.utcnow()
starttime = endtime - datetime.timedelta(minutes=15)
interval = datetime.timedelta(minutes=1)
metricnames = ['connectedclients', 'get', 'set']
metriclist = []
for metricname in metricnames:
metric = Metric(
namespace='Microsoft.Cache/Redis',
name=metricname,
dimensions={'ResourceGroupName': '', 'Name': ''},
aggregation=AggregationType.average,
start_time=starttime,
end_time=endtime,
time_grain=interval)
metriclist.append(metric)
metricsdata = monitor_client.metrics.list(resource_group_name='', resource_name='', filter=QueryFilter(metricnames=metriclist))
for item in metricsdata.value:
data = cache.get(item.name.value)
print(item.name.value, data)
```
需要替换metricnames、resource_group和redis_name参数中的内容为你实际的指标名称、资源组和Redis名称。
6. 可视化数据
我们已经成功获取了Azure Redis的监控指标数据,现在可以考虑将这些数据进行可视化。可以使用matplotlib和numpy库来可视化数据:
```
import matplotlib.pyplot as plt
import numpy as np
for item in metricsdata.value:
data = cache.get(item.name.value)
values = []
times = []
for metricvalue in item.timeseries[0].data:
values.append(metricvalue.average)
times.append(metricvalue.time_stamp)
x = np.array(times)
y = np.array(values)
plt.plot(x, y, label=item.name.value)
plt.legend()
plt.show()
```
7. 结论
本文介绍了如何使用Python代码获取Azure Redis缓存的监控指标数据。通过这些指标数据,我们可以了解Redis实例的运行状态,进一步优化其性能和稳定性。希望这篇文章对Azure Redis用户有所帮助。