agentleFS
Sign inStart free
jabrenajabrena/cursor-rules-java/skills/181-java-observability-logging/SKILL.md

181-java-observability-logging

Skill452 starsChanged 3 months agoApache-2.0View on GitHub

Use when you need to implement or improve Java logging and observability — including selecting SLF4J with Logback/Log4j2, applying proper log levels (ERROR, WARN, INFO, DEBUG, TRACE), parameterized logging, correlation context, secure logging without sensitive data exposure, environment-specific configuration, log aggregation, monitoring, and alerting. This should trigger for requests such as Improve logging; Apply logging; Refactor logging; Add logging support; Review SLF4J structured logging in Java code. Part of Plinth Toolkit

We split this skill into the rules it gives an agent

8 rules. About 0 are common, 3 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Before applying any logging recommendations, ensure the project compiles.

    line 26
  2. Very specific:

    MANDATORY: Run ./mvnw compile or mvn compile before applying any change

    line 28
  3. Distinctive:

    SAFETY: If compilation fails, stop immediately — do not proceed until resolved

    line 29
  4. Very specific:

    VERIFY: Run ./mvnw clean verify or mvn clean verify after applying improvements

    line 30
  5. Distinctive:

    BEFORE APPLYING: Read the reference for detailed good/bad examples, constraints, and safeguards for each logging pattern

    line 31
  6. Very specific:

    Run ./mvnw compile or mvn compile and stop immediately if compilation fails.

    line 45
  7. Very specific:

    Read references/181-java-observability-logging.md and evaluate framework usage, log levels, sensitive-data handling, and config gaps.

    line 49
  8. Very specific:

    Run ./mvnw clean verify or mvn clean verify after applying improvements.

    line 57

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Java Logging Best Practices

Implement effective Java logging following standardized frameworks, meaningful log levels, core practices (parameterized logging, exception handling, no sensitive data), explicit correlation context, flexible configuration, security-conscious logging, monitoring, and alerting.

What is covered in this Skill?

  • Standardized framework selection: SLF4J facade with Logback or Log4j2
  • Meaningful and consistent log levels: ERROR, WARN, INFO, DEBUG, TRACE
  • Core practices: parameterized logging, proper exception handling, avoiding sensitive data
  • Configuration: environment-specific (logback.xml, log4j2.xml), output formats, log rotation
  • Security: mask sensitive data, control log access, secure transmission, GDPR/HIPAA compliance
  • Log monitoring and alerting: centralized aggregation (ELK, Splunk, Loki), automated alerts

Scope: The reference is organized by examples (good/bad code patterns) for each core area. Apply recommendations based on applicable examples.

Constraints

Before applying any logging recommendations, ensure the project compiles. Compilation failure is a blocking condition. After applying improvements, run full verification.

  • MANDATORY: Run ./mvnw compile or mvn compile before applying any change
  • SAFETY: If compilation fails, stop immediately — do not proceed until resolved
  • VERIFY: Run ./mvnw clean verify or mvn clean verify after applying improvements
  • BEFORE APPLYING: Read the reference for detailed good/bad examples, constraints, and safeguards for each logging pattern

When to use this skill

  • Improve logging
  • Apply logging
  • Refactor logging
  • Add logging support
  • Review SLF4J structured logging in Java code

Workflow

  1. Compile project before logging changes

Run ./mvnw compile or mvn compile and stop immediately if compilation fails.

  1. Read logging reference and assess current observability

Read references/181-java-observability-logging.md and evaluate framework usage, log levels, sensitive-data handling, and config gaps.

  1. Apply logging and observability improvements

Implement selected framework/configuration/practice changes, including secure logging and monitoring integration where applicable.

  1. Verify with full build

Run ./mvnw clean verify or mvn clean verify after applying improvements.

Reference

For detailed guidance, examples, and constraints, see references/181-java-observability-logging.md.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free