green-coding-solutions/green-metrics-tool

Make metric "Network Energy" in UI more understandable

Closed this issue · 4 comments

What the metric "Network Energy [J]" really means is not intuitively clear based on the information given in the UI.

There is a link to the Formulas article and a tooltip ("Transfer cost of data through routers, data-centers and transmission networks.").
At first, I thought the metric tries to give a rough estimation of the energy consumption due to the network transmissions during the measurement based on the given formula. However, this assumption is wrong. After reading the documentation of the Network IO metric provider, I realized that the metric refers to the potential energy consumption by network traffic in a distributed global system.

I think this is totally fine, however, it would be good to understand this only by the information and links given in the UI.

Ideas for improvement:

  • change the tooltip, e.g.: "Potential network transmission costs of the data, in the scenario where the system is distributed globally"
  • add a link to the documentation of the Network IO metric provider to the UI

HEy @davidkopp

thanks for bringing this up! I like the idea of refining the display of the Network Energy value.

I do get your point that "network Energy" implies that this is the cost of the network card. Which it really is not.
So a first change that I would do is rename it from "Network Energy" to "Network Transmission".
Using "Network Transmission Cost" would also be an option, but it is too long for the header. ...

Which of these two do you like better? Maybe you have an even better naming idea for the header?
Screenshot 2023-12-18 at 8 51 50 AM

  1. I also like the idea of clarifying the tooltip, although for me personally I feel that the suggestion "Potential network transmission costs of the data, in the scenario where the system is distributed globally" is too complicated.

Effectively I think it cannot be understood fully without reading the documentation. Since many people will not deep dive into the reporter I would opt for clarifying the approach on the CO2 formulas page.

For the tooltip I would maybe go for something simpler like: "Estimated external energy cost for network infrastructure when data would be transferred through the internet (eg. routers, cables, data-centers etc.). See details under formula."

What do you think?

I think the label "Network Transmission" should be fine.

For me more important is the improvement of the tooltip and your proposal is what I wanted :)

For the tooltip I would maybe go for something simpler like: "Estimated external energy cost for network infrastructure when data would be transferred through the internet (eg. routers, cables, data-centers etc.). See details under formula."

👍

I created a PR here #608

I tried using the full wording as discussed here but it sadly could not fit. Even when I wrapped the lines it looked awkward.

Please check if the new short wording is understandle in your opinion.
Screenshot 2023-12-19 at 8 04 03 AM
Screenshot 2023-12-19 at 8 04 22 AM

The shorter version is also fine for me. It is definitely more understandable than the original tooltip.
Thanks for creating the PR and changing it :)