https://github.com/metacosm/quarkus-power
An experiment to display power consumption of Quarkus applications
https://github.com/metacosm/quarkus-power
java quarkus-extension sustainability-dashboard
Last synced: 3 months ago
JSON representation
An experiment to display power consumption of Quarkus applications
- Host: GitHub
- URL: https://github.com/metacosm/quarkus-power
- Owner: metacosm
- License: apache-2.0
- Created: 2023-10-23T16:44:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-13T13:42:22.000Z (3 months ago)
- Last Synced: 2025-03-17T10:17:11.655Z (3 months ago)
- Topics: java, quarkus-extension, sustainability-dashboard
- Language: Java
- Homepage:
- Size: 264 KB
- Stars: 3
- Watchers: 5
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: contributing/eclipse-format.xml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Quarkus Power
[](https://search.maven.org/artifact/net.laprun.sustainability/quarkus-power)
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](https://github.com/metacosm/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](https://github.com/metacosm/power-server/releases/). 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:
```xml
net.laprun.sustainability
quarkus-power
${project.version}
```
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.