Skip to content

Commit 41612d5

Browse files
Updates documentation
1 parent afcbb9c commit 41612d5

1 file changed

Lines changed: 18 additions & 9 deletions

File tree

README.md renamed to README.adoc

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,25 @@
11
# Java Util Logging RELP Handler
22
[![Build Status](https://scan.coverity.com/projects/23156/badge.svg)](https://scan.coverity.com/projects/jla_04)
33

4-
## Supported properties
4+
Creates Java Util Logging appender that uses RELP to ensure no events are lost.
55

6-
- java.util.logging.RelpHandler.LOGGERNAME.appname
7-
- java.util.logging.RelpHandler.LOGGERNAME.server.address
8-
- java.util.logging.RelpHandler.LOGGERNAME.server.connectionTimeout
9-
- java.util.logging.RelpHandler.LOGGERNAME.server.port
10-
- java.util.logging.RelpHandler.LOGGERNAME.server.readTimeout
11-
- java.util.logging.RelpHandler.LOGGERNAME.server.reconnectInterval
12-
- java.util.logging.RelpHandler.LOGGERNAME.server.writeTimeout
13-
- java.util.logging.RelpHandler.LOGGERNAME.useStructuredData
6+
## Supported properties
7+
* java.util.logging.RelpHandler.LOGGERNAME.appname
8+
** Stream application identifier. Maximum length of 48 characters, limited by RFC5424
9+
* java.util.logging.RelpHandler.LOGGERNAME.server.address
10+
** Connection destination address
11+
* java.util.logging.RelpHandler.LOGGERNAME.server.connectionTimeout
12+
** Time to wait before timing out connection
13+
* java.util.logging.RelpHandler.LOGGERNAME.server.port
14+
** Connection destination port
15+
* java.util.logging.RelpHandler.LOGGERNAME.server.readTimeout
16+
** Time to wait for destination to acknowledge sent data (low values cause duplicates)
17+
* java.util.logging.RelpHandler.LOGGERNAME.server.reconnectInterval
18+
** Time to wait between re-connection attempts
19+
* java.util.logging.RelpHandler.LOGGERNAME.server.writeTimeout
20+
** Time to wait for destination to accept data
21+
* java.util.logging.RelpHandler.LOGGERNAME.useStructuredData
22+
** Enables structured data containing uuid and source information
1423

1524
## Usage
1625

0 commit comments

Comments
 (0)