0.11.0-SNAPSHOT

Klogging/io.klogging.sending

Package-level declarations

Types

@Serializable

data class ElkEndpoint(val url: String, val checkCertificate: Boolean = true)

Model of an ELK server endpoint

data class Endpoint(val host: String = "localhost", val port: Int = 12201)

Model of a Graylog server endpoint.

fun interface EventSender

Interface for sending log events somewhere.

class SendElk(endpoint: ElkEndpoint) : EventSender

Send a batch of events to an ELK server in ECS format.

fun interface SendString

Interface used for sending a string to a target somewhere.

@Serializable

data class SplunkEndpoint(val hecUrl: String, val hecToken: String, val index: String? = null, val sourceType: String? = null, val source: String? = null, val checkCertificate: String = "true")

Model of a Splunk server HEC endpoint.

class SplunkHec(endpoint: SplunkEndpoint, renderer: RenderString) : EventSender

Send a batch of events to a Splunk server using HTTP event collector (HEC).

Properties

val ANDROID: EventSender

actual val STDERR: SendString

expect val STDERR: SendString

Send an event rendered as a string to the standard error stream.

actual val STDERR: SendString

actual val STDERR: SendString

actual val STDERR: SendString

actual val STDERR: SendString

val STDOUT: SendString

Send an event rendered as a string to the standard output stream.

Functions

suspend fun <E> receiveBatch(channel: ReceiveChannel<E>, maxTimeMillis: Long, maxSize: Int): List<E>

Receive a batch of items from a channel, up to time and batch size limits.

fun senderFrom(renderer: RenderString, sender: SendString): EventSender

Convert a RenderString and SendString into an EventSender.

fun seqServer(url: String, apiKey: String?, checkCertificate: Boolean): SendString

Send a rendered string to a Seq server.

fun splunkServer(hecUrl: String, hecToken: String, checkCertificate: Boolean = true): SendString

Creates a SendString function that sends an event string to a Splunk server using the HTTP Event Collector (HEC) API.