Polishing

This commit is contained in:
Sam Brannen
2024-02-16 15:49:13 +01:00
parent a85bf3185e
commit 71dfebbfe5
12 changed files with 269 additions and 266 deletions

View File

@@ -23,8 +23,11 @@ import io.micrometer.observation.ObservationConvention;
import io.micrometer.observation.docs.ObservationDocumentation;
/**
* Documented {@link io.micrometer.common.KeyValue KeyValues} for the {@link WebClient HTTP client} observations.
* <p>This class is used by automated tools to document KeyValues attached to the HTTP client observations.
* Documented {@link io.micrometer.common.KeyValue KeyValues} for the
* {@link WebClient HTTP client} observations.
*
* <p>This class is used by automated tools to document KeyValues attached to the
* HTTP client observations.
*
* @author Brian Clozel
* @since 6.0
@@ -49,25 +52,26 @@ public enum ClientHttpObservationDocumentation implements ObservationDocumentati
public KeyName[] getHighCardinalityKeyNames() {
return new KeyName[] {HighCardinalityKeyNames.HTTP_URL};
}
};
public enum LowCardinalityKeyNames implements KeyName {
/**
* Name of HTTP request method or {@value KeyValue#NONE_VALUE} if the request could not be created.
* Name of HTTP request method or {@value KeyValue#NONE_VALUE} if the
* request could not be created.
*/
METHOD {
@Override
public String asString() {
return "method";
}
},
/**
* URI template used for HTTP request, or {@value KeyValue#NONE_VALUE} if none was provided.
* Only the path part of the URI is considered.
* URI template used for HTTP request, or {@value KeyValue#NONE_VALUE} if
* none was provided.
* <p>Only the path part of the URI is considered.
*/
URI {
@Override
@@ -99,7 +103,8 @@ public enum ClientHttpObservationDocumentation implements ObservationDocumentati
},
/**
* Name of the exception thrown during the exchange, or {@value KeyValue#NONE_VALUE} if no exception happened.
* Name of the exception thrown during the exchange, or
* {@value KeyValue#NONE_VALUE} if no exception happened.
*/
EXCEPTION {
@Override
@@ -110,7 +115,6 @@ public enum ClientHttpObservationDocumentation implements ObservationDocumentati
/**
* Outcome of the HTTP client exchange.
*
* @see org.springframework.http.HttpStatus.Series
*/
OUTCOME {