gRPC & High Performance APIs · レッスン

gRPCインタラクションのロギング

デバッグと分析に役立つよう、gRPCのリクエスト、レスポンス、エラーに対する構造化ロギングを実装します。

「gRPCインタラクションのロギング」はCoddyKit上の無料gRPC & High Performance APIsレッスンです。これはレッスン1/4です。下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。これはgRPC & High Performance APIs学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 gRPC & High Performance APIsコースには全4レッスンが含まれています。

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

Why Log Your gRPC Services?

In distributed systems, understanding what's happening inside your gRPC services is crucial. Logs provide a window into your application's behavior.

Debugging: Quickly pinpoint issues when things go wrong.
Monitoring: Track service health, performance, and usage patterns.
Auditing: Record important events for security and compliance.

Without good logs, debugging complex gRPC interactions can be like finding a needle in a haystack!

Understanding Structured Logging

Traditional logs often use plain text, which is hard for machines to parse. Structured logging outputs data in a consistent, machine-readable format, typically JSON.

This means each log entry is a set of key-value pairs, making it:

Searchable: Easily filter by specific fields (e.g., userId, methodName).
Analyzable: Aggregate data to spot trends or anomalies.
Automated: Process logs with tools for dashboards and alerts.

It's a best practice for modern microservices, especially with gRPC.

Logging gRPC Request Start

When a gRPC request comes in, logging its start is a great first step. You should capture key details like the method being called and a unique identifier for the request.

In a real application, you'd use a logging framework (e.g., Logback, Zap) to output JSON. Here, we'll simulate it with System.out.println for demonstration.

public class LogRequest {
  public static void main(String[] args) {
    String methodName = "/example.Service/Greet";
    String requestId = "req-a1b2c3d4";
    String clientIp = "192.168.1.100";

    // Simulate structured logging for an incoming gRPC request
    System.out.println("{ \"level\": \"INFO\", "
                     + "\"message\": \"gRPC Request Started\", "
                     + "\"method\": \"" + methodName + "\", "
                     + "\"requestId\": \"" + requestId + "\", "
                     + "\"clientIp\": \"" + clientIp + "\" }");
  }
}

Logging Request Payload Details

Sometimes, you need to log parts of the request message itself. This can be useful for debugging specific inputs.

Important: Be extremely cautious about logging sensitive data like passwords, PII (Personally Identifiable Information), or financial details. Mask or omit such data from your logs!

public class LogPayload {
  public static void main(String[] args) {
    String requestId = "req-a1b2c3d4";
    String userName = "Alice"; // Example non-sensitive payload data
    int userId = 123;

    // Simulate logging parts of the request payload
    System.out.println("{ \"level\": \"DEBUG\", "
                     + "\"message\": \"Request Payload Data\", "
                     + "\"requestId\": \"" + requestId + "\", "
                     + "\"user\": \"" + userName + "\", "
                     + "\"userId\": " + userId + " }");

    System.out.println("Remember: Avoid sensitive data in logs!");
  }
}

Logging gRPC Response End

Once your gRPC service processes a request and sends a response, log the outcome. This helps track successful operations and measure performance.

Key details include the gRPC status code (e.g., OK, NOT_FOUND), the latency of the operation, and potentially a summary of the response.

public class LogResponse {
  public static void main(String[] args) {
    String methodName = "/example.Service/Greet";
    String requestId = "req-a1b2c3d4";
    String statusCode = "OK"; // gRPC status
    long latencyMs = 42; // milliseconds to process

    // Simulate structured logging for a gRPC response
    System.out.println("{ \"level\": \"INFO\", "
                     + "\"message\": \"gRPC Request Completed\", "
                     + "\"method\": \"" + methodName + "\", "
                     + "\"requestId\": \"" + requestId + "\", "
                     + "\"statusCode\": \"" + statusCode + "\", "
                     + "\"latencyMs\": " + latencyMs + " }");
  }
}

Handling and Logging gRPC Errors

Errors are inevitable. Logging them effectively is critical for troubleshooting. Distinguish between gRPC status errors (like UNAVAILABLE, PERMISSION_DENIED) and application-level exceptions.

Always log the gRPC status code, a descriptive error message, and ideally, a stack trace for unexpected application errors (at an ERROR level).

public class LogError {
  public static void main(String[] args) {
    String methodName = "/example.Service/Greet";
    String requestId = "req-a1b2c3d4";
    String grpcStatus = "NOT_FOUND"; // gRPC specific status
    String errorMessage = "User with ID '123' not found.";

    // Simulate an error log for a gRPC status
    System.out.println("{ \"level\": \"WARN\", "
                     + "\"message\": \"gRPC Request Failed\", "
                     + "\"method\": \"" + methodName + "\", "
                     + "\"requestId\": \"" + requestId + "\", "
                     + "\"grpcStatus\": \"" + grpcStatus + "\", "
                     + "\"errorDetail\": \"" + errorMessage + "\" }");
    try {
      // Simulate an unexpected application exception
      throw new RuntimeException("Database connection failed!");
    } catch (Exception e) {
      System.out.println("{ \"level\": \"ERROR\", "
                       + "\"message\": \"Application Exception\", "
                       + "\"requestId\": \"" + requestId + "\", "
                       + "\"exceptionType\": \"" + e.getClass().getName() + "\", "
                       + "\"exceptionMessage\": \"" + e.getMessage().replace("\"", "\\\"") + "\" }");
    }
  }
}

Logging with Correlation IDs

In microservices, a single user request might traverse multiple gRPC services. A correlation ID (or trace ID) is a unique identifier passed along with the request across all services.

By including this ID in every log entry related to that request, you can easily trace the full flow of an operation, even if it spans many services. gRPC metadata is the perfect place to transmit these IDs.

Logging gRPC Streaming Interactions

Logging for streaming gRPC (server, client, or bidirectional) requires a slightly different approach. Instead of a single request/response pair, you have a stream of messages.

Log the start and end of the stream.
Log each individual message sent or received, especially for debugging.
Log any stream-specific errors (e.g., client disconnection).

This helps understand the flow of data over time within a single stream.

Log Levels & Performance Tips

Use appropriate log levels (DEBUG, INFO, WARN, ERROR) to control verbosity. DEBUG is for detailed development, INFO for normal operations, ERROR for critical failures.

Performance: Excessive logging can impact performance. Avoid logging large payloads at high traffic.
Asynchronous Logging: Use logging frameworks that support asynchronous writes to prevent blocking your application threads.
Sampling: For very high-volume events, consider logging only a sample of requests.

Quick Check: Logging Benefits

You've learned about structured logging for gRPC. Let's test your understanding.

Recap: Effective gRPC Logging

Great job! You've learned how to implement effective logging for your gRPC services.

Structured logs are key for modern microservices.
Log request and response details, including method, ID, status, and latency.
Always log errors with relevant details and stack traces.
Use correlation IDs to trace requests across services.
Be mindful of sensitive data and choose appropriate log levels.

Next, we'll explore distributed tracing with OpenTelemetry to get even deeper insights into your gRPC applications!

よくある質問

「gRPCインタラクションのロギング」レッスンは無料ですか？

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

「gRPCインタラクションのロギング」で何を学びますか？

デバッグと分析に役立つよう、gRPCのリクエスト、レスポンス、エラーに対する構造化ロギングを実装します。ブラウザで直接実行するハンズオンコードでgRPC & High Performance APIsを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

gRPC & High Performance APIsを始めるのに経験は必要ですか？

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

「gRPCインタラクションのロギング」レッスンにはどのくらい時間がかかりますか？

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

このgRPC & High Performance APIsレッスンでコードを書いて実行できますか？

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

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

← gRPC & High Performance APIsに戻る