Index

A C E G M R U
All Classes and Interfaces|All Packages

A

apply(Project) - Method in class com.patbaumgartner.greener.gradle.GreenerPlugin

C

com.patbaumgartner.greener.gradle - package com.patbaumgartner.greener.gradle

E

EnergyDoctorTask - Class in com.patbaumgartner.greener.gradle

Runs preflight environment checks for the greener-spring-boot Gradle plugin.

EnergyDoctorTask() - Constructor for class com.patbaumgartner.greener.gradle.EnergyDoctorTask

G

getAppArgs() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Additional application arguments passed to the Spring Boot process.

getAppArgs() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Additional application arguments passed to the Spring Boot process.

getAutoUpdateBaseline() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

When true, the measurement result is automatically promoted to the baseline after a successful run.

getAutoUpdateBaseline() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

When true, the measurement result is automatically promoted to the baseline after a successful run.

getBaselineFile() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Path to the JSON baseline file.

getBaselineFile() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Path to the JSON baseline file.

getBaselineFile() - Method in class com.patbaumgartner.greener.gradle.UpdateBaselineTask

Path to the JSON baseline file to update.

getBaseUrl() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Base URL of the Spring Boot application.

getBaseUrl() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Base URL of the Spring Boot application.

getBranch() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Branch name to record in the baseline when auto-updating.

getBranch() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Branch name to record in the baseline when auto-updating.

getBranch() - Method in class com.patbaumgartner.greener.gradle.UpdateBaselineTask

Branch name to record in the baseline.

getCommitSha() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Git commit SHA to record in the baseline when auto-updating.

getCommitSha() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Git commit SHA to record in the baseline when auto-updating.

getCommitSha() - Method in class com.patbaumgartner.greener.gradle.UpdateBaselineTask

Git commit SHA to record in the baseline.

getExternalTrainingCommand() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Optional external command used as the training workload (e.g.

getExternalTrainingCommand() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Optional external command used as the training workload (e.g.

getExternalTrainingScriptFile() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Path to an external shell script file used as the training workload.

getExternalTrainingScriptFile() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Path to an external shell script file used as the training workload.

getFailOnError() - Method in class com.patbaumgartner.greener.gradle.EnergyDoctorTask

When true (default) the build fails on any FAIL-level check.

getFailOnRegression() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Whether to fail the build on energy regression beyond GreenerExtension.getThreshold().

getFailOnRegression() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

When true, the build is failed if energy consumption regressed beyond MeasureEnergyTask.getThreshold().

getHealthCheckPath() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Health-check path used to detect when the application is ready.

getHealthCheckPath() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Health-check path used to detect application readiness.

getIdleProbeSeconds() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Seconds to measure idle baseline power before workload (0 = disabled).

getIdleProbeSeconds() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Idle-baseline window (seconds) measured before workload.

getIterations() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Number of independent measurement iterations (default 5).

getIterations() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Number of independent measurement iterations.

getJoularCodeJavaAgentPath() - Method in class com.patbaumgartner.greener.gradle.EnergyDoctorTask

Optional Joular Code Java agent path.

getJoularCodeJavaAgentPath() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Path to the Joular Code Java agent jar.

getJoularCodeJavaAgentPath() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Path to the Joular Code Java agent jar.

getJoularCodeJavaConfigPath() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Path to the Joular Code Java joularcodejava.properties file.

getJoularCodeJavaConfigPath() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Path to the Joular Code Java joularcodejava.properties file.

getJoularCoreBinaryPath() - Method in class com.patbaumgartner.greener.gradle.EnergyDoctorTask

Optional Joular Core binary path.

getJoularCoreBinaryPath() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Full path to the Joular Core binary (optional; auto-downloaded when absent).

getJoularCoreBinaryPath() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Full path to the Joular Core binary (optional; auto-downloaded when absent).

getJoularCoreComponent() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Hardware component to monitor: cpu, gpu, or all.

getJoularCoreComponent() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Hardware component to monitor: cpu, gpu, or all.

getJoularCoreVersion() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Joular Core release version to download when GreenerExtension.getJoularCoreBinaryPath() is unset.

getJoularCoreVersion() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Joular Core release version to download when MeasureEnergyTask.getJoularCoreBinaryPath() is not set.

getJvmArgs() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Additional JVM arguments passed when starting the Spring Boot process.

getJvmArgs() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Additional JVM arguments passed when starting the Spring Boot process.

getLatestReportFile() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Explicit path to a report JSON file to promote during updateEnergyBaseline.

getLatestReportFile() - Method in class com.patbaumgartner.greener.gradle.UpdateBaselineTask

Path to the latest energy report JSON produced by measureEnergy.

getLayout() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Gets the project layout.

getLayout() - Method in class com.patbaumgartner.greener.gradle.UpdateBaselineTask

Gets the project layout.

getMeasureDurationSeconds() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Duration in seconds of the actual measurement window after warmup.

getMeasureDurationSeconds() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Duration in seconds of the actual measurement window after warmup.

getProjectDir() - Method in class com.patbaumgartner.greener.gradle.EnergyDoctorTask

Project directory used for jar auto-detection.

getProviders() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Gets the provider factory.

getProviders() - Method in class com.patbaumgartner.greener.gradle.UpdateBaselineTask

Gets the provider factory.

getRegressionMetric() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Regression metric: ENERGY_PER_REQUEST (default) or TOTAL_ENERGY.

getRegressionMetric() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Regression metric.

getReportOutputDir() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Directory where the HTML report is written.

getReportOutputDir() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Directory where the HTML report is written.

getReportOutputDir() - Method in class com.patbaumgartner.greener.gradle.UpdateBaselineTask

Report output directory where the measureEnergy task writes its results.

getRequestsPerSecond() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Requests per second (passed as RPS environment variable).

getRequestsPerSecond() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Number of HTTP requests per second (passed as RPS environment variable).

getSkip() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

When true, plugin execution is skipped entirely.

getSkip() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

When true, the task execution is skipped entirely.

getSkip() - Method in class com.patbaumgartner.greener.gradle.UpdateBaselineTask

When true, the task execution is skipped entirely.

getSpringBootJar() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Path to the executable Spring Boot fat-jar.

getSpringBootJar() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Path to the executable Spring Boot fat-jar.

getStartupTimeoutSeconds() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Seconds to wait for the application health endpoint before aborting.

getStartupTimeoutSeconds() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Seconds to wait for the application health endpoint before aborting.

getThreshold() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Maximum allowed percentage increase in total energy before the build is failed.

getThreshold() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Maximum allowed percentage increase in total energy before the build is failed.

getTimestampReports() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

When true, the report output directory gets a timestamp suffix and a latest symlink is created pointing to the most recent run.

getTimestampReports() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

When true, the report output directory gets a timestamp suffix (e.g.

getTopN() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Maximum number of methods to display in HTML report tables.

getTopN() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Number of top energy-consuming methods to show in the HTML report.

getVmMode() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Enable Joular Core VM mode - for virtualised environments where RAPL counters are not directly accessible.

getVmMode() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Enable Joular Core VM mode.

getVmPowerFilePath() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Path to the file that provides VM power readings when GreenerExtension.getVmMode() is true.

getVmPowerFilePath() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Path to the VM power file that Joular Core reads when MeasureEnergyTask.getVmMode() is true.

getWarmupDurationSeconds() - Method in class com.patbaumgartner.greener.gradle.GreenerExtension

Warmup duration in seconds.

getWarmupDurationSeconds() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Warmup duration in seconds.

getWorkloadCommand() - Method in class com.patbaumgartner.greener.gradle.EnergyDoctorTask

Optional first token of the workload command (e.g.

GreenerExtension - Class in com.patbaumgartner.greener.gradle

DSL extension for the greener block in Gradle build scripts.

GreenerExtension() - Constructor for class com.patbaumgartner.greener.gradle.GreenerExtension

GreenerPlugin - Class in com.patbaumgartner.greener.gradle

Gradle plugin entry point for greener-spring-boot.

GreenerPlugin() - Constructor for class com.patbaumgartner.greener.gradle.GreenerPlugin

M

measureEnergy() - Method in class com.patbaumgartner.greener.gradle.MeasureEnergyTask

Runs the energy measurement workflow.

MeasureEnergyTask - Class in com.patbaumgartner.greener.gradle

Gradle task that measures the energy consumption of a Spring Boot application using Joular Core.

MeasureEnergyTask() - Constructor for class com.patbaumgartner.greener.gradle.MeasureEnergyTask

R

runDoctor() - Method in class com.patbaumgartner.greener.gradle.EnergyDoctorTask

Runs the doctor checks and prints them via the Gradle logger.

U

updateBaseline() - Method in class com.patbaumgartner.greener.gradle.UpdateBaselineTask

Promotes the most recent measurement as the new energy baseline.

UpdateBaselineTask - Class in com.patbaumgartner.greener.gradle

Promotes the most recent energy measurement as the new baseline.

UpdateBaselineTask() - Constructor for class com.patbaumgartner.greener.gradle.UpdateBaselineTask

A C E G M R U
All Classes and Interfaces|All Packages