Skip to content

README.md

Latest commit

 

History

History
126 lines (91 loc) · 2.69 KB

README.md

File metadata and controls

126 lines (91 loc) · 2.69 KB

Spring Boot Profiling Application

This application provides a profiling mechanism for monitoring method execution times in a Spring Boot application. It leverages Spring Boot Actuator to expose profiling data through custom endpoints.

Table of Contents

Introduction

The profiling application is designed to help developers monitor and analyze the execution times of methods annotated with a custom @ActuatorProfiling annotation. The profiling data is exposed through Spring Boot Actuator endpoints.

Features

  • Profiling of method execution times.
  • Customizable profiling settings.
  • Exposed endpoints for retrieving profiling data.
  • Thread-safe handling of profiling data.

Getting Started

Maven dependency

<dependency>
    <groupId>io.github.litefunction</groupId>
    <artifactId>spring-boot-starter-actuator-profiling</artifactId>
    <version>1.0.0</version>
</dependency>

Prerequisites

  • Java 11 or higher
  • Maven or Gradle

Configuration

The application can be configured using properties in application.properties or application.yml.

Default Configuration

profiling.actuator.maxCountList=100
profiling.actuator.enabler=true

Usage

Adding Profiling to Methods

add properties

management.endpoints.web.exposure.include=actuatorProfilingDetail,actuatorProfiling

To profile a method, simply annotate it with @ActuatorProfiling and optionally provide a name:

import com.lite.function.profiling.ActuatorProfiling;

public class ExampleService {

    @ActuatorProfiling(name = "exampleMethod")
    public void exampleMethod() {
        // method logic
    }
}

Accessing Profiling Data

Profiling data can be accessed through the provided Actuator endpoints.

Endpoints

List of Profiling Data

Endpoint: /actuator/actuatorProfiling

  "executingProfilingMethod": {
    "exampleMethod": 403
  }

exampleMethod - name from @ActuatorProfiling

403 - what happens during the execution of the last call

Detailed Profiling Data

Endpoint: /actuator/actuatorProfilingDetail/{name}

{
  "name": "exampleMethod",
  "executingProfilingMethodVals": [
    {
      "delta": 506,
      "localDateTime": "2024-06-23T14:28:39.523107"
    },
    {
      "delta": 103,
      "localDateTime": "2024-06-23T14:28:43.101866"
    },
    {
      "delta": 904,
      "localDateTime": "2024-06-23T14:28:44.564218"
    },
    {
      "delta": 403,
      "localDateTime": "2024-06-23T14:28:47.180746"
    }
  ]
}