io microsphere logging log4j2 Log4j2Logging

Log4j2Logging

Type: Class | Module: microsphere-log4j2 | Package: io.microsphere.logging.log4j2 | Since: 1.0.0

Source: microsphere-log4j2/src/main/java/io/microsphere/logging/log4j2/Log4j2Logging.java

Overview

Logging class based on the log4j2 framework.

Declaration

public class Log4j2Logging implements Logging

Author: Mercy

Version Information

• Introduced in: 1.0.0
• Current Project Version: 0.1.14-SNAPSHOT

Version Compatibility

This component is tested and compatible with the following Java versions:

Java Version	Status
Java 8	✅ Compatible
Java 11	✅ Compatible
Java 17	✅ Compatible
Java 21	✅ Compatible
Java 25	✅ Compatible

Examples

Method Examples

getRootLoggerName

Log4j2Logging logging = new Log4j2Logging();
  String rootName = logging.getRootLoggerName();
  // returns ""

getLoggerNames

Log4j2Logging logging = new Log4j2Logging();
  List<String> names = logging.getLoggerNames();

getSupportedLoggingLevels

Log4j2Logging logging = new Log4j2Logging();
  Set<String> levels = logging.getSupportedLoggingLevels();
  // e.g. ["OFF", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE", "ALL"]

getLoggerLevel

Log4j2Logging logging = new Log4j2Logging();
  String level = logging.getLoggerLevel("io.microsphere");
  // e.g. "INFO"

setLoggerLevel

Log4j2Logging logging = new Log4j2Logging();
  logging.setLoggerLevel("io.microsphere", "DEBUG");

getName

Log4j2Logging logging = new Log4j2Logging();
  String name = logging.getName();
  // returns "Log4j2"

getPriority

Log4j2Logging logging = new Log4j2Logging();
  int priority = logging.getPriority();
  // returns Log4j2Logging.PRIORITY

Usage

Maven Dependency

Add the following dependency to your pom.xml:

<dependency>
    <groupId>io.github.microsphere-projects</groupId>
    <artifactId>microsphere-log4j2</artifactId>
    <version>${microsphere-logging.version}</version>
</dependency>

Tip: Use the BOM (microsphere-logging-dependencies) for consistent version management. See the Getting Started guide.

Import

import io.microsphere.logging.log4j2.Log4j2Logging;

API Reference

Public Methods

Method	Description
getRootLoggerName	The priority of Log4j2Logging
getLoggerNames	{@inheritDoc}
getSupportedLoggingLevels	{@inheritDoc}
getLoggerLevel	{@inheritDoc}
setLoggerLevel	{@inheritDoc}
getName	{@inheritDoc}
getPriority	{@inheritDoc}

Method Details

getRootLoggerName

public String getRootLoggerName()

The priority of Log4j2Logging / public static final int PRIORITY = NORMAL_PRIORITY - 5;

/** All Logging Levels : "OFF", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE", "ALL"

getLoggerNames

public List<String> getLoggerNames()

{@inheritDoc}

Example Usage

`Log4j2Logging logging = new Log4j2Logging();
  List names = logging.getLoggerNames();
`

getSupportedLoggingLevels

public Set<String> getSupportedLoggingLevels()

{@inheritDoc}

Example Usage

`Log4j2Logging logging = new Log4j2Logging();
  Set levels = logging.getSupportedLoggingLevels();
  // e.g. ["OFF", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE", "ALL"]
`

getLoggerLevel

public String getLoggerLevel(String loggerName)

{@inheritDoc}

Example Usage

`Log4j2Logging logging = new Log4j2Logging();
  String level = logging.getLoggerLevel("io.microsphere");
  // e.g. "INFO"
`

setLoggerLevel

public void setLoggerLevel(String loggerName, String levelName)

{@inheritDoc}

Example Usage

`Log4j2Logging logging = new Log4j2Logging();
  logging.setLoggerLevel("io.microsphere", "DEBUG");
`

getName

public String getName()

{@inheritDoc}

Example Usage

`Log4j2Logging logging = new Log4j2Logging();
  String name = logging.getName();
  // returns "Log4j2"
`

getPriority

public int getPriority()

{@inheritDoc}

Example Usage

`Log4j2Logging logging = new Log4j2Logging();
  int priority = logging.getPriority();
  // returns Log4j2Logging.PRIORITY
`

See Also

• Logging

---

This documentation was auto-generated from the source code of microsphere-logging.