Enable Structured JSON Logging for Observability (SZ-6)

Task	Estimated Time
Add dependencies + configure JSON format	~1 hour
Enable MDC and structured fields	~1 hour
Add profile-based overrides	~30 mins
Validate and sample logs	~1 hour

rk@tigase.net commented 3 weeks ago

This will generate JSon-formatted logs using logstash-logback-encoder, which plugs into Logback (Spring Boot’s default logging framework). This enables logs to be machine-parsable JSON — perfect for tools like Loki, Elasticsearch, Prometheus (via exporters), or FluentBit. Example:

{
  "@timestamp": "2025-10-02T13:45:00.123Z",
  "level": "INFO",
  "logger": "com.sztab.service.IssueService",
  "thread": "http-nio-8080-exec-3",
  "message": "Updated issue status to IN_PROGRESS",
  "context": "default",
  "mdc": {
    "userId": "rk@tigase.net",
    "requestId": "f3a9c8d0-4b5e-11ee-be56-0242ac120002",
    "projectId": "sztab-core"
  }
}

rk@tigase.net commented 3 weeks ago

Required dependencies and configuration:

<dependency>
  <groupId>net.logstash.logback</groupId>
  <artifactId>logstash-logback-encoder</artifactId>
  <version>7.4</version>
</dependency>

rk@tigase.net commented 3 weeks ago

Custom logback-spring.xml config:

<configuration>
  <include resource="org/springframework/boot/logging/logback/base.xml"/>

  <appender name="JSON_CONSOLE" class="net.logstash.logback.appender.LoggingEventCompositeJsonEncoder">
    <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
      <providers>
        <timestamp>
          <fieldName>@timestamp</fieldName>
        </timestamp>
        <logLevel />
        <loggerName />
        <threadName />
        <message />
        <mdc />
      </providers>
    </encoder>
  </appender>

  <root level="INFO">
    <appender-ref ref="JSON_CONSOLE" />
  </root>
</configuration>

Type	New Feature
Priority	Normal
Assignee	rk@tigase.net
Version	none
Sprints	n/a
Customer	n/a

Enable Structured JSON Logging for Observability

Task Breakdown

1. Choose Logging Framework

2. Configure JSON Log Output

3. Enable MDC Context Logging

4. Profile-Based Logging Levels

5. Output Verification

🕒 Estimated Time: 3–4 hours

Subtask Estimates

Output Artifacts