Azure / azure-service-bus

☁️ Azure Service Bus service issue tracking and samples
https://azure.microsoft.com/services/service-bus
MIT License
586 stars 776 forks source link

Dimension name case toggles b/w title case & lower case in List metrics API response (as "EntityName" or "entityname") #650

Open vinay-kalappa-swi opened 1 year ago

vinay-kalappa-swi commented 1 year ago

Description

When we try to get metrics of service bus instance using client.List(...) API (as mentioned in sample programs at - https://learn.microsoft.com/en-us/rest/api/monitor/metrics/list?tabs=Go#code-try-0, sometimes response will contain dimension name as "EntityName" & in other times as "entityname".

Actual Behavior

  1. Few runs will return; ... "metadatavalues":[ { "name":{ "value":"EntityName", "localizedValue":"EntityName" }, "value":"" } ] ...

  2. Few will return; ... "metadatavalues":[ { "name":{ "value":"entityname", "localizedValue":"entityname" }, "value":"" } ] ...

Expected Behavior

  1. Response should contain either "EntityName" or "entityname", but not both. Response with both scenario for same set of parameters attached herewith; DimensionNameMismatch_JSON_SuccessfulRequestsMetric_git.txt
EldertGrootenboer commented 1 year ago

As these dimensions can come from various sources, this is to be expected. We advice to treat these in a case insensitive way. If there is a specific scenario where this is causing issues, please let us know, and we can look into re-opening this issue.

vinay-kalappa-swi commented 1 year ago

Azure documentation does state that they have support for Open telemetry exporter. Open telemetry standards are case-sensitive. So, if dimension names are in different cases, services will treat them as different dimensions irrespective of what human cognizance would infer!

At least, if the Azure documentation is specifying somewhere that they are case-insensitive when it comes to data that is exported, I can show that document to our customers & let them know that is how things are when it comes to Azure & cannot expect same standards as other XYZ cloud providers!

vinay-kalappa-swi commented 1 year ago

Btw, did anyone in Azure team try to plot a graph of metrics with case-insensitive dimension names to understand what is being explained in these issues (I have a support request also)? If not, it would be worth the time & effort, just to understand the impact (Azure is expecting client programs to scan entire time series data & modify each case-insensitive string!).

EldertGrootenboer commented 1 year ago

Thank you for your feedback, we are re-opening this and putting it on the backlog as an investigation task. We will come back on this issue once we have more information.

EldertGrootenboer commented 11 months ago

Thank you for your feedback on this item, it helps us in our efforts to continuously prioritize the different requests we get from all our various feedback channels. We have added this feature in our backlog, however we currently don't have an ETA on when development might start on this. For now, to help us give this the right priority, it would be helpful to see others vote and support this feature, as well as explain their scenarios.

EldertGrootenboer commented 5 months ago

This item in our backlog, however we currently don't have an ETA on when development might start on this. For now, to help us give this the right priority, it would be helpful to see others vote and support this item.