io microsphere logging log4j2 Log4j2Logger

Log4j2Logger

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

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

Overview

The Logger adapter class based Log4j2 Logger

Declaration

class Log4j2Logger extends AbstractLogger implements DelegatingWrapper

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

isTraceEnabled

Log4j2Logger logger = new Log4j2Logger("io.microsphere");

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  if (logger.isTraceEnabled()) {
    logger.trace("trace message");
  }

trace

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.trace("entering method foo");

trace

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.trace("trace with exception", new RuntimeException("cause"));

isDebugEnabled

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  if (logger.isDebugEnabled()) {
    logger.debug("debug message");
  }

debug

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.debug("processing item: {}", item);

debug

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.debug("debug with exception", new RuntimeException("cause"));

isInfoEnabled

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  if (logger.isInfoEnabled()) {
    logger.info("application started");
  }

info

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.info("application started");

info

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.info("info with exception", new RuntimeException("cause"));

isWarnEnabled

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  if (logger.isWarnEnabled()) {
    logger.warn("low memory");
  }

warn

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.warn("unexpected configuration value");

warn

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.warn("warn with exception", new RuntimeException("cause"));

isErrorEnabled

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  if (logger.isErrorEnabled()) {
    logger.error("operation failed");
  }

error

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.error("operation failed");

error

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.error("error with exception", new RuntimeException("cause"));

getDelegate

Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  org.apache.logging.log4j.Logger delegate = (org.apache.logging.log4j.Logger) logger.getDelegate();

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.Log4j2Logger;

API Reference

Public Methods

Method	Description
isTraceEnabled	Creates a new Log4j2Logger for the given logger name.
trace	{@inheritDoc}
trace	{@inheritDoc}
isDebugEnabled	{@inheritDoc}
debug	{@inheritDoc}
debug	{@inheritDoc}
isInfoEnabled	{@inheritDoc}
info	{@inheritDoc}
info	{@inheritDoc}
isWarnEnabled	{@inheritDoc}
warn	{@inheritDoc}
warn	{@inheritDoc}
isErrorEnabled	{@inheritDoc}
error	{@inheritDoc}
error	{@inheritDoc}
getDelegate	Returns the underlying Log4j2 Logger delegate.

Method Details

isTraceEnabled

public boolean isTraceEnabled()

Creates a new Log4j2Logger for the given logger name.

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
`

trace

public void trace(String message)

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.trace("entering method foo");
`

trace

public void trace(String message, Throwable t)

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.trace("trace with exception", new RuntimeException("cause"));
`

isDebugEnabled

public boolean isDebugEnabled()

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  if (logger.isDebugEnabled()) {
    logger.debug("debug message");
  `
}

debug

public void debug(String message)

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.debug("processing item: {`", item);
}

debug

public void debug(String message, Throwable t)

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.debug("debug with exception", new RuntimeException("cause"));
`

isInfoEnabled

public boolean isInfoEnabled()

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  if (logger.isInfoEnabled()) {
    logger.info("application started");
  `
}

info

public void info(String message)

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.info("application started");
`

info

public void info(String message, Throwable t)

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.info("info with exception", new RuntimeException("cause"));
`

isWarnEnabled

public boolean isWarnEnabled()

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  if (logger.isWarnEnabled()) {
    logger.warn("low memory");
  `
}

warn

public void warn(String message)

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.warn("unexpected configuration value");
`

warn

public void warn(String message, Throwable t)

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.warn("warn with exception", new RuntimeException("cause"));
`

isErrorEnabled

public boolean isErrorEnabled()

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  if (logger.isErrorEnabled()) {
    logger.error("operation failed");
  `
}

error

public void error(String message)

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.error("operation failed");
`

error

public void error(String message, Throwable t)

{@inheritDoc}

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  logger.error("error with exception", new RuntimeException("cause"));
`

getDelegate

public Object getDelegate()

Returns the underlying Log4j2 Logger delegate.

Example Usage

`Log4j2Logger logger = new Log4j2Logger("io.microsphere");
  org.apache.logging.log4j.Logger delegate = (org.apache.logging.log4j.Logger) logger.getDelegate();
`

See Also

• AbstractLogger
• Logger

---

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