Need to find the queue length and activities running in self hosted IR in Azure ADF

Question

Need to find the queue length and activities running in self hosted IR in Azure ADF

Pavan Kumar Chakilam 126

Hi,

I need powershell script or any other way to find out the queue length and queue details of SHIR. Please help.

User's image

Amira Bedhiafi 33,631 Volunteer Moderator

If you are familiar with KQL here is a good resource : https://datasavvy.me/2022/01/06/looking-at-activity-queue-times-from-azure-data-factory-with-log-analytics/

https://www.pythian.com/blog/monitoring-azure-data-factory-self-hosted-ir-and-pipelines

Otherwise, you can use the following code after connecting to your AZ Connect-AzAccount command :

$resourceGroupName = "YOUR_RESOURCE_GROUP_NAME"
$dataFactoryName = "YOUR_DATA_FACTORY_NAME"
$integrationRuntimeName = "YOUR_INTEGRATION_RUNTIME_NAME"

# Get the status of the Self-hosted Integration Runtime
$shirStatus = Get-AzDataFactoryV2IntegrationRuntime -ResourceGroupName $resourceGroupName -DataFactoryName $dataFactoryName -Name $integrationRuntimeName -Status

$queueLength = $shirStatus.NodeStatus.FirstOrDefault().QueueLength
$runningActivities = $shirStatus.NodeStatus.FirstOrDefault().RunningActivities

Write-Output "Queue Length: $queueLength"
Write-Output "Running Activities: $runningActivities"

https://learn.microsoft.com/en-us/powershell/module/az.datafactory/get-azdatafactoryv2integrationruntime?view=azps-10.4.1

Pavan Kumar Chakilam 126

when i tried to execute the command, got this issue.

You cannot call a method on a null-valued expression.
At C:\Users\test\Documents\queuelength.ps1:17 char:1
+ $queueLength = $shirStatus.NodeStatus.FirstOrDefault().QueueLength
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [], RuntimeException
    + FullyQualifiedErrorId : InvokeMethodOnNull

You cannot call a method on a null-valued expression.
At C:\Users\test\Documents\queuelength.ps1:18 char:1
+ $runningActivities = $shirStatus.NodeStatus.FirstOrDefault().RunningA ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [], RuntimeException
    + FullyQualifiedErrorId : InvokeMethodOnNull

Status: Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedIntegrationRuntimeStatus
Queue Length:
Running Activities:

Pavan Kumar Chakilam 126

You cannot call a method on a null-valued expression.
At C:\Users\test\Documents\queuelength.ps1:17 char:1
+ $queueLength = $shirStatus.NodeStatus.FirstOrDefault().QueueLength
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [], RuntimeException
    + FullyQualifiedErrorId : InvokeMethodOnNull

You cannot call a method on a null-valued expression.
At C:\Users\test\Documents\queuelength.ps1:18 char:1
+ $runningActivities = $shirStatus.NodeStatus.FirstOrDefault().RunningA ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [], RuntimeException
    + FullyQualifiedErrorId : InvokeMethodOnNull

Status: Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedIntegrationRuntimeStatus
Queue Length:
Running Activities:

Amira Bedhiafi 33,631 Volunteer Moderator

The integration runtime may not be returning the expected details, or it might be in a state where node details are not available.

Can you try the following ? Otherwise can you share the expected output ? I am a little bit confused.

If you have access to Azure Log Analytics PowerShell Module you can consider it as a solution.

$resourceGroupName = "YOUR_RESOURCE_GROUP_NAME"
$dataFactoryName = "YOUR_DATA_FACTORY_NAME"
$integrationRuntimeName = "YOUR_INTEGRATION_RUNTIME_NAME"

# Get the status of the Self-hosted Integration Runtime
$shirStatus = Get-AzDataFactoryV2IntegrationRuntime -ResourceGroupName $resourceGroupName -DataFactoryName $dataFactoryName -Name $integrationRuntimeName -Status

if ($shirStatus.NodeStatus -ne $null -and $shirStatus.NodeStatus.Count -gt 0) {
    $queueLength = $shirStatus.NodeStatus[0].QueueLength
    $runningActivities = $shirStatus.NodeStatus[0].RunningActivities

    Write-Output "Queue Length: $queueLength"
    Write-Output "Running Activities: $runningActivities"
} else {
    Write-Output "Unable to fetch NodeStatus for the given Integration Runtime."
}

1 answer

Your answer

Amira Bedhiafi 33,631 Reputation points Volunteer Moderator

2023-10-24T11:36:27.7866667+00:00

If you are familiar with KQL here is a good resource : https://datasavvy.me/2022/01/06/looking-at-activity-queue-times-from-azure-data-factory-with-log-analytics/

https://www.pythian.com/blog/monitoring-azure-data-factory-self-hosted-ir-and-pipelines

Otherwise, you can use the following code after connecting to your AZ Connect-AzAccount command :

$resourceGroupName = "YOUR_RESOURCE_GROUP_NAME" $dataFactoryName = "YOUR_DATA_FACTORY_NAME" $integrationRuntimeName = "YOUR_INTEGRATION_RUNTIME_NAME" # Get the status of the Self-hosted Integration Runtime $shirStatus = Get-AzDataFactoryV2IntegrationRuntime -ResourceGroupName $resourceGroupName -DataFactoryName $dataFactoryName -Name $integrationRuntimeName -Status $queueLength = $shirStatus.NodeStatus.FirstOrDefault().QueueLength $runningActivities = $shirStatus.NodeStatus.FirstOrDefault().RunningActivities Write-Output "Queue Length: $queueLength" Write-Output "Running Activities: $runningActivities"

https://learn.microsoft.com/en-us/powershell/module/az.datafactory/get-azdatafactoryv2integrationruntime?view=azps-10.4.1
Pavan Kumar Chakilam 126 Reputation points

2023-10-24T21:59:21.62+00:00

when i tried to execute the command, got this issue.

You cannot call a method on a null-valued expression. At C:\Users\test\Documents\queuelength.ps1:17 char:1 + $queueLength = $shirStatus.NodeStatus.FirstOrDefault().QueueLength + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidOperation: (:) [], RuntimeException + FullyQualifiedErrorId : InvokeMethodOnNull You cannot call a method on a null-valued expression. At C:\Users\test\Documents\queuelength.ps1:18 char:1 + $runningActivities = $shirStatus.NodeStatus.FirstOrDefault().RunningA ... + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidOperation: (:) [], RuntimeException + FullyQualifiedErrorId : InvokeMethodOnNull Status: Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedIntegrationRuntimeStatus Queue Length: Running Activities:
Pavan Kumar Chakilam 126 Reputation points

2023-10-24T22:00:31.7133333+00:00

You cannot call a method on a null-valued expression. At C:\Users\test\Documents\queuelength.ps1:17 char:1 + $queueLength = $shirStatus.NodeStatus.FirstOrDefault().QueueLength + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidOperation: (:) [], RuntimeException + FullyQualifiedErrorId : InvokeMethodOnNull You cannot call a method on a null-valued expression. At C:\Users\test\Documents\queuelength.ps1:18 char:1 + $runningActivities = $shirStatus.NodeStatus.FirstOrDefault().RunningA ... + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidOperation: (:) [], RuntimeException + FullyQualifiedErrorId : InvokeMethodOnNull Status: Microsoft.Azure.Commands.DataFactoryV2.Models.PSLinkedIntegrationRuntimeStatus Queue Length: Running Activities:
Amira Bedhiafi 33,631 Reputation points Volunteer Moderator

2023-10-25T12:28:40.33+00:00

The integration runtime may not be returning the expected details, or it might be in a state where node details are not available.

Can you try the following ? Otherwise can you share the expected output ? I am a little bit confused.

If you have access to Azure Log Analytics PowerShell Module you can consider it as a solution.

$resourceGroupName = "YOUR_RESOURCE_GROUP_NAME" $dataFactoryName = "YOUR_DATA_FACTORY_NAME" $integrationRuntimeName = "YOUR_INTEGRATION_RUNTIME_NAME" # Get the status of the Self-hosted Integration Runtime $shirStatus = Get-AzDataFactoryV2IntegrationRuntime -ResourceGroupName $resourceGroupName -DataFactoryName $dataFactoryName -Name $integrationRuntimeName -Status if ($shirStatus.NodeStatus -ne $null -and $shirStatus.NodeStatus.Count -gt 0) { $queueLength = $shirStatus.NodeStatus[0].QueueLength $runningActivities = $shirStatus.NodeStatus[0].RunningActivities Write-Output "Queue Length: $queueLength" Write-Output "Running Activities: $runningActivities" } else { Write-Output "Unable to fetch NodeStatus for the given Integration Runtime." }

Answer 1

PRADEEPCHEEKATLA 90,651 Moderator

@Pavan Kumar Chakilam - Thanks for the question and using MS Q&A platform.

Answer provided by Amira Bedhiafi doesn't gives you the integration runtime monitoring data using powershell. User's image

Get-AzDataFactoryV2IntegrationRuntime cmdlet does not provide the queue length of a self-hosted integration runtime (SHIR) in Azure Data Factory (ADF). Here is the output of the cmdlet which doesn't provide details about the queue length.

To get the queue length and queue details of a SHIR, you can use the Azure Management REST API. Here's an example REST API that you can use:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData?api-version=2018-06-01

Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.

User's image

For more details, refer to Integration Runtimes - Get Monitoring Data.

Hope this helps. Do let us know if you any further queries.

If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.

Pavan Kumar Chakilam 126 Reputation points

2023-10-25T13:18:57.9466667+00:00
Thanks for your response. I got the error when i run the API with sub id and datafactory name and resource group name and integration run time name

not only the queue length, i need to know what are running in that queue.

{"error":{"code":"AuthenticationFailed","message":"Authentication failed. The 'Authorization' header is missing."}}

Amira Bedhiafi 33,631 Volunteer Moderator

You need to have a valid access token set in the Authorization header.

use the Azure CLI to obtain the access token :

az account get-access-token

Then use this token in your API call by setting it in the Authorization header:

curl -X GET "https://management.azure.com/subscriptions/YOUR_SUBSCRIPTION_ID/resourceGroups/YOUR_RESOURCE_GROUP/providers/Microsoft.DataFactory/factories/YOUR_DATAFACTORY_NAME/integrationRuntimes/YOUR_RUNTIME_NAME/monitoringData?api-version=2018-06-01" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Pavan Kumar Chakilam 126 Reputation points

2023-10-25T18:31:28.11+00:00

i got the token and added to the API call header, nothing is returning
PRADEEPCHEEKATLA 90,651 Reputation points Moderator

2023-10-26T06:52:06.3466667+00:00

@Pavan Kumar Chakilam - You may checkout the REST API metioned in this document: https://learn.microsoft.com/en-us/rest/api/datafactory/integration-runtimes/get-monitoring-data?tabs=HTTP

Step1: Click on Try It and Sign-in with your account.

Step2: In case, if you have multiple Azure Tenants, choose the right one which has the ADF created.

Step3: Enter the below details: ADFName, IRName, ResourceGroupName, SubscriptionID.

Step4: Click on Run

Hope this helps. Do let us know if you any further queries.
Pavan Kumar Chakilam 126 Reputation points

2023-10-26T16:35:26.9733333+00:00

see below now 100 jobs are running. find out what are those jobs
Chakilam, Pavan 0 Reputation points

2023-10-26T17:02:49.3733333+00:00

thanks for pointing out the right direction to see the execution of API. Able to see the response from API now. But my other request is how to find the activities list which are under that queue?
Chakilam, Pavan 0 Reputation points

2023-10-27T21:26:46.3466667+00:00

any update on the request to find the running queue activities or pipelines?
Amira Bedhiafi 33,631 Reputation points Volunteer Moderator

2023-10-28T19:09:47.8266667+00:00

Please validate the current answer and then create another question.
PRADEEPCHEEKATLA 90,651 Reputation points Moderator

2023-10-30T10:59:17.2466667+00:00

@Pavan Kumar Chakilam - Glad to know you are able to run the Rest API. If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.

For the new question: The scope of your question is different compared to the original scope of the question asked.

I would recommend creating a new thread on the same forum with as much details about your issue as possible. That would make sure that your issue has better visibility in the community.
Chakilam, Pavan 0 Reputation points

2023-10-30T16:44:54.6233333+00:00

@PRADEEPCHEEKATLA my question on this thread is "Need to find the queue length and activities running in self hosted IR in Azure ADF". i got only partial answer to get the queue count, but need queue details as well as requested in the question.
Chakilam, Pavan 0 Reputation points

2023-11-01T14:33:17.51+00:00

any update on the task how to find the queue details which are running?

Share via

Need to find the queue length and activities running in self hosted IR in Azure ADF

1 answer

Your answer