Skip to content

Commit

Permalink
rename
Browse files Browse the repository at this point in the history
  • Loading branch information
q3769 committed Mar 21, 2023
1 parent 372ebb8 commit 8db5b1f
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 28 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# elf4j-impl
# elf4j-provider

A native log service provider implementation of [ELF4J](https://github.com/elf4j/elf4j) (Easy Logging Facade for Java),
and a complete drop-in logging solution for any Java application
A native log _service provider_ implementation of [ELF4J](https://github.com/elf4j/elf4j) (Easy Logging Facade for
Java), and a complete drop-in logging solution for any Java application

## User Story

As an application developer using ELF4J for logging, I want to have the option of using a runtime log service
provider that natively implements the [API and SPI](https://github.com/elf4j/elf4j#service-interface-and-access-api) of
As an application developer using the ELF4J logging facade, I want to have the option of using a runtime log _service
provider_ that natively implements the [API and SPI](https://github.com/elf4j/elf4j#service-interface-and-access-api) of
ELF4J.

## Prerequisite
Expand All @@ -17,9 +17,9 @@ Java 8 or better

* Guiding principle: Reasonable default and Pareto's 80/20 rule

* This is simply a packaging unit of the [elf4j-impl-core](https://github.com/elf4j/elf4j-impl-core) logging library,
using the Java [Service Provider Framework](https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html)
mechanism. See [elf4j-impl-core](https://github.com/elf4j/elf4j-impl-core) for implementation detail.
* This is simply a packaging unit of the [elf4j-engine](https://github.com/elf4j/elf4j-engine), using the
Java [Service Provider Framework](https://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html) mechanism.
See [elf4j-engine](https://github.com/elf4j/elf4j-engine) for implementation details.

## Features

Expand Down Expand Up @@ -50,7 +50,7 @@ Java 8 or better

## Get It...

[![Maven Central](https://img.shields.io/maven-central/v/io.github.elf4j/elf4j-impl.svg?label=Maven%20Central)](https://central.sonatype.com/search?smo=true&q=pkg%253Amaven%252Fio.github.elf4j%252Felf4j-impl)
[![Maven Central](https://img.shields.io/maven-central/v/io.github.elf4j/elf4j-provider.svg?label=Maven%20Central)](https://central.sonatype.com/search?smo=true&q=pkg%253Amaven%252Fio.github.elf4j%252Felf4j-provider)

## Use It...

Expand All @@ -67,7 +67,7 @@ this provider implementation as a runtime-scope dependency in Maven or other bui
</dependency>
<dependency>
<groupId>io.github.elf4j</groupId>
<artifactId>elf4j-impl</artifactId>
<artifactId>elf4j-provider</artifactId>
<scope>runtime</scope>
</dependency>
...
Expand All @@ -76,7 +76,7 @@ this provider implementation as a runtime-scope dependency in Maven or other bui
In case of multiple ELF4J service providers in classpath, pick this one like so:

```
java -Delf4j.logger.factory.fqcn="elf4j.impl.core.NativeLoggerFactory" MyApplication
java -Delf4j.logger.factory.fqcn="elf4j.engine.NativeLoggerFactory" MyApplication
```

More details [here](https://github.com/elf4j/elf4j#no-op-by-default).
Expand Down Expand Up @@ -129,11 +129,11 @@ See ELF4J facade [usage sample](https://github.com/elf4j/elf4j#for-logging-servi
* Output samples
* Line-based Default
```
2023-03-14T21:21:33.118-05:00 INFO [main] elf4j.impl.core.IntegrationTest$defaultLogger - Hello, world!
2023-03-14T21:21:33.118-05:00 INFO [main] elf4j.provider.core.IntegrationTest$defaultLogger - Hello, world!
```
* JSON Default (one-line, minified, no thread or caller detail)
```json
{"timestamp":"2023-03-14T21:21:33.1180212-05:00","level":"INFO","callerClass":"elf4j.impl.core.IntegrationTest$defaultLogger","message":"Hello, world!"}
{"timestamp":"2023-03-14T21:21:33.1180212-05:00","level":"INFO","callerClass":"elf4j.providerider.core.IntegrationTest$defaultLogger","message":"Hello, world!"}
```
* JSON Custom (pretty print, with thread and caller detail)
```json
Expand All @@ -145,7 +145,7 @@ See ELF4J facade [usage sample](https://github.com/elf4j/elf4j#for-logging-servi
"id": 1
},
"callerDetail": {
"className": "elf4j.impl.core.IntegrationTest$defaultLogger",
"className": "elf4j.providerider.core.IntegrationTest$defaultLogger",
"methodName": "hey",
"lineNumber": 41,
"fileName": "IntegrationTest.java"
Expand All @@ -164,7 +164,7 @@ See ELF4J facade [usage sample](https://github.com/elf4j/elf4j#for-logging-servi
### This override the default global level
level=info
### These override level of all caller classes included the specified package
#level@elf4j.impl=error
#level@elf4j.providerider=error
level@org.springframework=warn
### Any writer is optional, default to a single standard writer if no writer configured
writer1=standard
Expand Down
16 changes: 8 additions & 8 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -30,27 +30,27 @@
<modelVersion>4.0.0</modelVersion>

<groupId>io.github.elf4j</groupId>
<artifactId>elf4j-impl</artifactId>
<version>1.0.1</version>
<artifactId>elf4j-provider</artifactId>
<version>2.0.0</version>
<packaging>jar</packaging>
<name>elf4j-impl</name>
<name>elf4j-provider</name>
<description>Native logging service provider implementation of ELF4J (Easy Logging Facade For Java)
</description>

<url>https://github.com/elf4j/elf4j-impl</url>
<url>https://github.com/elf4j/elf4j-provider</url>
<licenses>
<license>
<name>MIT License</name>
<url>http://www.opensource.org/licenses/mit-license.php</url>
</license>
</licenses>
<scm>
<url>https://github.com/elf4j/elf4j-impl/tree/main</url>
<url>https://github.com/elf4j/elf4j-provider/tree/main</url>
<connection>
scm:git:git://github.com:elf4j/elf4j-impl.git
scm:git:git://github.com:elf4j/elf4j-provider.git
</connection>
<developerConnection>
scm:git:ssh://github.com:elf4j/elf4j-impl.git
scm:git:ssh://github.com:elf4j/elf4j-provider.git
</developerConnection>
</scm>
<developers>
Expand All @@ -67,7 +67,7 @@
<dependencies>
<dependency>
<groupId>io.github.elf4j</groupId>
<artifactId>elf4j-impl-core</artifactId>
<artifactId>elf4j-engine</artifactId>
<version>1.0.0</version>
</dependency>
<dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@
#
#

elf4j.impl.core.NativeLoggerFactory
elf4j.engine.NativeLoggerFactory
#elf4j.util.NoopLoggerFactory
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@
*
*/

package elf4j.impl;
package elf4j.provider;

import elf4j.Logger;
import elf4j.impl.core.NativeLogger;
import elf4j.engine.NativeLogger;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
*
*/

package elf4j.impl;
package elf4j.provider;

import elf4j.Logger;
import org.junit.jupiter.api.Nested;
Expand Down
1 change: 0 additions & 1 deletion src/test/resources/elf4j-test.properties
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
### This override the default global level
level=info
### These override level of all caller classes included the specified package
#level@elf4j.impl=error
level@org.springframework=warn
### Any writer is optional, default to a single standard writer if no writer configured
writer1=standard
Expand Down

0 comments on commit 8db5b1f

Please sign in to comment.