| Wait Strategy | Parameters | Implementation |
|---|---|---|
| blocking | none | BlockingWaitStrategy |
| busySpin | none | BusySpinWaitStrategy |
| liteBlocking | none | LiteBlockingWaitStrategy |
| yielding | none | YieldingWaitStrategy |
sleeping{
retries,
sleepTimeNs
}
e.g.sleeping or sleeping{500,1000} |
|
SleepingWaitStrategy |
phasedBackoff{
spinTime,
yieldTime,
timeUnit,
fallbackStrategy
}
e.g.phasedBackoff{10,60,seconds,blocking} |
|
PhasedBackoffWaitStrategy |
timeoutBlocking{
timeout,
timeUnit
}
e.g.timeoutBlocking{1,minutes} |
|
TimeoutBlockingWaitStrategy |
liteTimeoutBlocking{
timeout,
timeUnit
}
e.g.liteTimeoutBlocking{1,minutes} |
|
LiteTimeoutBlockingWaitStrategy |
| Provider | Description/Properties |
|---|---|
| timestamp | Event timestamp
|
| version | Logstash JSON format version
|
| message | Formatted log event message
|
| rawMessage | Raw log event message, as opposed to formatted log where parameters are resolved
|
| loggerName | Name of the logger that logged the message
|
| threadName | Name of the thread from which the event was logged
|
| logLevel | Logger level text (INFO, WARN, etc)
|
| logLevelValue | Logger level numerical value
|
| callerData | Outputs data about from where the logger was called (class/method/file/line)
|
| stackTrace | Stacktrace of any throwable logged with the event. Stackframes are separated by newline chars.
|
| rootStackTraceElement | (Only if a throwable was logged) Outputs a JSON Object containing the class and method name from which the outer-most exception was thrown.
|
| stackHash | (Only if a throwable was logged) Computes and outputs a hexadecimal hash of the throwable stack. This helps identifying several occurrences of the same error (more info).
|
| throwableClassName | (Only if a throwable was logged) Outputs a field that contains the class name of the thrown Throwable.
|
| throwableRootCauseClassName | (Only if a throwable was logged) Outputs a field that contains the class name of the root cause of the thrown Throwable.
|
| context | Outputs entries from logback's context
|
| contextName | Outputs the name of logback's context
|
| mdc |
Outputs entries from the Mapped Diagnostic Context (MDC). Will include all entries by default. When key names are specified for inclusion, then all other fields will be excluded. When key names are specified for exclusion, then all other fields will be included. It is a configuration error to specify both included and excluded key names.
|
| tags | Outputs logback markers as a comma separated list
|
| logstashMarkers | Used to output Logstash Markers as specified in Event-specific Custom Fields |
| nestedField |
Nests a JSON object under the configured fieldName. The nested object is populated by other providers added to this provider.
|
| pattern |
Outputs fields from a configured JSON Object string, while substituting patterns supported by logback's PatternLayout.
|
| arguments |
Outputs fields from the event arguments array. See Event-specific Custom Fields
|
| uuid | Outputs random UUID as field value. Handy when you want to provide unique identifier for log lines
|
| sequence |
Outputs an incrementing sequence number for every log event. Useful for tracking pottential message loss during transport (eg. UDP)
|
| Provider | Description/Properties |
|---|---|
| timestamp | Event timestamp
|
| version | Logstash JSON format version
|
| message | Message in the form `${remoteHost} - ${remoteUser} [${timestamp}] "${requestUrl}" ${statusCode} ${contentLength}`
|
| method | HTTP method
|
| protocol | HTTP protocol
|
| statusCode | HTTP status code
|
| requestedUrl | Requested URL
|
| requestedUri | Requested URI
|
| remoteHost | Remote Host
|
| remoteUser | Remote User
|
| contentLength | Content length
|
| elapsedTime | Elapsed time in milliseconds
|
| requestHeaders | Include the request headers
|
| responseHeaders | Include the response headers
|
| nestedField |
Nests a JSON object under the configured fieldName. The nested object is populated by other providers added to this provider.
|
| pattern |
Outputs fields from a configured JSON Object string, while substituting patterns supported by logback access's PatternLayout.
|
Memory usage and performance of logstash-logback-encoder have been improved
by addressing issues discovered with the help of the
[YourKit Java Profiler](http://www.yourkit.com/java/profiler/index.jsp).
YourKit, LLC has graciously donated a free license of the
[YourKit Java Profiler](http://www.yourkit.com/java/profiler/index.jsp)
to this open source project.