Skip to content

Latest commit

 

History

History
117 lines (101 loc) · 5.57 KB

README.md

File metadata and controls

117 lines (101 loc) · 5.57 KB
Raw

test-events-springboot

Fire test events for Spring Boot. Talks to actuator metrics and actions.

Actuator client

There is an actuator client that calls an actuator/env endpoint and turns properties into variables in an event-scheduler message. The variables in a message are picked up by the perfana-java-client and are sent to Perfana for the current test run.

  • tags comma separated list of tags send along with the properties
  • actuatorBaseUrl the base url for the actuator endpoint, /env will be added
  • actuatorEnvProperties comma seperated list of actuator env properties to turn into variables
  • actuatorPropPrefix (DEPRECATED, use tags instead) prefix for the properties to send as variables

Tip: check your http://application/actuator/env to see what is available.

Note: env needs to be enabled in actuator. Be careful though to not expose this endpoint on the internet!

<eventConfig implementation="io.perfana.events.springboot.event.SpringBootEventConfig">
    <name>ActuatorEvent</name>
    <tags>my-app</tags>
    <actuatorBaseUrl>http://my-app:8080/actuator</actuatorBaseUrl>
    <actuatorEnvProperties>java.runtime.version,JDK_JAVA_OPTIONS</actuatorEnvProperties>
</eventConfig>

Events

This events plugin reacts to the following custom events:

  • heapdump - calls actuator heap dump endpoint and saves it to dumpPath (defaults to java.io.tmpdir)
  • threaddump - calls actuator thread dump endpoint and saves it to dumpPath (defaults to java.io.tmpdir)

In the example below, there are two heap dump requests (5 and 60 seconds into the test run) and two stack dump requests (10 and 15 seconds into the test run).

The names of the dumps include the test run id and a time stamp.

In the test start event, it collects settings from actuator env endpoint, and broadcasts this to other plugins. For instance, if you use the Perfana Java client plugin as well, this information is automatically send to Perfana. The values are then stored with the current test run.

Example config

Use one of the Perfana maven plugins (event-scheduler-maven-plugin, events-gatling-maven-plugin, events-jmeter-maven-plugin, ...) and hook-up this test-events-springboot via a sub-dependency:

<plugins>
    <plugin>
        <groupId>io.perfana</groupId>
        <artifactId>event-scheduler-maven-plugin</artifactId>
        <configuration>
            <eventSchedulerConfig>
                <debugEnabled>true</debugEnabled>
                <schedulerEnabled>true</schedulerEnabled>
                <failOnError>true</failOnError>
                <continueOnEventCheckFailure>true</continueOnEventCheckFailure>
                <eventScheduleScript>
                    PT5S|heapdump
                    PT10S|threaddump
                    PT15S|threaddump
                    PT1M|heapdump
                </eventScheduleScript>
                <testConfig>
                    <systemUnderTest>${systemUnderTest}</systemUnderTest>
                    <version>${version}</version>
                    <workload>${workload}</workload>
                    <testEnvironment>${testEnvironment}</testEnvironment>
                    <testRunId>${testRunId}</testRunId>
                    <buildResultsUrl>${buildResultsUrl}</buildResultsUrl>
                    <rampupTimeInSeconds>${rampupTimeInSeconds}</rampupTimeInSeconds>
                    <constantLoadTimeInSeconds>${constantLoadTimeInSeconds}</constantLoadTimeInSeconds>
                    <annotations>${annotations}</annotations>
                    <tags>${tags}</tags>
                </testConfig>
                <eventConfigs>
                    <eventConfig implementation="io.perfana.events.springboot.event.SpringBootEventConfig">
                        <name>SpringBootEventFrontend</name>
                        <tags>optimus-prime-fe,beta</tags>
                        <actuatorBaseUrl>http://optimus-prime-fe:8080/actuator</actuatorBaseUrl>
                        <actuatorEnvProperties>java.runtime.version,JDK_JAVA_OPTIONS,afterburner.async_core_pool_size</actuatorEnvProperties>
                        <dumpPath>/test-data/dump-files/fontend/</dumpPath>
                    </eventConfig>
                    <eventConfig implementation="io.perfana.events.springboot.event.SpringBootEventConfig">
                        <name>SpringBootEventBackend</name>
                        <tags>optimus-prime-be,beta</tags>
                        <actuatorBaseUrl>http://optimus-prime-be:8080/actuator</actuatorBaseUrl>
                        <actuatorEnvProperties>java.runtime.version,JDK_JAVA_OPTIONS,afterburner.async_core_pool_size</actuatorEnvProperties>
                        <dumpPath>/test-data/dump-files/backend/</dumpPath>
                    </eventConfig>
                </eventConfigs>
            </eventSchedulerConfig>
        </configuration>
        <dependencies>
            <dependency>
                <groupId>io.perfana</groupId>
                <artifactId>test-events-springboot</artifactId>
                <version>${test-events-springboot.version}</version>
            </dependency>
            <dependency>
                <groupId>io.perfana</groupId>
                <artifactId>perfana-java-client</artifactId>
                <version>${perfana-java-client.version}</version>
            </dependency>
        </dependencies>
    </plugin>
</plugins>

See also: