IoT Edge deployment custom metrics, what is the full syntax?

Matthijs van der Veer 4,376 MVP

I'm building some custom metrics for an Azure IoT Edge deployment, and I couldn't find a full description of the syntax. This document says:

"Add or modify custom metrics, using the example syntax as a guide."

Do those examples represent an exhaustive list of operations that I can use in the custom metrics, or are there other functions I could use? Specifically, I'm looking for more operations to go through the individual 'Connected' status of all the clients in the reported properties of my edgeHub module.

QuantumCache 20,346 Reputation points

2021-01-19T22:01:46.297+00:00

Hello @Matthijs van der Veer thanks for your query. I think you are looking for a full/partial list of query operation examples, right ?
Matthijs van der Veer 4,376 Reputation points MVP

2021-01-20T08:18:43.177+00:00

Hey Satish, indeed it would be great to have a full list of allowed operations instead of the few examples available in the portal. These are the examples I found when adding a metric to an existing deployment:

The syntax is similar yet different from IoT Hub queries, but it's not clear to me what's possible and impossible in this field. I keep experimenting and checking if the validation throws an error 😁 For instance, you can use the configurations part of the module twin in these queries, but not other properties like connectionState
QuantumCache 20,346 Reputation points

2021-01-26T07:53:26.697+00:00

Hello @Matthijs van der Veer , Sure this is great feedback to have a document on these customer metrics. Let me check with my team on this.

Accepted answer

QuantumCache 20,346 Reputation points

2021-02-24T19:30:56.923+00:00

Hello @Matthijs van der Veer , below is the response from the team.

Custom metrics queries can be on deviceId, moduleid, tags, properties.desired, properties.reported and configurations. Device Registry properties like connectionState, deviceState, auth mechanism are not supported at this moment.

Microsoft's team is also working on adding some instructions to the document in the upcoming days. You can visit the document in future or leave a comment below to this thread to check back with us.
Please sign in to rate this answer.
Matthijs van der Veer 4,376 Reputation points MVP

2021-02-25T07:22:11.017+00:00

Thanks, @QuantumCache for the info!
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

IoT Edge deployment custom metrics, what is the full syntax?

0 additional answers

Your answer