WebSocket接続の監視
アクティブな接続数、メッセージレート、サーバーの健全性を追跡する監視ソリューションを実装します。
「WebSocket接続の監視」はCoddyKit上の無料WebSockets & Real-Time Systems with Springレッスンです。 これはレッスン2/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはWebSockets & Real-Time Systems with Spring学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 WebSockets & Real-Time Systems with Springコースには全4レッスンが含まれています。
このレッスンの一部はまだ翻訳されておらず、英語で表示されています。
Why Monitor WebSockets?
Real-time applications, powered by WebSockets, need constant attention to ensure smooth operation. Unlike traditional HTTP, WebSockets maintain persistent connections, making their health critical.
Monitoring helps us understand performance, identify bottlenecks, and react quickly to issues before users are affected. It's key for reliable real-time experiences.
Essential WebSocket Metrics
When monitoring WebSockets, focus on these key areas:
- Active Connections: How many clients are currently connected?
- Message Rates: How many messages are sent/received per second?
- Error Rates: How often do connections fail or messages encounter errors?
- Latency: How quickly are messages processed and delivered?
Tracking these gives you a clear picture of your application's health.
Basic Monitoring with Actuator
Spring Boot Actuator provides production-ready features to monitor and manage your application. It exposes various endpoints that give insights into your app's health, metrics, and environment.
While not specific to WebSockets, Actuator can show general JVM metrics, HTTP request metrics, and overall application health, which are foundational for any monitoring setup.
Actuator's Metrics Endpoint
To get started, add the Actuator dependency to your pom.xml. Then, you can access endpoints like /actuator/health or /actuator/metrics.
The /actuator/metrics endpoint lists available metrics, including some related to thread pools or network activity that might indirectly reflect WebSocket load.
<!-- pom.xml snippet -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>Micrometer for Custom Metrics
For WebSocket-specific metrics, we'll use Micrometer, Spring Boot's metrics facade. It allows you to instrument your code with custom counters, gauges, timers, and more, which can then be exported to various monitoring systems.
Micrometer provides a unified API, letting you choose your monitoring backend (like Prometheus, Grafana, etc.) without changing your code.
Counting Live WebSocket Sessions
To track active WebSocket connections, we can use an AtomicInteger to count sessions. Micrometer's Gauge can then expose this value.
A Gauge is perfect for values that fluctuate, like the number of currently connected clients. In a real app, you'd update this counter on connect/disconnect events.
import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
import java.util.concurrent.atomic.AtomicInteger;
public class SessionCounterDemo {
private final AtomicInteger activeSessions = new AtomicInteger(0);
private final MeterRegistry meterRegistry;
public SessionCounterDemo(MeterRegistry registry) {
this.meterRegistry = registry;
Gauge.builder("websocket.active.sessions", activeSessions, AtomicInteger::get)
.description("Number of active WebSocket sessions")
.register(meterRegistry);
}
public void connect() {
activeSessions.incrementAndGet();
}
public void disconnect() {
activeSessions.decrementAndGet();
}
public static void main(String[] args) {
MeterRegistry registry = new SimpleMeterRegistry();
SessionCounterDemo demo = new SessionCounterDemo(registry);
System.out.println("Initial sessions: " + demo.activeSessions.get());
demo.connect();
demo.connect();
System.out.println("After 2 connects: " + demo.activeSessions.get());
demo.disconnect();
System.out.println("After 1 disconnect: " + demo.activeSessions.get());
}
}Tracking Message Rates
Besides connections, tracking message rates is crucial. We can use a Micrometer Counter to increment each time a message is sent or received.
A Counter is a single-value metric that only increases. It's perfect for counting events like messages processed, requests handled, or errors occurred.
import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
public class MessageCounterDemo {
private final Counter messagesReceived;
public MessageCounterDemo(MeterRegistry registry) {
this.messagesReceived = Counter.builder("websocket.messages.received")
.description("Number of WebSocket messages received")
.register(registry);
}
public void onMessageReceived(String message) {
messagesReceived.increment();
System.out.println("Received message: " + message);
}
public static void main(String[] args) {
MeterRegistry registry = new SimpleMeterRegistry();
MessageCounterDemo demo = new MessageCounterDemo(registry);
System.out.println("Initial messages: " + demo.messagesReceived.count());
demo.onMessageReceived("Hello");
demo.onMessageReceived("World");
System.out.println("Total messages: " + demo.messagesReceived.count());
}
}Capturing WebSocket Errors
Errors can occur at various stages: connection handshakes, message parsing, or business logic. It's vital to track these to maintain application stability.
You can use a Counter for specific error types, perhaps with tags to differentiate between connection errors, message format errors, or server processing errors.
import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
public class ErrorCounterDemo {
private final Counter connectionErrors;
private final Counter messageProcessingErrors;
public ErrorCounterDemo(MeterRegistry registry) {
this.connectionErrors = Counter.builder("websocket.errors.total")
.tag("type", "connection")
.description("Total connection errors")
.register(registry);
this.messageProcessingErrors = Counter.builder("websocket.errors.total")
.tag("type", "message_processing")
.description("Total message processing errors")
.register(registry);
}
public void simulateConnectionError() {
connectionErrors.increment();
System.out.println("Connection error occurred.");
}
public void simulateMessageProcessingError() {
messageProcessingErrors.increment();
System.out.println("Message processing error occurred.");
}
public static void main(String[] args) {
MeterRegistry registry = new SimpleMeterRegistry();
ErrorCounterDemo demo = new ErrorCounterDemo(registry);
System.out.println("Initial connection errors: " + demo.connectionErrors.count());
demo.simulateConnectionError();
System.out.println("Connection errors after one: " + demo.connectionErrors.count());
demo.simulateMessageProcessingError();
System.out.println("Message processing errors: " + demo.messageProcessingErrors.count());
}
}Exporting Metrics to Dashboards
Once you've instrumented your application with Micrometer, these metrics can be exported to various monitoring systems like Prometheus, Grafana, Datadog, or New Relic.
These systems then allow you to build powerful dashboards to visualize your WebSocket metrics in real-time. This helps you spot trends, set alerts, and troubleshoot issues effectively.
Micrometer Metrics Check
You want to track the number of currently active users in a chat application. Which Micrometer metric type is best suited for this purpose?
Monitoring Recap
Great job! You've learned the importance of monitoring WebSocket applications and how to implement it.
- We explored key WebSocket metrics like active connections and message rates.
- You saw how Spring Boot Actuator offers basic health checks.
- We used Micrometer to create custom
GaugeandCountermetrics for WebSocket sessions and messages.
Next, dive into specific tools like Prometheus and Grafana to visualize these metrics and build robust dashboards!
よくある質問
「WebSocket接続の監視」レッスンは無料ですか？
はい。「WebSocket接続の監視」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、WebSockets & Real-Time Systems with Springコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 WebSockets & Real-Time Systems with Springコースには全4レッスンが含まれています。
「WebSocket接続の監視」で何を学びますか？
アクティブな接続数、メッセージレート、サーバーの健全性を追跡する監視ソリューションを実装します。 ブラウザで直接実行するハンズオンコードでWebSockets & Real-Time Systems with Springを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。
WebSockets & Real-Time Systems with Springを始めるのに経験は必要ですか？
事前経験は必要ありません。CoddyKitのWebSockets & Real-Time Systems with Springは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン2/4です。
「WebSocket接続の監視」レッスンにはどのくらい時間がかかりますか？
ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。
このWebSockets & Real-Time Systems with Springレッスンでコードを書いて実行できますか？
はい。すべてのWebSockets & Real-Time Systems with Springレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。