http4k-wiretap/org.http4k.wiretap.domain

Package-level declarations

Types

enum BodyHydration : Enum<BodyHydration>

data class ChaosConfig(val behaviour: String = "ReturnStatus", val latencyMin: Int = 100, val latencyMax: Int = 500, val statusCode: Status = INTERNAL_SERVER_ERROR, val trigger: String = "Always", val percentage: Int = 50, val countdown: Int = 5, val delaySeconds: Int = 10, val method: Method? = null, val path: String? = null, val host: String? = null)

ChaosStatusData

data class ChaosStatusData(val inboundActive: Boolean, val inboundDescription: String, val outboundActive: Boolean, val outboundDescription: String)

Direction

enum Direction : Enum<Direction>

Har

data class Har(val log: HarLog)

HarContent

data class HarContent(val size: Int, val mimeType: String, val text: String)

HarCreator

data class HarCreator(val name: String = "http4k-wiretap", val version: String = "1.0")

HarEntry

data class HarEntry(val startedDateTime: String, val time: Long, val request: HarRequest, val response: HarResponse, val timings: HarTimings)

HarHeader

data class HarHeader(val name: String, val value: String)

HarLog

data class HarLog(val version: String = "1.2", val creator: HarCreator = HarCreator(), val entries: List<HarEntry>)

HarPostData

data class HarPostData(val mimeType: String, val text: String)

HarQueryParam

data class HarQueryParam(val name: String, val value: String)

HarRequest

data class HarRequest(val method: String, val url: String, val httpVersion: String, val headers: List<HarHeader>, val queryString: List<HarQueryParam>, val headersSize: Int, val bodySize: Int, val postData: HarPostData?)

HarResponse

data class HarResponse(val status: Int, val statusText: String, val httpVersion: String, val headers: List<HarHeader>, val content: HarContent, val headersSize: Int, val bodySize: Int)

HarTimings

data class HarTimings(val send: Int = 0, val wait: Long, val receive: Int = 0)

HeaderEntry

data class HeaderEntry(val name: String, val value: String)

JvmMetrics

data class JvmMetrics(val heapUsedMb: Long, val heapMaxMb: Long, val heapCommittedMb: Long, val nonHeapUsedMb: Long, val threadCount: Int, val daemonThreadCount: Int, val peakThreadCount: Int, val gcPauseCount: Long, val gcPauseTotalMs: Long, val cpuUsage: Double, val systemCpuUsage: Double, val classesLoaded: Int, val classesUnloaded: Long)

LogStore

interface LogStore

LogSummary

data class LogSummary(val timestamp: String, val severity: String, val body: String, val serviceName: String, val traceId: OtelTraceId?, val spanId: OtelSpanId?, val attributes: List<SpanAttribute>, val bodyFields: List<SpanAttribute>)

Ordering

enum Ordering : Enum<Ordering>

OtelSpanId

class OtelSpanId : AbstractValue<String>

OtelTraceId

class OtelTraceId : AbstractValue<String>

Participant

data class Participant(val serviceName: String, val index: Int)

SequenceDiagram

data class SequenceDiagram(val participants: List<Participant>, val messages: List<SequenceMessage>)

SequenceMessage

data class SequenceMessage(val spanId: OtelSpanId, val fromIndex: Int, val toIndex: Int, val label: String, val isResponse: Boolean, val isError: Boolean)

SpanAttribute

data class SpanAttribute(val key: String, val value: String)

SpanDetail

data class SpanDetail(val spanId: OtelSpanId, val parentSpanId: OtelSpanId, val name: String, val kind: String, val durationMs: Long, val statusCode: String, val statusDescription: String, val serviceName: String, val depth: Int, val startOffsetPercent: Double, val widthPercent: Double, val attributes: List<SpanAttribute>, val baggageAttributes: List<SpanAttribute>, val resourceAttributes: List<SpanAttribute>, val events: List<SpanEvent>, val links: List<SpanLink>)

SpanEvent

data class SpanEvent(val name: String, val timestampMs: Long, val attributes: List<SpanAttribute>)

SpanLink

data class SpanLink(val traceId: OtelTraceId, val spanId: OtelSpanId, val attributes: List<SpanAttribute>)

TraceDetail

data class TraceDetail(val traceId: OtelTraceId, val totalDurationMs: Long, val spans: List<SpanDetail>)

TraceStore

interface TraceStore

TraceSummary

data class TraceSummary(val traceId: OtelTraceId, val spanCount: Int, val rootSpanName: String, val serviceName: String, val totalDurationMs: Long, val timestamp: String)

TrafficMetrics

class TrafficMetrics(meterRegistry: MeterRegistry, maxBuckets: Int = 60, clock: Clock = Clock.systemUTC())

TrafficTimeline

data class TrafficTimeline(val labels: List<String>, val datasets: Map<String, List<Int>>)

TransactionDetail

data class TransactionDetail(val id: TransactionId, val direction: Direction, val method: String, val uri: String, val status: Int, val durationMs: Long, val timestamp: String, val queryParams: List<HeaderEntry>, val requestHeaders: List<HeaderEntry>, val responseHeaders: List<HeaderEntry>, val requestBody: String, val responseBody: String, val curl: String, val traceId: OtelTraceId?, val isChaos: Boolean, val isReplay: Boolean)

TransactionFilter

data class TransactionFilter(val direction: Direction? = null, val host: String? = null, val method: Method? = null, val status: Status? = null, val path: String? = null)

TransactionId

class TransactionId : AbstractValue<Long>

TransactionStore

interface TransactionStore

TransactionSummary

data class TransactionSummary(val id: TransactionId, val direction: Direction, val method: String, val uri: String, val path: String, val host: String, val status: Int, val durationMs: Long, val timestamp: String, val isChaos: Boolean, val isReplay: Boolean, val chaosInfo: String?)

View

data class View(val id: ViewId, val name: String, val builtIn: Boolean = false, val filter: TransactionFilter = TransactionFilter())

ViewId

typealias ViewId = Long

ViewStore

interface ViewStore

WiretapStats

data class WiretapStats(val uptime: String, val totalRequests: Long, val inboundCount: Long, val outboundCount: Long, val latencyCounts: Map<String, Int>, val trafficTimeline: TrafficTimeline, val hostTimelines: Map<String, TrafficTimeline>, val traceCount: Int, val inboundChaosActive: Boolean, val inboundChaosDescription: String, val outboundChaosActive: Boolean, val outboundChaosDescription: String, val jvm: JvmMetrics)

WiretapTransaction

data class WiretapTransaction(val id: TransactionId, val transaction: HttpTransaction, val direction: Direction)

Functions

httpStatusCode

fun SpanDetail.httpStatusCode(): Int?

isError

fun SpanDetail.isError(): Boolean

remoteAuthority

fun SpanDetail.remoteAuthority(): String

toSummary

fun LogRecordData.toSummary(clock: Clock): LogSummary