https://github.com/friskisgit/no4j-logger
Simple dependency-less logger
https://github.com/friskisgit/no4j-logger
java lightweight logger logging logging-library simple
Last synced: 12 months ago
JSON representation
Simple dependency-less logger
- Host: GitHub
- URL: https://github.com/friskisgit/no4j-logger
- Owner: FriskIsGit
- License: mit
- Created: 2024-01-17T16:47:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-09T17:27:00.000Z (about 1 year ago)
- Last Synced: 2025-05-16T21:14:54.237Z (about 1 year ago)
- Topics: java, lightweight, logger, logging, logging-library, simple
- Language: Java
- Homepage:
- Size: 115 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# No4J
## Simple logging library with sane defaults
### Supports:
- Level hierarchy, including custom levels
- Console output separation between STDERR and STDOUT depending on severity
- File output
- Rolling appender with file compression
- Basic inheritance
- ANSI color printing
- Logging per site as an extension
### Configuration and properties
The configuration file follows **INI** format:
```ini
[symbolic-name]
name = org.some.package
level = ERROR
msg_length = 10000
date_zone = UTC+6
file_out = main.package.log
file_enabled = true
file_rolling_size=1048576
file_rolling_enabled=false
[mongodb]
name = org.nosql.impl
inherit = main.package
```
Each logger declaration has its own symbolic name enclosed in square brackets.
Every `key` is followed by `=` followed by `value`. Two key-value pairs are not allowed on the same line.
Values are not enclosed in quotation marks. Comments are allowed but must be preceded with a `#`.
The order of declarations does not matter. Inheritance occurs once all loggers are configured, and it is performed in no particular order.
The config file `no4j.ini` must be in the root directory of the project or in `src/main/resources`.
Properties such as file output path are excluded from inheritance to prevent collisions.
### Configuration keys:
| Key | Meaning | Default value | Type |
|:------------------------|:---------------------------------------:|:----------------------:|:-----------------:|
| `name` | _logger name_ | | String |
| `level` | _logging level_ | OFF | Level |
| `msg_length` | _cap log message length_ | Integer.MAX_Value - 32 | int |
| `msg_method` | _include method in log message_ | true | boolean |
| `msg_line_number` | _include line number in log message_ | true | boolean |
| `msg_package` | _include package prefix in log message_ | false | boolean |
| `msg_stack_trace_depth` | _max stack trace depth in log message_ | 64 | int |
| `stderr_level` | _STDERR logging level_ | ERROR | Level |
| `file_out` | _log file path_ | null | Path |
| `file_rolling_size` | _file size to reach before rolling_ | 4194304 | Long |
| `file_enabled` | _write to file_ | false | boolean |
| `file_rolling_enabled` | _roll log files_ | false | boolean |
| `console_enabled` | _write to console_ | true | boolean |
| `date_pattern` | _date format pattern_ | yyyy-MM-dd HH:mm:ss | DateTimeFormatter |
| `date_zone` | _UTC/GMT/UT zone_ | UTC+0 | ZoneId |
| `inherit` | _symbolic logger name to inherit from_ | N/A | N/A |
### Initializing by loading the configuration file
```java
import no4j.core.No4JConfiguration;
class Test {
public static void main(String[] args) {
try {
No4JConfiguration.configure();
} catch (IOException e) {
/* Handle exception */
}
}
}
```
### Configuring programmatically
```java
import no4j.core.FileAppender;
import no4j.core.Level;
import no4j.core.Logger;
import no4j.extensions.LoggerBuilder;
class Test {
public static void main(String[] args) {
Logger log = LoggerBuilder.error("main.package")
.file("main.package.log")
.rollAtMegabytes(2)
.maxMessageLength(5000)
.getLogger();
// USAGE
log.debug("DEBUG");
log.info("INFO");
log.warn("WARNING");
log.fatal("FATAL");
log.unreachable("UNREACHABLE");
log.exception(new RuntimeException("Exception thrown!"));
}
}
```
### ANSI color support
**Generally supported within all Linux terminals**
Windows `cmd` or `powershell` generally do not support ANSI.
It is possible to enable ANSI in Windows 10 and later by creating a DWORD(32-bit) `VirtualTerminalLevel` with value `1`
at `HKEY_CURRENT_USER\Console` in registry
**Alternative terminals for Windows that support ANSI**
- Git Bash
- Cmder
- IntelliJ console
## Jitpack import
### Maven
```xml
com.github.FriskIsGit
no4j-logger
main-SNAPSHOT
```
By default, all POMs implicitly inherit from a super-POM:
https://maven.apache.org/ref/3.0.4/maven-model-builder/super-pom.html
When an external repository is specified the default repository needs to be respecified:
```xml
jitpack.io
https://jitpack.io
central
Central Repository
https://maven.org/maven2
```
### Gradle
Include at root level in build.gradle at the end of repositories:
```groovy
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
mavenCentral()
maven { url 'https://jitpack.io' }
}
}
```
Add the dependency:
```groovy
dependencies {
implementation 'com.github.FriskIsGit:no4j-logger:main-SNAPSHOT'
}
```