How to generate a PGO optimized native executable for Quarkus App?

Question

I have a Quarkus Application exposed as a REST API. I need to generate an Profile Guided Optimized Native Image for that application.

I looked into the Quarkus documentation but could not find much. Anyone has generated same ?

I have GraalVM Enterprise edition setup in my local machine.

For generating normal native image, this command is used :

./mvnw package -Dnative

Answer 1

In general, generating an optimized executable includes the following steps:

1. Build an instrumented app:

   native-image --pgo-instrument MyApp
   

2. Run the instrumented executable and apply workloads to it to generate a profile file:

   ./myapp
   

This will generate a default.iprof file in the working directory. The quality of the workload (executing all relevant code paths) and giving the application enough time to collect profiles are essential for having complete profiling information and therefore the best performance. Note that the profile file won’t appear until after the application shutdown.

3. Build an optimized executable. The profiles file with default name and location will be picked up automatically, alternatively you can pass it along:

    native-image --pgo=default.iprof MyApp
   

Now for a Quarkus application and building from Maven, what you can do is create corresponding profiles for those steps, for example:

    <profile>
   <id>instrumented</id>
    …
   <properties>
    …
    <quarkus.native.additional-build-args>--pgo-instrument</quarkus.native.additional-build-args>
   </properties>
   </profile>

and

    <profile>
   <id>optimized</id>
    …
   <properties>
    …
    <quarkus.native.additional-build-args>--pgo=${project.basedir}/default.iprof</quarkus.native.additional-build-args>
   </properties>
   </profile>

Alternatively the same should work from command line, for example:

./mvnw package -Dnative -Dquarkus.native.additional-build-args=--pgo=default.iprof