Top Description Inners Fields Constructors Methods
org.springframework.http.server.observation

public sealed Enum ServerHttpObservationDocumentation

extends Enum<ServerHttpObservationDocumentation>
implements ObservationDocumentation
Class Inheritance
All Implemented Interfaces
io.micrometer.observation.docs.ObservationDocumentation
Imports
io.micrometer.common.KeyValue, io.micrometer.common.docs.KeyName, io.micrometer.observation.Observation, .ObservationConvention, io.micrometer.observation.docs.ObservationDocumentation

Documented KeyValues for the HTTP server observations for Servlet-based web applications.

This class is used by automated tools to document KeyValues attached to the HTTP server observations.

Author
Brian Clozel
Since
6.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
public static enum

Field Summary

Modifier and TypeField and Description
public static final ServerHttpObservationDocumentation
HTTP_SERVLET_SERVER_REQUESTS

HTTP request observations for Servlet-based servers.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static ServerHttpObservationDocumentation
public static ServerHttpObservationDocumentation[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

HTTP_SERVLET_SERVER_REQUESTSback to summary
public static final ServerHttpObservationDocumentation HTTP_SERVLET_SERVER_REQUESTS

HTTP request observations for Servlet-based servers.

Constructor Detail

ServerHttpObservationDocumentationback to summary
private ServerHttpObservationDocumentation()

Method Detail

valueOfback to summary
public static ServerHttpObservationDocumentation valueOf(String name)
valuesback to summary
public static ServerHttpObservationDocumentation[] values()
org.springframework.http.server.observation back to summary

public sealed Enum ServerHttpObservationDocumentation.HighCardinalityKeyNames

extends Enum<ServerHttpObservationDocumentation.HighCardinalityKeyNames>
implements KeyName
Class Inheritance
All Implemented Interfaces
io.micrometer.common.docs.KeyName

Field Summary

Modifier and TypeField and Description
public static final ServerHttpObservationDocumentation.HighCardinalityKeyNames
HTTP_URL

HTTP request URI.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static ServerHttpObservationDocumentation.HighCardinalityKeyNames
public static ServerHttpObservationDocumentation.HighCardinalityKeyNames[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

HTTP_URLback to summary
public static final ServerHttpObservationDocumentation.HighCardinalityKeyNames HTTP_URL

HTTP request URI.

Constructor Detail

HighCardinalityKeyNamesback to summary
private HighCardinalityKeyNames()

Method Detail

valueOfback to summary
public static ServerHttpObservationDocumentation.HighCardinalityKeyNames valueOf(String name)
valuesback to summary
public static ServerHttpObservationDocumentation.HighCardinalityKeyNames[] values()
org.springframework.http.server.observation back to summary

public sealed Enum ServerHttpObservationDocumentation.LowCardinalityKeyNames

extends Enum<ServerHttpObservationDocumentation.LowCardinalityKeyNames>
implements KeyName
Class Inheritance
All Implemented Interfaces
io.micrometer.common.docs.KeyName

Field Summary

Modifier and TypeField and Description
public static final ServerHttpObservationDocumentation.LowCardinalityKeyNames
EXCEPTION

Name of the exception thrown during the exchange, or none} if no exception happened.

public static final ServerHttpObservationDocumentation.LowCardinalityKeyNames
METHOD

Name of HTTP request method or none if the request was not received properly.

public static final ServerHttpObservationDocumentation.LowCardinalityKeyNames
OUTCOME

Outcome of the HTTP server exchange.

public static final ServerHttpObservationDocumentation.LowCardinalityKeyNames
STATUS

HTTP response raw status code, or "UNKNOWN" if no response was created.

public static final ServerHttpObservationDocumentation.LowCardinalityKeyNames
URI

URI pattern for the matching handler if available, falling back to REDIRECTION for 3xx responses, NOT_FOUND for 404 responses, root for requests with no path info, and UNKNOWN for all other requests.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static ServerHttpObservationDocumentation.LowCardinalityKeyNames
public static ServerHttpObservationDocumentation.LowCardinalityKeyNames[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

EXCEPTIONback to summary
public static final ServerHttpObservationDocumentation.LowCardinalityKeyNames EXCEPTION

Name of the exception thrown during the exchange, or none} if no exception happened.

METHODback to summary
public static final ServerHttpObservationDocumentation.LowCardinalityKeyNames METHOD

Name of HTTP request method or none if the request was not received properly.

OUTCOMEback to summary
public static final ServerHttpObservationDocumentation.LowCardinalityKeyNames OUTCOME

Outcome of the HTTP server exchange.

See Also
org.springframework.http.HttpStatus.Series
STATUSback to summary
public static final ServerHttpObservationDocumentation.LowCardinalityKeyNames STATUS

HTTP response raw status code, or "UNKNOWN" if no response was created.

URIback to summary
public static final ServerHttpObservationDocumentation.LowCardinalityKeyNames URI

URI pattern for the matching handler if available, falling back to REDIRECTION for 3xx responses, NOT_FOUND for 404 responses, root for requests with no path info, and UNKNOWN for all other requests.

Constructor Detail

LowCardinalityKeyNamesback to summary
private LowCardinalityKeyNames()

Method Detail

valueOfback to summary
public static ServerHttpObservationDocumentation.LowCardinalityKeyNames valueOf(String name)
valuesback to summary
public static ServerHttpObservationDocumentation.LowCardinalityKeyNames[] values()