org.springframework.boot.actuate.trace.http

Class HttpTrace

java.lang.Object

org.springframework.boot.actuate.trace.http.HttpTrace

public final class HttpTrace
extends Object

A trace event for handling of an HTTP request and response exchange. Can be used for analyzing contextual information such as HTTP headers.

Since:

2.0.0

Author:

Dave Syer, Andy Wilkinson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpTrace.Principal Principal associated with an HTTP request-response exchange.
static class	HttpTrace.Request Trace of an HTTP request.
static class	HttpTrace.Response Trace of an HTTP response.
static class	HttpTrace.Session Session associated with an HTTP request-response exchange.

Constructor Summary

Constructors

Constructor and Description
HttpTrace(HttpTrace.Request request, HttpTrace.Response response, Instant timestamp, HttpTrace.Principal principal, HttpTrace.Session session, Long timeTaken) Creates a fully-configured HttpTrace instance.

Method Summary

Modifier and Type	Method and Description
HttpTrace.Principal	getPrincipal()
HttpTrace.Request	getRequest()
HttpTrace.Response	getResponse()
HttpTrace.Session	getSession()
Instant	getTimestamp()
Long	getTimeTaken()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpTrace

public HttpTrace(HttpTrace.Request request,
                 HttpTrace.Response response,
                 Instant timestamp,
                 HttpTrace.Principal principal,
                 HttpTrace.Session session,
                 Long timeTaken)

Creates a fully-configured HttpTrace instance. Primarily for use by HttpTraceRepository implementations when recreating a trace from a persistent store.

Parameters:

request - the request

response - the response

timestamp - the timestamp of the request-response exchange

principal - the principal, if any

session - the session, if any

timeTaken - the time taken, in milliseconds, to complete the request-response exchange, if known

Since:

2.1.0

Method Detail

getTimestamp

public Instant getTimestamp()

getPrincipal

public HttpTrace.Principal getPrincipal()

getSession

public HttpTrace.Session getSession()

getRequest

public HttpTrace.Request getRequest()

getResponse

public HttpTrace.Response getResponse()

getTimeTaken

public Long getTimeTaken()