Project Egress metrics

[Nopzen]

Hi Harbor Community 👋

I'm currently looking a bit into metrics on Harbor for understanding the pr. project usage of data being send from Harbor to any remote destinations. I found these metrics on the website:

• harbor_artifact_pulled
• harbor_project_quota_byte
• harbor_project_quota_usage_byte

And I was wondering if there are a way that we are able to capture how many bytes are leaving Harbor on a labeled on a pr. project basis, so that I'm able to look at high use projects to find better ways for these projects to not generating high amount of GB potentially PB of egress daily, things such as spegel / dragonfly for caching of images for these high pull projects?

[wy65701436]

hi @Nopzen can you provide a user-case for me to better understand your question? I suppose that you need to check the network traffic in the gateway side rather than the app level.

[Nopzen]

Hi @wy65701436

We are already tracking egress at the top level, but that only goes so far, what I'm dealing with mainly that its hard to figure out in a multi-tenant registry setup with thousands of projects, which projects are pull like petabytes of data on a monthly basis, I'm mainly looking at that so that me an my team who manages this service are able to engage with teams to provide solutions to become more cost efficient, like work with the teams on how their deployments etc. are looking like.

We have a few tools that we can apply to such high traffic projects that enables us to give them both a better service but also at a lower cost :) It would also be super nice to then be able to then create observability around this within obs. tools to see the development of each project over time.

But I can also see your point from a Harbor perspective is this really a concern, hence why I would gladly take a discussion on the matter to see if there are an opportunity to gauge this at App level.

TL;DR - I would like to be able to both engage and help users of our Harbor instance optimize for both cost and deployment strategies.

[wy65701436]

@Nopzen Thanks for the detailed information. I’d like to convert this into an issue so that more users and maintainers can join the discussion. Let’s see if we can identify any potential enhancements from the app perspective.

[Vad1mo]

if there are a way that we are able to capture how many bytes are leaving Harbor

This will be difficult given the different backend options for Harbor/Distribution support. Tracking S3 egress inside Harbor/Distribution is impossible..

What we, for example, do is track the overall egress from a particular S3 bucket. When you enable S3 Server Access Logs, you can reconstruct (partly) the egress flow. However, given that all of this is cloud provider specific here, this all is outside the scope of the project.

To my knowledge, [distribution] can track egress if the backend is a filesystem. See https://github.com/distribution/distribution/blob/main/notifications/metrics.go

[Nopzen]

Hi @Vad1mo

Sorry for the late reply, yeah that seems not super great when it is provider specific 100% agree, it would cause this project to take a stance on every single provider.

I'll take a look on the distribution package to see if that is something, i guess i would have then find a matter of how to tie it to my Harbor consumption, I'll have a look at the matter.