Skip to content

Latest commit

 

History

History
49 lines (40 loc) · 2.75 KB

README.md

File metadata and controls

49 lines (40 loc) · 2.75 KB
Raw

Quarkus Power

Version

This extension is an experiment to measure and display the power consumption of your application as it runs in Dev mode. Only Linux/amd64 and macOS (amd64/apple silicon) are supported at the moment. See below for platform-specific requirements.

Requirements

power-server

This extension relies on retrieving power consumption measurements from an application called power-server. This application needs to be run using sudo to get access to the underlying OS' power reporting layer. Please download the appropriate version for your OS from the release page. Once downloaded, you can unpack the archive and navigate to the bin directory to find the power-server binary that you can then run using: sudo power-server.

Note: On macOS, you will most likely get a dialog telling you that the application cannot be opened because Apple cannot verify it. We're looking into addressing this problem but, in the mean time, you can open System Settings then navigate to the Privacy & Security section. Once there, if you scroll down to the Security sub-section, if you happen to perform these actions not too long after seeing the error dialog, there should be a spot where you can allow the application to run anyway. If you click on Allow, the next time you run power-server, you should get yet another message, which should now let you open the application. Once this is done, you shouldn't need to perform these steps again (until the next time you download an update, that is).

Usage

To use the extension:

  1. Add the extension to the application which energy consumption you wish to measure. You can add it as a dependency to your application: 
    <dependency>
 <groupId>net.laprun.sustainability</groupId>
 <artifactId>quarkus-power</artifactId>
<version>${project.version}</version>
</dependency>
  2. Start your application in dev mode: quarkus dev
  3. Enter the dev mode terminal by pressing : (column)
  4. You should have a new power command available, type power -h for more information
  5. You can start power measurement with power start and stop it with power stop, at which time the power consumption of your app will be displayed.
  6. You can also ask for power to be measured for a given duration by using the -s option when calling power start. In this case, there's no need to call power stop, the energy consumed during the specified time will be automatically displayed once the time period is elapsed.