Klogging/io.klogging.rendering

Package-level declarations

Rendering log events as JSON or plain text.

Types

RenderString

interface RenderString

Interface for rendering a LogEvent to a String.

Properties

colour5

val Level.colour5: String

Render a level in colour using ANSI colour escapes.

localString

val Instant.localString: String

Extension property for Kotlin Instant to render it in local time as two words.

localTime

val Instant.localTime: String

Only the local time component.

RENDER_ANSI

val RENDER_ANSI: RenderString

Implementation of RenderString like that for Log4J2 with ANSI colouring of level output to a console.

RENDER_CLEF

val RENDER_CLEF: RenderString

Render a LogEvent into CLEF compact JSON format.

RENDER_ECS

val RENDER_ECS: RenderString

Render a LogEvent into JSON in Elastic Common Schema for sending directly to an ELK stack.

RENDER_GELF

val RENDER_GELF: RenderString

Renders a LogEvent into GELF JSON format.

RENDER_ISO8601

val RENDER_ISO8601: RenderString

RENDER_SIMPLE

val RENDER_SIMPLE: RenderString

Simple implementation of RenderString for output to the standard output stream, mostly on one line.

right20

val String.right20: String

Functions

brightRed

fun brightRed(str: String): String

evalTemplate

fun LogEvent.evalTemplate(): String

graylogFormat

fun Instant.graylogFormat(): String

green

fun green(str: String): String

grey

fun grey(str: String): String

red

fun red(str: String): String

renderHec

fun renderHec(index: String? = null, sourceType: String? = null, source: String? = null): RenderString

Renders an event into JSON format for Splunk HTTP Event Collector.

rightAlign

fun String.rightAlign(width: Int): String

Right-align the string into a fixed-width space.

serializeMap

fun serializeMap(map: EventItems): String

Serialize a map with string keys to JSON.

shortenName

fun shortenName(name: CharSequence, width: Int = DEFAULT_MAX_WIDTH): CharSequence

Shortens the given name if it exceeds the specified width.

yellow

fun yellow(str: String): String