Aurora Spring Boot Base Starter

This starter should not be used directly, use either aurora-spring-boot-webflux-starter for reactive applications (WebClient) or aurora-spring-boot-mvc-starter for blocking servlet-based applications (RestTemplate).

The base starter provides the basic setup required for Spring Boot applications. It has the following main dependencies:

• Spring Boot
• Spring Actuator
• Spring Sleuth (tracing)
• Micrometer / Prometheus

How to use

Include the starter as a dependency

<dependency>
  <groupId>no.skatteetaten.aurora.springboot</groupId>
  <artifactId>aurora-spring-boot-base-starter</artifactId>
  <version>${aurora.starters.version}</version>
</dependency>

In order to deploy this application on the AuroraPlatform using AuroraConfig the following must be specified in the base file:

actuator:
  path: /management/prometheus

Features

Metrics

The starter will automatically add Micrometer as the default metrics registry and also add micrometer-registry-prometheus for providing the /prometheus actuator endpoint that will be (optionally) read by Prometheus automatically for all applications deployed on Aurora OpenShift.

Additionally, a number of Micrometer metrics collectors will be automatically registered;

• JvmThreadMetrics
• ProcessorMetrics
• JvmGcMetrics
• JvmMemoryMetrics
• LogbackMetrics
• UptimeMetrics
• FileDescriptorMetrics
• DataSourceMetrics
• WebClientMetrics (only relevant for WebFlux starter)

To get an overview of how Micrometer works we encourage you to read the Micrometer docs: https://micrometer.io/docs. Relevant sections are http://micrometer.io/docs/concepts, http://micrometer.io/docs/registry/prometheus and http://micrometer.io/docs/ref/spring/1.5

Outgoing and incoming HTTP metrics have by default percentiles turned on and has buckets between 100ms and 5s.

management.metrics.distribution.percentiles-histogram.http=true

There are default min/max buckets set to 100ms to 5secounds for http and operations metrics

If you would like to change these use the following bean in your code

@Bean
MeterFilter minExpectedHttp() {
    return MeterFilter.minExpected("http", Duration.ofMillis(200));
}

Auto registration of DataSource

If a database is provided on OpenShift there will automatically be a DataSource created from the properties files provided by the platform. If you want to override to use a specific database you can set the aurora.db property if you have more than one db in your application.

Connection count metrics will also be collected from the DataSource.

Configuration of the Actuator Endpoints

Most actuator endpoints will be disabled by default;

• auditevents
• heapdump
• metrics
• logfile
• autoconfig
• configprops
• mappings
• beans
• dump
• jolokia

Actuator will also be configured to use the port specified by the MANAGEMENT_HTTP_PORT environment variable. The value of this variable will be set by the Aurora platform when deploying. Security on the actuator endpoints and the metrics filter will be disabled.

The Aurora Management Interface

The starter will help you implement the requirements for the Aurora Management Interface by setting some common configuration values.

Note that the management.port will be set to the value of the MANAGEMENT_HTTP_PORT environment variable provided by the platform. The default is to put all actuator endpoints on a different port than the main application/api endpoints.

info.serviceLinks.metrics={metricsHostname}/dashboard/db/openshift-project-spring-actuator-view?var-ds=openshift-{cluster}-ose&var-namespace={namespace}&var-app={name}

info.podLinks.metrics={metricsHostname}/dashboard/db/openshift-project-spring-actuator-view-instance?var-ds=openshift-{cluster}-ose&var-namespace={namespace}&var-app={name}&var-instance={podName}

management.health.status.order=DOWN, OUT_OF_SERVICE, UNKNOWN, OBSERVE, UP
management.port=${MANAGEMENT_HTTP_PORT:8081}

If you need to customize the response codes override the management.endpoint.health.status.http-mapping.* properties. Remember that if you alter any of these properties, you must add the default values for all statuses. This is because any changes here will alter the entire mapping of statuses to HTTP response codes.

Setting of Spring Boot Properties

The spring boot application name will be set from the environment variables APP_NAME and POD_NAMESPACE provided by the platform when deploying to Aurora OpenShift.

The flyway.out-of-order mode will also be activated to allow migrations to be developed in different feature branches at the same time. See the Flyway documentation for more information.

The AURORA_VERSION and IMAGE_BUILD_TIME variables are included in spring boots actuator output since we use them in a central management overview dashboard.

spring.application.name=${APP_NAME:my}-${POD_NAMESPACE:app}
spring.jackson.date-format=com.fasterxml.jackson.databind.util.ISO8601DateFormat
flyway.out-of-order=true
info.auroraVersion= ${AURORA_VERSION:local-dev}
info.imageBuildTime=${IMAGE_BUILD_TIME:}