https://github.com/teragrep/jla_01
Teragrep RELP plugin for Logback
https://github.com/teragrep/jla_01
java log log-management logback logback-appender logger relp relp-client syslog syslog-client teragrep
Last synced: 29 days ago
JSON representation
Teragrep RELP plugin for Logback
- Host: GitHub
- URL: https://github.com/teragrep/jla_01
- Owner: teragrep
- License: apache-2.0
- Created: 2021-02-22T11:12:21.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-03T19:16:59.000Z (5 months ago)
- Last Synced: 2025-03-29T15:02:09.966Z (about 2 months ago)
- Topics: java, log, log-management, logback, logback-appender, logger, relp, relp-client, syslog, syslog-client, teragrep
- Language: Java
- Homepage: https://teragrep.com
- Size: 88.9 KB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
image::https://scan.coverity.com/projects/22709/badge.svg[link=https://scan.coverity.com/projects/jla_01]
== RELP Logging plugin for Logback
See link:https://github.com/teragrep/jla_01/blob/master/src/main/resources/logback.example.xml[logback.example.xml] for example config
== Parameters
|===
|Parameter |Description | Default
|`relpHostAddress`
|Connection destination address
|127.0.0.1
|`relpPort`
|Connection destination port
|601
|`enableEventId48577`
|Enables structured data containing uuid and source information
|true
|`appName`
|Stream application identifier. Maximum length of 48 characters, limited by RFC5424
|jla-01
|`hostname`
|Stream host identifier. Maximum length of 255 characters, limited by RFC5424
|localhost.localdomain
|`connectionTimeout`
|Time to wait before timing out connection in milliseconds
|2500
|`reconnectInterval`
|Time to wait between re-connection attempts in milliseconds
|500
|`writeTimeout`
|Time to wait for destination to accept data in milliseconds
|1500
|`readTimeout`
|Time to wait for destination to acknowledge sent data (low values cause duplicates) in milliseconds
|1500
|`keepAlive`
|Enables sending alive packets.
|true
|`reconnectIfNoMessagesInterval`
|Reconnects before sending message if at least X milliseconds have passed since last message. Set to 0 to turn off automatic reconnections.
|150000
|`connectOnStart`
|Start one connection initially at appender start. Allows detection of configuration mistakes early.
|false
|`rebindEnabled`
|Rebind RELP connection after `rebindAmount` of records.
|true
|`rebindAmount`
|Rebind after this amount of records sent if `rebindEnabled` is set.
|100000
|`synchronizedAccess`
|Allows only one thread at a time to append, therefore uses only one connection.
|false
|`useTLS`
|Use TLS instead of a plain text connection.
|false
|`keystorePath`
|Path to Java keystore that includes the CA certificate for the TLS connection
|/unset/path/to/keystore
|`keystorePassword`
|Keystore password for the keystore defined in `keystorePath`
|
|===
== jboss-module
These instructions are untested but should work none the less.
jla_01-1.0.5-jboss-modules.jar contains logback appender for jboss as jboss-module. For generic information about jboss modules, see https://jboss-modules.github.io/jboss-modules/manual/
=== Inclusion
Copy the jar into $EAP_HOME/modules.
Include module by using following convetion to target module.xml (which may be quite many).
```
<.../>
<.../>
```
One may wish to add this as a global module according to following link in order to avoid multiple inclusions:
https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/configuration_guide/index#add_a_global_module
== Configuring pre-built Logback application
First download wanted versions of jla_01, rlp_01, tls_01 and rlo_14 from the following urls:
* https://search.maven.org/artifact/com.teragrep/jla_01[jla_01]
* https://search.maven.org/artifact/com.teragrep/rlp_01[rlp_01]
* https://search.maven.org/artifact/com.teragrep/tls_01[tls_01]
* https://search.maven.org/artifact/com.teragrep/rlo_14[rlo_14]
Then run java while pointing classpath to the directory where you downloaded the jars to like:
```
java -cp "path/to/downloaded/jars/*:target/example.jar" com.teragrep.example.Main
```
== 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_01/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.