Skip to content

Commit

Permalink
Update README.adoc
Browse files Browse the repository at this point in the history 
added contributing guideline and turned huge lists into tables
  • Loading branch information
@ronja-ui
ronja-ui authored Jan 9, 2024
1 parent 6beeaeb commit ea3ff95
Showing 1 changed file with 88 additions and 44 deletions.
132 changes: 88 additions & 44 deletions README.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
= Java Util Logging RELP Handler
[![Build Status](https://scan.coverity.com/projects/23156/badge.svg)](https://scan.coverity.com/projects/jla_04)

image::https://scan.coverity.com/projects/23156/badge.svg[Build Status, link="https://scan.coverity.com/projects/jla_04"]

Creates Java Util Logging handler that uses RELP to ensure no events are lost.

Expand All @@ -16,15 +17,13 @@ this limitation.

First download wanted versions of jla_04, rlp_01 and syslog-java-client from the following urls:

https://search.maven.org/artifact/com.teragrep/jla_04[jla_04]

https://search.maven.org/artifact/com.teragrep/rlp_01[rlp_01]

https://search.maven.org/artifact/com.cloudbees/syslog-java-client[syslog-java-client]

* https://search.maven.org/artifact/com.teragrep/jla_04[jla_04]
* https://search.maven.org/artifact/com.teragrep/rlp_01[rlp_01]
* https://search.maven.org/artifact/com.cloudbees/syslog-java-client[syslog-java-client]

Configuration file, see xref:README.adoc#Supported logging.properties file
directives[logging.properties file directives] for explanation of the keys.

[source,properties]
----
handlers=com.teragrep.jla_04.RelpHandler
Expand Down Expand Up @@ -57,50 +56,74 @@ available for programs which are not modified to support them because of Java
Util Logging (JUL) limitation. JUL supports only one handler of a handler
type via external configuration file.


=== Supported system properties
* com.teragrep.jla_04.RelpHandler.LOGGERNAME.hostname
** Stream hostname identifier.Maximum length of 255 characters, limited by RFC5424
* com.teragrep.jla_04.RelpHandler.LOGGERNAME.appname
** Stream application identifier.Maximum length of 48 characters, limited by RFC5424
* com.teragrep.jla_04.RelpHandler.LOGGERNAME.server.address
** Connection destination address
* com.teragrep.jla_04.RelpHandler.LOGGERNAME.server.connectionTimeout
** Time to wait before timing out connection
* com.teragrep.jla_04.RelpHandler.LOGGERNAME.server.port
** Connection destination port
* com.teragrep.jla_04.RelpHandler.LOGGERNAME.server.readTimeout
** Time to wait for destination to acknowledge sent data (low values cause duplicates)
* com.teragrep.jla_04.RelpHandler.LOGGERNAME.server.reconnectInterval
** Time to wait between re-connection attempts
* com.teragrep.jla_04.RelpHandler.LOGGERNAME.server.writeTimeout
** Time to wait for destination to accept data
* com.teragrep.jla_04.RelpHandler.LOGGERNAME.useStructuredData
** Enables structured data containing uuid and source information

|===
|Property |Description

|com.teragrep.jla_04.RelpHandler.LOGGERNAME.hostname
|Stream hostname identifier.Maximum length of 255 characters, limited by RFC5424

|com.teragrep.jla_04.RelpHandler.LOGGERNAME.appname
|Stream application identifier.Maximum length of 48 characters, limited by RFC5424

|com.teragrep.jla_04.RelpHandler.LOGGERNAME.server.address
|Connection destination address

|com.teragrep.jla_04.RelpHandler.LOGGERNAME.server.connectionTimeout
|Time to wait before timing out connection

|com.teragrep.jla_04.RelpHandler.LOGGERNAME.server.port
|Connection destination port

|com.teragrep.jla_04.RelpHandler.LOGGERNAME.server.readTimeout
|Time to wait for destination to acknowledge sent data (low values cause duplicates)

|com.teragrep.jla_04.RelpHandler.LOGGERNAME.server.reconnectInterval
|Time to wait between re-connection attempts

|com.teragrep.jla_04.RelpHandler.LOGGERNAME.server.writeTimeout
|Time to wait for destination to accept data

|com.teragrep.jla_04.RelpHandler.LOGGERNAME.useStructuredData
|Enables structured data containing uuid and source information
|===

=== Supported logging.properties file directives

Default logger has LOGGERNAME "default" which is the only one available
without code modifications.

* java.util.logging.RelpHandler.LOGGERNAME.hostname
** Stream hostname identifier.Maximum length of 255 characters, limited by RFC5424
* java.util.logging.RelpHandler.LOGGERNAME.appname
** Stream application identifier.Maximum length of 48 characters, limited by RFC5424
* java.util.logging.RelpHandler.LOGGERNAME.server.address
** Connection destination address
* java.util.logging.RelpHandler.LOGGERNAME.server.connectionTimeout
** Time to wait before timing out connection
* java.util.logging.RelpHandler.LOGGERNAME.server.port
** Connection destination port
* java.util.logging.RelpHandler.LOGGERNAME.server.readTimeout
** Time to wait for destination to acknowledge sent data (low values cause duplicates)
* java.util.logging.RelpHandler.LOGGERNAME.server.reconnectInterval
** Time to wait between re-connection attempts
* java.util.logging.RelpHandler.LOGGERNAME.server.writeTimeout
** Time to wait for destination to accept data
* java.util.logging.RelpHandler.LOGGERNAME.useStructuredData
** Enables structured data containing uuid and source information
|===
|Property |Description

|java.util.logging.RelpHandler.LOGGERNAME.hostname
|Stream hostname identifier.Maximum length of 255 characters, limited by RFC5424

|java.util.logging.RelpHandler.LOGGERNAME.appname
|Stream application identifier.Maximum length of 48 characters, limited by RFC5424

|java.util.logging.RelpHandler.LOGGERNAME.server.address
|Connection destination address

|java.util.logging.RelpHandler.LOGGERNAME.server.connectionTimeout
|Time to wait before timing out connection

|java.util.logging.RelpHandler.LOGGERNAME.server.port
|Connection destination port

|java.util.logging.RelpHandler.LOGGERNAME.server.readTimeout
|Time to wait for destination to acknowledge sent data (low values cause duplicates)

|java.util.logging.RelpHandler.LOGGERNAME.server.reconnectInterval
|Time to wait between re-connection attempts

|java.util.logging.RelpHandler.LOGGERNAME.server.writeTimeout
|Time to wait for destination to accept data

|java.util.logging.RelpHandler.LOGGERNAME.useStructuredData
|Enables structured data containing uuid and source information
|===

=== Passing properties file

Expand Down Expand Up @@ -147,3 +170,24 @@ logger.severe("Severe message");
<version>%VERSION%</version>
</dependency>
----

== Contributing

// Change the repository name in the issues link to match with your project's name

You can involve yourself with our project by https://github.com/teragrep/jla_04/issues/new/choose[opening an issue] or submitting a pull request.

Contribution requirements:

. *All changes must be accompanied by a new or changed test.* If you think testing is not required in your pull request, include a sufficient explanation as why you think so.
. Security checks must pass
. Pull requests must align with the principles and http://www.extremeprogramming.org/values.html[values] of extreme programming.
. Pull requests must follow the principles of Object Thinking and Elegant Objects (EO).

Read more in our https://github.com/teragrep/teragrep/blob/main/contributing.adoc[Contributing Guideline].

=== Contributor License Agreement

Contributors must sign https://github.com/teragrep/teragrep/blob/main/cla.adoc[Teragrep Contributor License Agreement] before a pull request is accepted to organization's repositories.

You need to submit the CLA only once. After submitting the CLA you can contribute to all Teragrep's repositories.

0 comments on commit ea3ff95

Please sign in to comment.