MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.21k stars 21.35k forks source link

SuccessfulPullCount & TotalPullCount Metrics Reflecting Confusing Values #117037

Closed bdegs closed 3 months ago

bdegs commented 10 months ago

Hello,

Based on this doc (https://learn.microsoft.com/en-us/azure/container-registry/monitor-service-reference#container-registry-metrics) these are the explanations on both metric values listed in the title:

SuccessfulPullCount - Successful pulls of container images and other artifacts from the registry

TotalPullCount - Total pulls of container images and other artifacts from the registry

Based on the above if I were to have a failed pull the way I understand this there should be a disparity between these two values (e.g., If TotalPullCount were 15, but we had 14 SuccessfulPullCount it should reflect both of those respectively). Instead, it will show both as 15 even if one resulted in failure effectively making these two metrics redundant in nature.

I'm requesting an update to the documentation to better represent that these metrics will be the same value, or perhaps we could also introduce a customer facing 'FailedPullCount' metric which will reflect the failed pulls and make the metric behave as advertised in the docs. (e.g., TotalPullCount = 15, SuccessfulPullCount would register as 14 and we would see 1 FailedPullCount).


Document Details

Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

ManoharLakkoju-MSFT commented 10 months ago

@bdegs Thanks for your feedback! We will investigate and update as appropriate.

AjayBathini-MSFT commented 10 months ago

@bdegs Thanks for your feedback! I've assigned this issue to the author who will investigate and update as appropriate.

northtyphoon commented 3 months ago

TotalPullCount counts the total get requests to registry v2 manifest api. SuccessfulPullCount counts the total get requests to registry v2 manifest api with 200 response.

When you run "docker pull", the client might need to do authentication first. If it failed at the authentication stage, it would not be counted in either TotalPullCount or SuccessfulPullCount.

tejaswikolli-web commented 3 months ago

https://github.com/MicrosoftDocs/azure-docs-pr/pull/276485

tejaswikolli-web commented 3 months ago

please-close