DEV Community

Cover image for My project on github.
OptiJava
OptiJava

Posted on • Edited on

My project on github.

Optilog-Client

中文

This is an open source logging framework written in Java language. It has more advantages than other open source logging frameworks (such as log4j and slf4j).

The wiki of Optilog will be updated at any time. Problems or bugs will be raised on issues or discussions.

Be sure to read the wiki of this project before using it.

If you like, you are welcome to contribute to Optilog through fork. The code of this project is quite basic, and anyone can contribute.

Optilog advantages

0.Frequent updates(log4j and slf4j have no update since 2017..)

  1. high performance: After initialization, another log (output to the screen + output to a file + output to the server through socket) can be output as fast as 8 milliseconds (it will be optimized later). Log4j should be at least 41 milliseconds.

  2. Placeholder convenience: optilog supports unlimited placeholders and can be reused (#1 #1 outputs the first placeholder twice). Log4j only supports 9 placeholders.

  3. Configuration file can be placed in any location. The name of the configuration file is unlimited. Two types of configuration files are supported. In log4j, the configuration file can only be in classpath and the name can only be log4j2 xml.

  4. Support the client to send logs to Server.

  5. All possible exceptions in Optilog are basically captured without affecting the main logic.

  6. You only need one jar package, and you can use it directly by typing in the classpath (I don't know the feeling of adding dozens of jar packages at once when using gradle).

  7. Suitable for beginners without complex configuration files.

  8. Few dependence.

  9. Class, method and other information output in the log are absolutely accurate, because Optilog uses StackTraceElement internally to determine these information, and there is no need to write the class instance when initializing the log.

  10. Optilog can directly generate a default configuration file. Beginners do not need to look for the configuration file example (Tutorial).

  11. Support configuration files in multiple formats, including JSON, yaml, XML and properties. Support for .toml configuration files will be added later.

  12. Optilog supports configuration modification during runtime. Of course, only some configuration items of true and false can be modified. Output file paths cannot be modified.

  13. Support outputting logs to JDBC.

Optilog log picture:

image
Generate by carbon.now.sh

Dependency:

com.google.code.gson:gson:2.9.0
\
com.fasterxml.jackson.dataformat:jackson-dataformat-xml:2.13.3
\
org.yaml:snakeyaml:1.30 mysql:mysql-connector-java:8.0.29
\
mysql:mysql-connector-java:8.0.29
\
(You needn't add dependency if you don't use these function.)

Contributor:

JavauserO

Future plans

realize remote call

Top comments (14)

Collapse
 
dagnelies profile image
Arnaud Dagnelies • Edited

Oh no! ... Please not yet another logging framework for Java! One of the most widespread issue with Java is that multiple Logging frameworks coexist and the community is fragmented, leading to all kind of complications. I guess this additional library would add one more brick to this disaster. Sorry.

I'm sure your talent could be spent on more useful things.

Collapse
 
optijava profile image
OptiJava

You're right. I didn't think about this before.But I want to ask what exactly does complications mean?

Collapse
 
dagnelies profile image
Arnaud Dagnelies • Edited

One must be aware that the logging is not only done by your own code, but also by all the third party libraries used. Everyone logs stuff, using different logging frameworks, and yet you need your logging configuration to apply to all of them. If I change my logging level from WARN to DEBUG, I want all libs to pick it up, and not have one dependency ignore it because it uses a separate logging which requires its own distinct config.

Thread Thread
 
optijava profile image
OptiJava

I understand what you mean.If a dependency use logging framework A,but my project use logging framework B.If I want to apply my configuration to all dependency and my project,I have to create many configure files for all logging framework.
Thanks.

Thread Thread
 
201206030 profile image
xxyopen

As long as only the SLF4J API is used in the Java code, there will be no such problems

Collapse
 
201206030 profile image
xxyopen

I think it's not a big problem as long as the specification of SLF4J is implemented

Collapse
 
optijava profile image
OptiJava

I have an immature idea.
I think the most big question is configuration, i can let Optilog control other logging framework's configuration.When you write Optilog's config file,Optilog auto generate configure file that other logging framework need(in runtime),that config is same as Optilog's configure file.If you change configure file,Optilog will change the configure file for other logging framework.
Maybe this idea is unrealistic...

Thread Thread
 
dagnelies profile image
Arnaud Dagnelies

Instead of making your logging library, I would ask two questions:

  • Why do we need yet another logging library?
  • Cannot we rather contribute to the existing ones?
Thread Thread
 
optijava profile image
OptiJava

First,because I want to make a better logging framework,that doesn't mean I think they are too bad.They have some problems.
problem example:
public class Test {
public static Logger log = LoggerFactory.getLogger(Test.class);
public static void main(String[] args) {
log.info("test in Test");
test2.t(log);
}
}
class test2 {
public static void t(Logger logger) {
logger.info("test in test2");
}
}

console:
[main] INFO com.test.Test - test in Test
[main] INFO com.test.Test - test in test2

Why second log in class test2 print class:com.test.Test?

I once want to contribute these logging framework.But if you see their pull request,you will know they will not access you.
github.com/qos-ch/slf4j/pulls
github.com/apache/logging-log4j2/p...

Collapse
 
201206030 profile image
xxyopen

It's not that we don't need to innovate when we have it on the market. Sometimes the existing framework can't meet our needs.

Collapse
 
201206030 profile image
xxyopen

Brother, support you, you can also add Chinese descriptions in the project about, so that Chinese brothers can also search for it

Collapse
 
optijava profile image
OptiJava

Thanks.There is Chinese description on my github.
github.com/OptiJava/Optilog-Client

Collapse
 
201206030 profile image
xxyopen • Edited

No, I mean project about, it's where the GitHub search engine takes into account, like github.com/alibaba/GraphScope

Thread Thread
 
optijava profile image
OptiJava • Edited

I see.It's a good idea.