Spring Boot

Supported Versions

Currently supported versions are Spring Boot 1.x and 2.x

Sensor (Data Collection)

Tracked Configuration

  • Name
  • Application Version
  • Spring Boot Version
  • Status
  • Port
  • HTTP Session Max
  • Application Configuration

Metrics

  • Requests incl. Status Codes
  • Sessions
  • Endpont Request/Response Breakdown

Health Signatures

Health Description
No sessions left Maximum HTTP Sessions reached
SpringBoot application status Status is DOWN

Configuration

Spring Boot monitoring requires that Spring Boot Actuator is configured:

   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-actuator</artifactId>
   </dependency>

Instana queries metrics and health from the respective Spring Boot management MBeans org.springframework.boot:type=Endpoint,name=Metrics and org.springframework.boot:type=Endpoint,name=Health

Configuration

Naming Spring Boot Apps

Instana extracts the name for the Spring Boot instances leveraging the build-info.properties file. It can be generated for example with the spring-boot-maven-plugin:

<plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  <configuration>
    <executable>true</executable>
  </configuration>
  <executions>
    <execution>
      <goals>
        <goal>build-info</goal>
      </goals>
      <configuration>
        <additionalProperties>
          <name>${project.artifactId}</name>
          <version>${project.version}</version>
        </additionalProperties>
      </configuration>
    </execution>
  </executions>
</plugin>

See https://docs.spring.io/spring-boot/docs/current/maven-plugin/examples/build-info.html for details.

Alternatively, you can also set spring.application.name in your application config.