Spring Boot 4 Complete Guide · レッスン

Spring Boot Actuatorによる監視

Spring Boot Actuatorのエンドポイントを使用して、本番環境のアプリケーションを監視、管理、調査します。

「Spring Boot Actuatorによる監視」はCoddyKit上の無料Spring Boot 4 Complete Guideレッスンです。これはレッスン2/4です。下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。これはSpring Boot 4 Complete Guide学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 Spring Boot 4 Complete Guideコースには全4レッスンが含まれています。

このレッスンの一部はまだ翻訳されておらず、英語で表示されています。

Meet Spring Boot Actuator

Spring Boot Actuator is a powerful tool that helps you monitor and manage your application when it's running in production. Think of it as your app's built-in dashboard!

It provides production-ready features without requiring you to write much code.

Monitoring: Check health, metrics, and environment details.
Management: Log levels, shutdown, refresh context.
Insight: Understand your app's internal workings.

Include Actuator in Your Project

To use Actuator, you just need to add its starter dependency to your project. This brings in all the necessary libraries.

For Maven, add this to your pom.xml:

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

Discover Actuator's Endpoints

Once Actuator is added, your application automatically exposes several "endpoints". These are HTTP URLs that provide specific information about your running app.

Some default endpoints include:

/actuator/health: Shows application health status.
/actuator/info: Displays general application information.
/actuator/metrics: Provides detailed metrics (CPU, memory, etc.).

By default, only /health and /info are exposed via web.

Run & Access Actuator

Let's create a simple Spring Boot app with Actuator. After running it, you can access the default endpoints in your browser or with a tool like curl.

Try running this and then navigate to http://localhost:8080/actuator/health.

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ActuatorDemoApplication {
  public static void main(String[] args) {
    SpringApplication.run(ActuatorDemoApplication.class, args);
  }
}

Deep Dive: The /health Endpoint

The /actuator/health endpoint is crucial for understanding your application's operational status. It aggregates information from various "health indicators".

DiskSpace: Checks available disk space.
DataSource: Verifies database connectivity (if configured).
Liveness/Readiness: For Kubernetes deployments (newer versions).

It typically returns {"status": "UP"} if everything is fine, or details if something is down.

Custom Info with /info

The /actuator/info endpoint provides general information about your application. By default, it's empty, but you can easily populate it with useful details.

Add custom properties to your application.properties or application.yml:

info.app.name=MyActuatorApp
info.app.version=1.0.0
info.app.description=A demo for CoddyKit

Configure & Expose More Endpoints

By default, only /health and /info are exposed over the web. You can expose more endpoints like /beans (list all Spring beans) or /env (environment properties).

To expose all endpoints, add this to application.properties:

management.endpoints.web.exposure.include=*

Monitor Performance with /metrics

The /actuator/metrics endpoint is invaluable for performance monitoring. It exposes various metrics about your application, JVM, and system.

Examples of metrics:

jvm.memory.used: Current JVM memory usage.
system.cpu.usage: System CPU load.
http.server.requests: Details about incoming HTTP requests.

You can query specific metrics like /actuator/metrics/jvm.memory.used for detailed data.

Build Your Own Health Checks

You can create custom health indicators to check the status of specific parts of your application, like an external service dependency or a custom cache.

Implement the HealthIndicator interface:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.stereotype.Component;

@SpringBootApplication
public class CustomHealthApp {
    public static void main(String[] args) {
        SpringApplication.run(CustomHealthApp.class, args);
    }
}

@Component
class MyCustomHealthIndicator implements HealthIndicator {

    @Override
    public Health health() {
        // Simulate checking an external service
        boolean serviceIsUp = Math.random() > 0.5; // Randomly up or down
        if (serviceIsUp) {
            return Health.up().withDetail("myServiceStatus", "OK").build();
        } else {
            return Health.down().withDetail("myServiceStatus", "Failed").build();
        }
    }
}

Quick Check: Actuator Endpoints

Which of the following Actuator endpoints are exposed by default over the web in a basic Spring Boot application with the Actuator dependency?

Actuator: Your App's Best Friend

Congratulations! You've learned how Spring Boot Actuator transforms your application into a production-ready, observable service.

It provides crucial insights into your app's health and performance.
You can easily add it with a single dependency.
Default endpoints like /health and /info are automatically available.
You can expose more endpoints and even create custom health checks.

Actuator is a must-have for any serious Spring Boot application!

よくある質問

「Spring Boot Actuatorによる監視」レッスンは無料ですか？

はい。「Spring Boot Actuatorによる監視」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、Spring Boot 4 Complete Guideコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Spring Boot 4 Complete Guideコースには全4レッスンが含まれています。

「Spring Boot Actuatorによる監視」で何を学びますか？

Spring Boot Actuatorのエンドポイントを使用して、本番環境のアプリケーションを監視、管理、調査します。ブラウザで直接実行するハンズオンコードでSpring Boot 4 Complete Guideを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

Spring Boot 4 Complete Guideを始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのSpring Boot 4 Complete Guideは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。これはレッスン2/4です。

「Spring Boot Actuatorによる監視」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このSpring Boot 4 Complete Guideレッスンでコードを書いて実行できますか？

はい。すべてのSpring Boot 4 Complete Guideレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

← Spring Boot 4 Complete Guideに戻る