From aa71c88be6b04d0df576340245b77577624e0777 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20=C3=96hlund?= Date: Mon, 25 Nov 2024 08:31:30 +0100 Subject: [PATCH] Link to ASB metrics permission needed (#6904) * Link to ASB metrics permission needed * Update azure-service-bus.md --- nservicebus/throughput-tool/azure-service-bus.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/nservicebus/throughput-tool/azure-service-bus.md b/nservicebus/throughput-tool/azure-service-bus.md index f8350136370..ce23232afc1 100644 --- a/nservicebus/throughput-tool/azure-service-bus.md +++ b/nservicebus/throughput-tool/azure-service-bus.md @@ -15,7 +15,7 @@ This article details how to collect endpoint and throughput data when the system Collecting metrics from Azure Service Bus relies upon an existing set of Azure credentials set using the Azure Command Line Interface (CLI), which must be installed first: 1. Install the [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli). -2. From a command line, execute `az login`, which will open a browser to complete the authentication to Azure. The Azure login must have access to view metrics data for the Azure Service Bus namespace. +2. From a command line, execute `az login`, which will open a browser to complete the authentication to Azure. The built-in role [Monitoring Reader](https://learn.microsoft.com/en-us/azure/azure-monitor/roles-permissions-security#monitoring-reader) is sufficient to access the required Azure Service Bus metrics. 3. Execute `az account set --subscription {SubscriptionId}`, where `{SubscriptionId}` is a Guid matching the subscription id that contains the Azure Service Bus namespace. Completing these steps stores credentials that can be used by the tool. @@ -55,6 +55,6 @@ include: throughput-tool-global-options ## What the tool does -First, the tool uses a `ServiceBusAdministrationClient` to [query the queue names](https://learn.microsoft.com/en-us/dotnet/api/azure.messaging.servicebus.administration.servicebusadministrationclient.getqueueasync?view=azure-dotnet) from the namespace. Next, a `MetricsQueryClient` is used to [query for `CompleteMessage` metrics](https://learn.microsoft.com/en-us/dotnet/api/azure.monitor.query.metricsqueryclient.queryresourceasync?view=azure-dotnet) for the past 30 days from each queue. +First, the tool uses a `ServiceBusAdministrationClient` to [query the queue names](https://learn.microsoft.com/en-us/dotnet/api/azure.messaging.servicebus.administration.servicebusadministrationclient.getqueuesasync?view=azure-dotnet) from the namespace. Next, a `MetricsQueryClient` is used to [query for `CompleteMessage` metrics](https://learn.microsoft.com/en-us/dotnet/api/azure.monitor.query.metricsqueryclient.queryresourceasync?view=azure-dotnet) for the past 30 days from each queue. -Using Azure Service Bus metrics allows the tool to capture the last 30 days worth of data at once. Although the tool collects 30 days worth of data, only the highest daily throughput is included in the report. \ No newline at end of file +Using Azure Service Bus metrics allows the tool to capture the last 30 days worth of data at once. Although the tool collects 30 days worth of data, only the highest daily throughput is included in the report.