includelockinfo

SpringBootActuatorWebAPIDocumentationAndyWilkinsonTableofContents1.
Overview21.
1.
URLs.
21.
2.
Timestamps22.
AuditEvents(auditevents)32.
1.
RetrievingAuditEvents32.
1.
1.
QueryParameters.
32.
1.
2.
ResponseStructure33.
Beans(beans)53.
1.
RetrievingtheBeans53.
1.
1.
ResponseStructure64.
ConditionsEvaluationReport(conditions)84.
1.
RetrievingtheReport84.
1.
1.
ResponseStructure95.
ConfigurationProperties(configprops)115.
1.
Retrievingthe@ConfigurationPropertiesBean115.
1.
1.
ResponseStructure136.
Environment(env)146.
1.
RetrievingtheEntireEnvironment146.
1.
1.
ResponseStructure156.
2.
RetrievingaSingleProperty166.
2.
1.
ResponseStructure167.
Flyway(flyway)187.
1.
RetrievingtheMigrations187.
1.
1.
ResponseStructure188.
Health(health)208.
1.
RetrievingtheHealth208.
1.
1.
ResponseStructure209.
HeapDump(heapdump)229.
1.
RetrievingtheHeapDump2210.
HTTPTrace(httptrace)2310.
1.
RetrievingtheTraces2310.
1.
1.
ResponseStructure2311.
Info(info)2511.
1.
RetrievingtheInfo.
2511.
1.
1.
ResponseStructure25buildResponseStructure25gitResponseStructure2612.
Liquibase(liquibase)2712.
1.
RetrievingtheChanges2712.
1.
1.
ResponseStructure2713.
LogFile(logfile)2913.
1.
RetrievingtheLogFile2913.
2.
RetrievingPartoftheLogFile3114.
Loggers(loggers)3214.
1.
RetrievingAllLoggers.
3214.
1.
1.
ResponseStructure3214.
2.
RetrievingaSingleLogger3314.
2.
1.
ResponseStructure3314.
3.
SettingaLogLevel.
3314.
3.
1.
RequestStructure.
3314.
4.
ClearingaLogLevel3415.
Mappings(mappings)3515.
1.
RetrievingtheMappings3515.
1.
1.
ResponseStructure3815.
1.
2.
DispatcherServletsResponseStructure3915.
1.
3.
ServletsResponseStructure4015.
1.
4.
ServletFiltersResponseStructure4015.
1.
5.
DispatcherHandlersResponseStructure.
4116.
Metrics(metrics)4316.
1.
RetrievingMetricNames4316.
1.
1.
ResponseStructure4316.
2.
RetrievingaMetric4316.
2.
1.
QueryParameters4416.
2.
2.
Responsestructure4416.
3.
DrillingDown4517.
Prometheus(prometheus)4617.
1.
RetrievingtheMetrics.
4618.
ScheduledTasks(scheduledtasks)4818.
1.
RetrievingtheScheduledTasks4818.
1.
1.
ResponseStructure4819.
Sessions(sessions)5019.
1.
RetrievingSessions5019.
1.
1.
QueryParameters5119.
1.
2.
ResponseStructure5119.
2.
RetrievingaSingleSession5119.
2.
1.
ResponseStructure5219.
3.
DeletingaSession5220.
Shutdown(shutdown)5320.
1.
ShuttingDowntheApplication5320.
1.
1.
ResponseStructure5321.
ThreadDump(threaddump)5421.
1.
RetrievingtheThreadDump.
5421.
1.
1.
ResponseStructure57ThisAPIdocumentationdescribesSpringBootActuatorswebendpoints.
1Chapter1.
OverviewBeforeyouproceed,youshouldreadthefollowingtopics:URLsTimestamps1.
1.
URLsBydefault,allwebendpointsareavailablebeneaththepath/actuatorwithURLsoftheform/actuator/{id}.
The/actuatorbasepathcanbeconfiguredbyusingthemanagement.
endpoints.
web.
base-pathproperty,asshowninthefollowingexample:management.
endpoints.
web.
base-path=/manageTheprecedingapplication.
propertiesexamplechangestheformoftheendpointURLsfrom/actuator/{id}to/manage/{id}.
Forexample,theURLinfoendpointwouldbecome/manage/info.
1.
2.
TimestampsAlltimestampsthatareconsumedbytheendpoints,eitherasqueryparametersorintherequestbody,mustbeformattedasanoffsetdateandtimeasspecifiedinISO8601.
2Chapter2.
AuditEvents(auditevents)Theauditeventsendpointprovidesinformationabouttheapplication'sauditevents.
2.
1.
RetrievingAuditEventsToretrievetheauditevents,makeaGETrequestto/actuator/auditevents,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/auditeventsprincipal=alice&after=2018-04-05T11%3A45%3A57.
861Z&type=logout'-i-XGETTheprecedingexampleretrieveslogouteventsfortheprincipal,alice,thatoccurredafter09:37on7November2017intheUTCtimezone.
Theresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:121{"events":[{"timestamp":"2018-04-05T11:45:57.
862Z","principal":"alice","type":"logout"}]}2.
1.
1.
QueryParametersTheendpointusesqueryparameterstolimittheeventsthatitreturns.
Thefollowingtableshowsthesupportedqueryparameters:ParameterDescriptionafterRestrictstheeventstothosethatoccurredafterthegiventime.
Optional.
principalRestrictstheeventstothosewiththegivenprincipal.
Optional.
typeRestrictstheeventstothosewiththegiventype.
Optional.
2.
1.
2.
ResponseStructureTheresponsecontainsdetailsofalloftheauditeventsthatmatchedthequery.
Thefollowingtabledescribesthestructureoftheresponse:3PathTypeDescriptioneventsArrayAnarrayofauditevents.
events.
[].
timestampStringThetimestampofwhentheeventoccurred.
events.
[].
principalStringTheprincipalthattriggeredtheevent.
events.
[].
typeStringThetypeoftheevent.
4Chapter3.
Beans(beans)Thebeansendpointprovidesinformationabouttheapplication'sbeans.
3.
1.
RetrievingtheBeansToretrievethebeans,makeaGETrequestto/actuator/beans,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/beans'-i-XGETTheresultingresponseissimilartothefollowing:5HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:1150{"contexts":{"application":{"beans":{"defaultServletHandlerMapping":{"aliases":[],"scope":"singleton","type":"org.
springframework.
web.
servlet.
config.
annotation.
WebMvcConfigurationSupport$EmptyHandlerMapping","resource":"org.
springframework.
boot.
autoconfigure.
web.
servlet.
WebMvcAutoConfiguration$EnableWebMvcConfiguration","dependencies":[]},"org.
springframework.
boot.
autoconfigure.
web.
servlet.
DispatcherServletAutoConfiguration":{"aliases":[],"scope":"singleton","type":"org.
springframework.
boot.
autoconfigure.
web.
servlet.
DispatcherServletAutoConfiguration$$EnhancerBySpringCGLIB$$43c5f87b","dependencies":[]},"org.
springframework.
boot.
autoconfigure.
context.
PropertyPlaceholderAutoConfiguration":{"aliases":[],"scope":"singleton","type":"org.
springframework.
boot.
autoconfigure.
context.
PropertyPlaceholderAutoConfiguration$$EnhancerBySpringCGLIB$$561a15f7","dependencies":[]}}}}}3.
1.
1.
ResponseStructureTheresponsecontainsdetailsoftheapplication'sbeans.
Thefollowingtabledescribesthestructureoftheresponse:6PathTypeDescriptioncontextsObjectApplicationcontextskeyedbyid.
contexts.
*.
parentIdStringIdoftheparentapplicationcontext,ifany.
contexts.
*.
beansObjectBeansintheapplicationcontextkeyedbyname.
contexts.
*.
beans.
*.
aliasesArrayNamesofanyaliases.
contexts.
*.
beans.
*.
scopeStringScopeofthebean.
contexts.
*.
beans.
*.
typeStringFullyqualifiedtypeofthebean.
contexts.
*.
beans.
*.
resourceStringResourceinwhichthebeanwasdefined,ifany.
contexts.
*.
beans.
*.
dependenciesArrayNamesofanydependencies.
7Chapter4.
ConditionsEvaluationReport(conditions)Theconditionsendpointprovidesinformationabouttheevaluationofconditionsonconfigurationandauto-configurationclasses.
4.
1.
RetrievingtheReportToretrievethereport,makeaGETrequestto/actuator/conditions,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/conditions'-i-XGETTheresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:3230{"contexts":{"application":{"positiveMatches":{"EndpointAutoConfiguration#endpointOperationParameterMapper":[{"condition":"OnBeanCondition","message":"@ConditionalOnMissingBean(types:org.
springframework.
boot.
actuate.
endpoint.
invoke.
ParameterValueMapper;SearchStrategy:all)didnotfindanybeans"}],"EndpointAutoConfiguration#endpointCachingOperationInvokerAdvisor":[{"condition":"OnBeanCondition","message":"@ConditionalOnMissingBean(types:org.
springframework.
boot.
actuate.
endpoint.
invoker.
cache.
CachingOperationInvokerAdvisor;SearchStrategy:all)didnotfindanybeans"}],"WebEndpointAutoConfiguration":[{"condition":"OnWebApplicationCondition","message":"@ConditionalOnWebApplication(required)found'session'scope"}]},"negativeMatches":{"WebFluxEndpointManagementContextConfiguration":{"notMatched":[{"condition":"OnWebApplicationCondition","message":"notareactivewebapplication"}],"matched":[{8"condition":"OnClassCondition","message":"@ConditionalOnClassfoundrequiredclasses'org.
springframework.
web.
reactive.
DispatcherHandler','org.
springframework.
http.
server.
reactive.
HttpHandler';@ConditionalOnMissingClassdidnotfindunwantedclass"}]},"GsonHttpMessageConvertersConfiguration.
GsonHttpMessageConverterConfiguration":{"notMatched":[{"condition":"GsonHttpMessageConvertersConfiguration.
PreferGsonOrJacksonAndJsonbUnavailableCondition","message":"AnyNestedCondition0matched2didnot;NestedConditiononGsonHttpMessageConvertersConfiguration.
PreferGsonOrJacksonAndJsonbUnavailableCondition.
JacksonJsonbUnavailableNoneNestedConditions1matched1didnot;NestedConditiononGsonHttpMessageConvertersConfiguration.
JacksonAndJsonbUnavailableCondition.
JsonbPreferred@ConditionalOnProperty(spring.
http.
converters.
preferred-json-mapper=jsonb)didnotfindproperty'spring.
http.
converters.
preferred-json-mapper';NestedConditiononGsonHttpMessageConvertersConfiguration.
JacksonAndJsonbUnavailableCondition.
JacksonAvailable@ConditionalOnBean(types:org.
springframework.
http.
converter.
json.
MappingJackson2HttpMessageConverter;SearchStrategy:all)foundbean'mappingJackson2HttpMessageConverter';NestedConditiononGsonHttpMessageConvertersConfiguration.
PreferGsonOrJacksonAndJsonbUnavailableCondition.
GsonPreferred@ConditionalOnProperty(spring.
http.
converters.
preferred-json-mapper=gson)didnotfindproperty'spring.
http.
converters.
preferred-json-mapper'"}],"matched":[]},"JsonbHttpMessageConvertersConfiguration":{"notMatched":[{"condition":"OnClassCondition","message":"@ConditionalOnClassdidnotfindrequiredclass'javax.
json.
bind.
Jsonb'"}],"matched":[]}},"unconditionalClasses":["org.
springframework.
boot.
autoconfigure.
context.
PropertyPlaceholderAutoConfiguration"]}}}4.
1.
1.
ResponseStructureTheresponsecontainsdetailsoftheapplication'sconditionevaluation.
Thefollowingtabledescribesthestructureoftheresponse:9PathTypeDescriptioncontextsObjectApplicationcontextskeyedbyid.
contexts.
*.
positiveMatchesObjectClassesandmethodswithconditionsthatwerematched.
contexts.
*.
positiveMatches.
*.
[].
conditionStringNameofthecondition.
contexts.
*.
positiveMatches.
*.
[].
messageStringDetailsofwhytheconditionwasmatched.
contexts.
*.
negativeMatchesObjectClassesandmethodswithconditionsthatwerenotmatched.
contexts.
*.
negativeMatches.
*.
notMatchedArrayConditionsthatwerematched.
contexts.
*.
negativeMatches.
*.
notMatched.
[].
conditionStringNameofthecondition.
contexts.
*.
negativeMatches.
*.
notMatched.
[].
messageStringDetailsofwhytheconditionwasnotmatched.
contexts.
*.
negativeMatches.
*.
matchedArrayConditionsthatwerematched.
contexts.
*.
negativeMatches.
*.
matched.
[].
conditionStringNameofthecondition.
contexts.
*.
negativeMatches.
*.
matched.
[].
messageStringDetailsofwhytheconditionwasmatched.
contexts.
*.
unconditionalClassesArrayNamesofunconditionalauto-configurationclassesifany.
contexts.
*.
parentIdStringIdoftheparentapplicationcontext,ifany.
10Chapter5.
ConfigurationProperties(configprops)Theconfigpropsendpointprovidesinformationabouttheapplication's@ConfigurationPropertiesbeans.
5.
1.
Retrievingthe@ConfigurationPropertiesBeanToretrievethe@ConfigurationPropertiesbeans,makeaGETrequestto/actuator/configprops,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/configprops'-i-XGETTheresultingresponseissimilartothefollowing:11HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:1266{"contexts":{"application":{"beans":{"management.
endpoints.
web.
cors-org.
springframework.
boot.
actuate.
autoconfigure.
endpoint.
web.
CorsEndpointProperties":{"prefix":"management.
endpoints.
web.
cors","properties":{"allowedHeaders":[],"allowedMethods":[],"allowedOrigins":[],"maxAge":{"units":["SECONDS","NANOS"]},"exposedHeaders":[]}},"spring.
http.
encoding-org.
springframework.
boot.
autoconfigure.
http.
HttpEncodingProperties":{"prefix":"spring.
http.
encoding","properties":{"charset":"UTF-8","force":false,"forceRequest":false,"forceResponse":false}},"management.
endpoints.
web-org.
springframework.
boot.
actuate.
autoconfigure.
endpoint.
web.
WebEndpointProperties":{"prefix":"management.
endpoints.
web","properties":{"pathMapping":{},"exposure":{"include""exclude":[]},"basePath":"/actuator"}}}}}}125.
1.
1.
ResponseStructureTheresponsecontainsdetailsoftheapplication's@ConfigurationPropertiesbeans.
Thefollowingtabledescribesthestructureoftheresponse:PathTypeDescriptioncontextsObjectApplicationcontextskeyedbyid.
contexts.
*.
beans.
*Object@ConfigurationPropertiesbeanskeyedbybeanname.
contexts.
*.
beans.
*.
prefixStringPrefixappliedtothenamesofthebean'sproperties.
contexts.
*.
beans.
*.
propertiesObjectPropertiesofthebeanasname-valuepairs.
contexts.
*.
parentIdStringIdoftheparentapplicationcontext,ifany.
13Chapter6.
Environment(env)Theenvendpointprovidesinformationabouttheapplication'sEnvironment.
6.
1.
RetrievingtheEntireEnvironmentToretrievetheentireenvironment,makeaGETrequestto/actuator/env,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/env'-i-XGETTheresultingresponseissimilartothefollowing:14HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:799{"activeProfiles":[],"propertySources":[{"name":"systemProperties","properties":{"java.
runtime.
name":{"value":"OpenJDKRuntimeEnvironment"},"java.
vm.
version":{"value":"25.
141-b15"},"java.
vm.
vendor":{"value":"OracleCorporation"}}},{"name":"systemEnvironment","properties":{"JAVA_HOME":{"value":"/docker-java-home","origin":"SystemEnvironmentProperty\"JAVA_HOME\""}}},{"name":"applicationConfig:[classpath:/application.
properties]","properties":{"com.
example.
cache.
max-size":{"value":"1000","origin":"classpathresource[application.
properties]:1:29"}}}]}6.
1.
1.
ResponseStructureTheresponsecontainsdetailsoftheapplication'sEnvironment.
Thefollowingtabledescribesthestructureoftheresponse:PathTypeDescriptionactiveProfilesArrayNamesoftheactiveprofiles,ifany.
propertySourcesArrayPropertysourcesinorderofprecedence.
propertySources.
[].
nameStringNameofthepropertysource.
15PathTypeDescriptionpropertySources.
[].
propertiesObjectPropertiesinthepropertysourcekeyedbypropertyname.
propertySources.
[].
properties.
*.
valueStringValueoftheproperty.
propertySources.
[].
properties.
*.
originStringOriginoftheproperty,ifany.
6.
2.
RetrievingaSinglePropertyToretrieveasingleproperty,makeaGETrequestto/actuator/env/{property.
name},asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/env/com.
example.
cache.
max-size'-i-XGETTheprecedingexampleretrievesinformationaboutthepropertynamedcom.
example.
cache.
max-size.
Theresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Disposition:inline;filename=f.
txtContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:445{"property":{"source":"applicationConfig:[classpath:/application.
properties]","value":"1000"},"activeProfiles":[],"propertySources":[{"name":"systemProperties"},{"name":"systemEnvironment"},{"name":"applicationConfig:[classpath:/application.
properties]","property":{"value":"1000","origin":"classpathresource[application.
properties]:1:29"}}]}6.
2.
1.
ResponseStructureTheresponsecontainsdetailsoftherequestedproperty.
Thefollowingtabledescribesthestructureoftheresponse:16PathTypeDescriptionpropertyObjectPropertyfromtheenvironment,iffound.
property.
sourceStringNameofthesourceoftheproperty.
property.
valueStringValueoftheproperty.
activeProfilesArrayNamesoftheactiveprofiles,ifany.
propertySourcesArrayPropertysourcesinorderofprecedence.
propertySources.
[].
nameStringNameofthepropertysource.
propertySources.
[].
propertyObjectPropertyinthepropertysource,ifany.
propertySources.
[].
property.
valueStringValueoftheproperty.
propertySources.
[].
property.
originStringOriginoftheproperty,ifany.
17Chapter7.
Flyway(flyway)TheflywayendpointprovidesinformationaboutdatabasemigrationsperformedbyFlyway.
7.
1.
RetrievingtheMigrationsToretrievethemigrations,makeaGETrequestto/actuator/flyway,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/flyway'-i-XGETTheresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:506{"contexts":{"application":{"flywayBeans":{"flyway":{"migrations":[{"type":"SQL","checksum":0,"version":"1","description":"init","script":"V1__init.
sql","state":"SUCCESS","installedBy":"SA","installedOn":"2018-04-05T11:46:02.
175Z","installedRank":1,"executionTime":0}]}}}}}7.
1.
1.
ResponseStructureTheresponsecontainsdetailsoftheapplication'sFlywaymigrations.
Thefollowingtabledescribesthestructureoftheresponse:18PathTypeDescriptioncontextsObjectApplicationcontextskeyedbyidcontexts.
*.
flywayBeans.
*.
migrationsArrayMigrationsperformedbytheFlywayinstance,keyedbyFlywaybeanname.
contexts.
*.
flywayBeans.
*.
migrations.
[].
checksumNumberChecksumofthemigration,ifany.
contexts.
*.
flywayBeans.
*.
migrations.
[].
descriptionStringDescriptionofthemigration,ifany.
contexts.
*.
flywayBeans.
*.
migrations.
[].
executionTimeNumberExecutiontimeinmillisecondsofanappliedmigration.
contexts.
*.
flywayBeans.
*.
migrations.
[].
installedByStringUserthatinstalledtheappliedmigration,ifany.
contexts.
*.
flywayBeans.
*.
migrations.
[].
installedOnStringTimestampofwhentheappliedmigrationwasinstalled,ifany.
contexts.
*.
flywayBeans.
*.
migrations.
[].
installedRankNumberRankoftheappliedmigration,ifany.
Latermigrationshavehigherranks.
contexts.
*.
flywayBeans.
*.
migrations.
[].
scriptStringNameofthescriptusedtoexecutethemigration,ifany.
contexts.
*.
flywayBeans.
*.
migrations.
[].
stateStringStateofthemigration.
(PENDING,ABOVE_TARGET,BELOW_BASELINE,BASELINE,IGNORED,MISSING_SUCCESS,MISSING_FAILED,SUCCESS,UNDONE,AVAILABLE,FAILED,OUT_OF_ORDER,FUTURE_SUCCESS,FUTURE_FAILED,OUTDATED,SUPERSEDED)contexts.
*.
flywayBeans.
*.
migrations.
[].
typeStringTypeofthemigration.
(SCHEMA,BASELINE,SQL,UNDO_SQL,JDBC,UNDO_JDBC,SPRING_JDBC,UNDO_SPRING_JDBC,CUSTOM,UNDO_CUSTOM)contexts.
*.
flywayBeans.
*.
migrations.
[].
versionStringVersionofthedatabaseafterapplyingthemigration,ifany.
contexts.
*.
parentIdStringIdoftheparentapplicationcontext,ifany.
19Chapter8.
Health(health)Thehealthendpointprovidesdetailedinformationaboutthehealthoftheapplication.
8.
1.
RetrievingtheHealthToretrievethehealthoftheapplication,makeaGETrequestto/actuator/health,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/health'-i-XGETTheresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:385{"status":"UP","details":{"diskSpaceHealthIndicator":{"status":"UP","details":{"total":78188351488,"free":41675071488,"threshold":10485760}},"dataSourceHealthIndicator":{"status":"UP","details":{"database":"HSQLDatabaseEngine","hello":1}}}}8.
1.
1.
ResponseStructureTheresponsecontainsdetailsofthehealthoftheapplication.
Thefollowingtabledescribesthestructureoftheresponse:PathTypeDescriptionstatusStringOverallstatusoftheapplication.
20PathTypeDescriptiondetailsObjectDetailsofthehealthoftheapplication.
Presenceiscontrolledbymanagement.
endpoint.
health.
show-details).
details.
*.
statusStringStatusofaspecificpartoftheapplication.
details.
*.
detailsObjectDetailsofthehealthofaspecificpartoftheapplication.
21Chapter9.
HeapDump(heapdump)Theheapdumpendpointprovidesaheapdumpfromtheapplication'sJVM.
9.
1.
RetrievingtheHeapDumpToretrievetheheapdump,makeaGETrequestto/actuator/heapdump.
TheresponseisbinarydatainHPROFformatandcanbelarge.
Typically,youshouldsavetheresponsetodiskforsubsequentanalysis.
Whenusingcurl,thiscanbeachievedbyusingthe-Ooption,asshowninthefollowingexample:$curl'http://localhost:8080/actuator/heapdump'-OTheprecedingexampleresultsinafilenamedheapdumpbeingwrittentothecurrentworkingdirectory.
22Chapter10.
HTTPTrace(httptrace)ThehttptraceendpointprovidesinformationaboutHTTPrequest-responseexchanges.
10.
1.
RetrievingtheTracesToretrievethetraces,makeaGETrequestto/actuator/httptrace,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/httptrace'-i-XGETTheresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:503{"traces":[{"timestamp":"2018-04-05T11:46:04.
701Z","principal":{"name":"alice"},"session":{"id":"ee650ecc-1e28-4591-a415-cc096f29c814"},"request":{"method":"GET","uri":"https://api.
example.
com","headers":{"Accept":["application/json"]}},"response":{"status":200,"headers":{"Content-Type":["application/json"]}},"timeTaken":2}]}10.
1.
1.
ResponseStructureTheresponsecontainsdetailsofthetracedHTTPrequest-responseexchanges.
Thefollowingtabledescribesthestructureoftheresponse:23PathTypeDescriptiontracesArrayAnarrayoftracedHTTPrequest-responseexchanges.
traces.
[].
timestampStringTimestampofwhenthetracedexchangeoccurred.
traces.
[].
principalObjectPrincipaloftheexchange,ifany.
traces.
[].
principal.
nameStringNameoftheprincipal.
traces.
[].
request.
methodStringHTTPmethodoftherequest.
traces.
[].
request.
remoteAddressStringRemoteaddressfromwhichtherequestwasreceived,ifknown.
traces.
[].
request.
uriStringURIoftherequest.
traces.
[].
request.
headersObjectHeadersoftherequest,keyedbyheadername.
traces.
[].
request.
headers.
*.
[]ArrayValuesoftheheadertraces.
[].
response.
statusNumberStatusoftheresponsetraces.
[].
response.
headersObjectHeadersoftheresponse,keyedbyheadername.
traces.
[].
response.
headers.
*.
[]ArrayValuesoftheheadertraces.
[].
sessionObjectSessionassociatedwiththeexchange,ifany.
traces.
[].
session.
idStringIDofthesession.
traces.
[].
timeTakenNumberTime,inmilliseconds,takentohandletheexchange.
24Chapter11.
Info(info)Theinfoendpointprovidesgeneralinformationabouttheapplication.
11.
1.
RetrievingtheInfoToretrievetheinformationabouttheapplication,makeaGETrequestto/actuator/info,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/info'-i-XGETTheresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:235{"git":{"commit":{"time":"+50229-09-10T08:10:39Z","id":"df027cf"},"branch":"master"},"build":{"version":"1.
0.
3","artifact":"application","group":"com.
example"}}11.
1.
1.
ResponseStructureTheresponsecontainsgeneralinformationabouttheapplication.
EachsectionoftheresponseiscontributedbyanInfoContributor.
SpringBootprovidesbuildandgitcontributions.
buildResponseStructureThefollowingtabledescribethestructureofthebuildsectionoftheresponse:PathTypeDescriptionartifactStringArtifactIDoftheapplication,ifany.
groupStringGroupIDoftheapplication,ifany.
nameStringNameoftheapplication,ifany.
25PathTypeDescriptionversionStringVersionoftheapplication,ifany.
timeVariesTimestampofwhentheapplicationwasbuilt,ifany.
gitResponseStructureThefollowingtabledescribesthestructureofthegitsectionoftheresponse:PathTypeDescriptionbranchStringNameoftheGitbranch,ifany.
commitObjectDetailsoftheGitcommit,ifany.
commit.
timeVariesTimestampofthecommit,ifany.
commit.
idStringIDofthecommit,ifany.
26Chapter12.
Liquibase(liquibase)TheliquibaseendpointprovidesinformationaboutdatabasechangesetsappliedbyLiquibase.
12.
1.
RetrievingtheChangesToretrievethechanges,makeaGETrequestto/actuator/liquibase,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/liquibase'-i-XGETTheresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:688{"contexts":{"application":{"liquibaseBeans":{"liquibase":{"changeSets":[{"author":"marceloverdijk","changeLog":"classpath:/db/changelog/db.
changelog-master.
yaml","comments":"","contexts":[],"dateExecuted":"2018-04-05T11:45:16.
230Z","deploymentId":"2928716214","description":"createTabletableName=customer","execType":"EXECUTED","id":"1","labels":[],"checksum":"7:0cfbff0a94f5ba816ab56eaca6b8affc","orderExecuted":1}]}}}}}12.
1.
1.
ResponseStructureTheresponsecontainsdetailsoftheapplication'sLiquibasechangesets.
Thefollowingtabledescribesthestructureoftheresponse:27PathTypeDescriptioncontextsObjectApplicationcontextskeyedbyidcontexts.
*.
liquibaseBeans.
*.
changeSetsArrayChangesetsmadebytheLiquibasebeans,keyedbybeanname.
contexts.
*.
liquibaseBeans.
*.
changeSets[].
authorStringAuthorofthechangeset.
contexts.
*.
liquibaseBeans.
*.
changeSets[].
changeLogStringChangelogthatcontainsthechangeset.
contexts.
*.
liquibaseBeans.
*.
changeSets[].
commentsStringCommentsonthechangeset.
contexts.
*.
liquibaseBeans.
*.
changeSets[].
contextsArrayContextsofthechangeset.
contexts.
*.
liquibaseBeans.
*.
changeSets[].
dateExecutedStringTimestampofwhenthechangesetwasexecuted.
contexts.
*.
liquibaseBeans.
*.
changeSets[].
deploymentIdStringIDofthedeploymentthatranthechangeset.
contexts.
*.
liquibaseBeans.
*.
changeSets[].
descriptionStringDescriptionofthechangeset.
contexts.
*.
liquibaseBeans.
*.
changeSets[].
execTypeStringExecutiontypeofthechangeset(EXECUTED,FAILED,SKIPPED,RERAN,MARK_RAN).
contexts.
*.
liquibaseBeans.
*.
changeSets[].
idStringIDofthechangeset.
contexts.
*.
liquibaseBeans.
*.
changeSets[].
labelsArrayLabelsassociatedwiththechangeset.
contexts.
*.
liquibaseBeans.
*.
changeSets[].
checksumStringChecksumofthechangeset.
contexts.
*.
liquibaseBeans.
*.
changeSets[].
orderExecutedNumberOrderoftheexecutionofthechangeset.
contexts.
*.
liquibaseBeans.
*.
changeSets[].
tagStringTagassociatedwiththechangeset,ifany.
contexts.
*.
parentIdStringIdoftheparentapplicationcontext,ifany.
28Chapter13.
LogFile(logfile)Thelogfileendpointprovidesaccesstothecontentsoftheapplication'slogfile.
13.
1.
RetrievingtheLogFileToretrievethelogfile,makeaGETrequestto/actuator/logfile,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/logfile'-i-XGETTheresultingresponseissimilartothefollowing:HTTP/1.
1200OKAccept-Ranges:bytesContent-Type:text/plainContent-Length:4723::SpringBoot::2017-08-0817:12:30.
910INFO19866---[main]s.
f.
SampleWebFreeMarkerApplication:StartingSampleWebFreeMarkerApplicationonhost.
localwithPID198662017-08-0817:12:30.
913INFO19866---[main]s.
f.
SampleWebFreeMarkerApplication:Noactiveprofileset,fallingbacktodefaultprofiles:default2017-08-0817:12:30.
952INFO19866---[main]ConfigServletWebServerApplicationContext:Refreshingorg.
springframework.
boot.
web.
servlet.
context.
AnnotationConfigServletWebServerApplicationContext@76b10754:startupdate[TueAug0817:12:30BST2017];rootofcontexthierarchy2017-08-0817:12:31.
878INFO19866---[main]o.
s.
b.
w.
embedded.
tomcat.
TomcatWebServer:Tomcatinitializedwithport(s):8080(http)2017-08-0817:12:31.
889INFO19866---[main]o.
apache.
catalina.
core.
StandardService:Startingservice[Tomcat]2017-08-0817:12:31.
890INFO19866---[main]org.
apache.
catalina.
core.
StandardEngine:StartingServletEngine:ApacheTomcat/8.
5.
162017-08-0817:12:31.
978INFO19866---[ost-startStop-1]o.
a.
c.
c.
C.
[Tomcat].
[localhost].
[/]:InitializingSpringembeddedWebApplicationContext292017-08-0817:12:31.
978INFO19866---[ost-startStop-1]o.
s.
web.
context.
ContextLoader:RootWebApplicationContext:initializationcompletedin1028ms2017-08-0817:12:32.
080INFO19866---[ost-startStop-1]o.
s.
b.
w.
servlet.
ServletRegistrationBean:Mappingservlet:'dispatcherServlet'to[/]2017-08-0817:12:32.
084INFO19866---[ost-startStop-1]o.
s.
b.
w.
servlet.
FilterRegistrationBean:Mappingfilter:'characterEncodingFilter'to:[/*]2017-08-0817:12:32.
084INFO19866---[ost-startStop-1]o.
s.
b.
w.
servlet.
FilterRegistrationBean:Mappingfilter:'hiddenHttpMethodFilter'to:[/*]2017-08-0817:12:32.
084INFO19866---[ost-startStop-1]o.
s.
b.
w.
servlet.
FilterRegistrationBean:Mappingfilter:'httpPutFormContentFilter'to:[/*]2017-08-0817:12:32.
084INFO19866---[ost-startStop-1]o.
s.
b.
w.
servlet.
FilterRegistrationBean:Mappingfilter:'requestContextFilter'to:[/*]2017-08-0817:12:32.
349INFO19866---[main]s.
w.
s.
m.
m.
a.
RequestMappingHandlerAdapter:Lookingfor@ControllerAdvice:org.
springframework.
boot.
web.
servlet.
context.
AnnotationConfigServletWebServerApplicationContext@76b10754:startupdate[TueAug0817:12:30BST2017];rootofcontexthierarchy2017-08-0817:12:32.
420INFO19866---[main]s.
w.
s.
m.
m.
a.
RequestMappingHandlerMapping:Mapped"{[/error]}"ontopublicorg.
springframework.
http.
ResponseEntity>org.
springframework.
boot.
autoconfigure.
web.
servlet.
error.
BasicErrorController.
error(javax.
servlet.
http.
HttpServletRequest)2017-08-0817:12:32.
421INFO19866---[main]s.
w.
s.
m.
m.
a.
RequestMappingHandlerMapping:Mapped"{[/error],produces=[text/html]}"ontopublicorg.
springframework.
web.
servlet.
ModelAndVieworg.
springframework.
boot.
autoconfigure.
web.
servlet.
error.
BasicErrorController.
errorHtml(javax.
servlet.
http.
HttpServletRequest,javax.
servlet.
http.
HttpServletResponse)2017-08-0817:12:32.
444INFO19866---[main]o.
s.
w.
s.
handler.
SimpleUrlHandlerMapping:MappedURLpath[/webjars/**]ontohandleroftype[classorg.
springframework.
web.
servlet.
resource.
ResourceHttpRequestHandler]2017-08-0817:12:32.
444INFO19866---[main]o.
s.
w.
s.
handler.
SimpleUrlHandlerMapping:MappedURLpath[/**]ontohandleroftype[classorg.
springframework.
web.
servlet.
resource.
ResourceHttpRequestHandler]2017-08-0817:12:32.
471INFO19866---[main]o.
s.
w.
s.
handler.
SimpleUrlHandlerMapping:MappedURLpath[/**/favicon.
ico]ontohandleroftype[classorg.
springframework.
web.
servlet.
resource.
ResourceHttpRequestHandler]2017-08-0817:12:32.
600INFO19866---[main]o.
s.
w.
s.
v.
f.
FreeMarkerConfigurer:ClassTemplateLoaderforSpringmacrosaddedtoFreeMarkerconfiguration2017-08-0817:12:32.
681INFO19866---[main]o.
s.
j.
e.
a.
AnnotationMBeanExporter:RegisteringbeansforJMXexposureonstartup2017-08-0817:12:32.
744INFO19866---[main]o.
s.
b.
w.
embedded.
tomcat.
TomcatWebServer:Tomcatstartedonport(s):8080(http)302017-08-0817:12:32.
750INFO19866---[main]s.
f.
SampleWebFreeMarkerApplication:StartedSampleWebFreeMarkerApplicationin2.
172seconds(JVMrunningfor2.
479)13.
2.
RetrievingPartoftheLogFileRetrievingpartofthelogfileisnotsupportedwhenusingJersey.
Toretrievepartofthelogfile,makeaGETrequestto/actuator/logfilebyusingtheRangeheader,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/logfile'-i-XGET\-H'Range:bytes=0-1023'Theprecedingexampleretrievesthefirst1024bytesofthelogfile.
Theresultingresponseissimilartothefollowing:HTTP/1.
1206PartialContentAccept-Ranges:bytesContent-Type:text/plainContent-Range:bytes0-1023/4723Content-Length:1024::SpringBoot::2017-08-0817:12:30.
910INFO19866---[main]s.
f.
SampleWebFreeMarkerApplication:StartingSampleWebFreeMarkerApplicationonhost.
localwithPID198662017-08-0817:12:30.
913INFO19866---[main]s.
f.
SampleWebFreeMarkerApplication:Noactiveprofileset,fallingbacktodefaultprofiles:default2017-08-0817:12:30.
952INFO19866---[main]ConfigServletWebServerApplicationContext:Refreshingorg.
springframework.
boot.
web.
servlet.
context.
AnnotationConfigServletWebServerApplicationContext@76b10754:startupdate[TueAug0817:12:30BST2017];rootofcontexthierarchy2017-08-0817:12:31.
878INFO19866---[main]o.
s.
b.
w.
embedded.
tomcat.
TomcatWebServer:Tomcatinitializedwithport(31Chapter14.
Loggers(loggers)Theloggersendpointprovidesaccesstotheapplication'sloggersandtheconfigurationoftheirlevels.
14.
1.
RetrievingAllLoggersToretrievetheapplication'sloggers,makeaGETrequestto/actuator/loggers,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/loggers'-i-XGETTheresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:283{"levels":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"],"loggers":{"ROOT":{"configuredLevel":"INFO","effectiveLevel":"INFO"},"com.
example":{"configuredLevel":"DEBUG","effectiveLevel":"DEBUG"}}}14.
1.
1.
ResponseStructureTheresponsecontainsdetailsoftheapplication'sloggers.
Thefollowingtabledescribesthestructureoftheresponse:PathTypeDescriptionlevelsArrayLevelssupportbytheloggingsystem.
loggersObjectLoggerskeyedbyname.
loggers.
*.
configuredLevelStringConfiguredlevelofthelogger,ifany.
loggers.
*.
effectiveLevelStringEffectivelevelofthelogger.
3214.
2.
RetrievingaSingleLoggerToretrieveasinglelogger,makeaGETrequestto/actuator/loggers/{logger.
name},asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/loggers/com.
example'-i-XGETTheprecedingexampleretrievesinformationabouttheloggernamedcom.
example.
Theresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Disposition:inline;filename=f.
txtContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:61{"configuredLevel":"INFO","effectiveLevel":"INFO"}14.
2.
1.
ResponseStructureTheresponsecontainsdetailsoftherequestedlogger.
Thefollowingtabledescribesthestructureoftheresponse:PathTypeDescriptionconfiguredLevelStringConfiguredlevelofthelogger,ifany.
effectiveLevelStringEffectivelevelofthelogger.
14.
3.
SettingaLogLevelTosetthelevelofalogger,makeaPOSTrequestto/actuator/loggers/{logger.
name}withaJSONbodythatspecifiestheconfiguredlevelforthelogger,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/loggers/com.
example'-i-XPOST\-H'Content-Type:application/json'\-d'{"configuredLevel":"debug"}'TheprecedingexamplesetstheconfiguredLevelofthecom.
exampleloggertoDEBUG.
14.
3.
1.
RequestStructureTherequestspecifiesthedesiredlevelofthelogger.
Thefollowingtabledescribesthestructureof33therequest:PathTypeDescriptionconfiguredLevelStringLevelforthelogger.
Maybeomittedtoclearthelevel.
14.
4.
ClearingaLogLevelToclearthelevelofalogger,makeaPOSTrequestto/actuator/loggers/{logger.
name}withaJSONbodycontaininganemptyobject,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/loggers/com.
example'-i-XPOST\-H'Content-Type:application/json'\-d'{}'Theprecedingexampleclearstheconfiguredlevelofthecom.
examplelogger.
34Chapter15.
Mappings(mappings)Themappingsendpointprovidesinformationabouttheapplication'srequestmappings.
15.
1.
RetrievingtheMappingsToretrievethemappings,makeaGETrequestto/actuator/mappings,asshowninthefollowingcurl-basedexample:$curl'http://localhost:39983/actuator/mappings'-i-XGETTheresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Transfer-Encoding:chunkedDate:Thu,05Apr201811:46:09GMTContent-Length:6505{"contexts":{"application":{"mappings":{"dispatcherServlets":{"dispatcherServlet":[{"handler":"ResourceHttpRequestHandler[locations=[classpathresource[META-INF/resources/],classpathresource[resources/],classpathresource[static/],classpathresource[public/],ServletContextresource[/],classpathresource[]],resolvers=[org.
springframework.
web.
servlet.
resource.
PathResourceResolver@438dd007]]","predicate"favicon.
ico"},{"handler":"publicjava.
lang.
Objectorg.
springframework.
boot.
actuate.
endpoint.
web.
servlet.
AbstractWebMvcEndpointHandlerMapping$OperationHandler.
handle(javax.
servlet.
http.
HttpServletRequest,java.
util.
Map)","predicate":"{[/actuator/mappings],methods=[GET],produces=[application/vnd.
spring-boot.
actuator.
v2+json||application/json]}","details":{"handlerMethod":{"className":"org.
springframework.
boot.
actuate.
endpoint.
web.
servlet.
AbstractWebMvcEndpointHandlerMapping.
OperationHandler","name":"handle","descriptor":"(Ljavax/servlet/http/HttpServletRequest;Ljava/util/Map;)Ljava/lang/Object;"},35"requestMappingConditions":{"consumes":[],"headers":[],"methods":["GET"],"params":[],"patterns":["/actuator/mappings"],"produces":[{"mediaType":"application/vnd.
spring-boot.
actuator.
v2+json","negated":false},{"mediaType":"application/json","negated":false}]}}},{"handler":"protectedjava.
util.
Map>org.
springframework.
boot.
actuate.
endpoint.
web.
servlet.
WebMvcEndpointHandlerMapping.
links(javax.
servlet.
http.
HttpServletRequest,javax.
servlet.
http.
HttpServletResponse)","predicate":"{[/actuator],methods=[GET],produces=[application/vnd.
spring-boot.
actuator.
v2+json||application/json]}","details":{"handlerMethod":{"className":"org.
springframework.
boot.
actuate.
endpoint.
web.
servlet.
WebMvcEndpointHandlerMapping","name":"links","descriptor":"(Ljavax/servlet/http/HttpServletRequest;Ljavax/servlet/http/HttpServletResponse;)Ljava/util/Map;"},"requestMappingConditions":{"consumes":[],"headers":[],"methods":["GET"],"params":[],"patterns":["/actuator"],"produces":[{"mediaType":"application/vnd.
spring-boot.
actuator.
v2+json","negated":false},{"mediaType":"application/json","negated":false}]}}},{"handler":"publicjava.
lang.
Stringorg.
springframework.
boot.
actuate.
autoconfigure.
endpoint.
web.
documentation.
MappingsEndpointServletDocumentationTests$ExampleController.
example()",36"predicate"methods=[POST],params=[a!
=alpha],headers=[X-Custom=Foo],consumes=[application/json||!
application/xml],produces=[text/plain]}","details":{"handlerMethod":{"className":"org.
springframework.
boot.
actuate.
autoconfigure.
endpoint.
web.
documentation.
MappingsEndpointServletDocumentationTests.
ExampleController","name":"example","descriptor":"()Ljava/lang/String;"},"requestMappingConditions":{"consumes":[{"mediaType":"application/json","negated":false},{"mediaType":"application/xml","negated":true}],"headers":[{"name":"X-Custom","value":"Foo","negated":false}],"methods":["POST"],"params":[{"name":"a","value":"alpha","negated":true}],"patterns""produces":[{"mediaType":"text/plain","negated":false}]}}},{"handler":"ResourceHttpRequestHandler[locations=[classpathresource[META-INF/resources/webjars/]],resolvers=[org.
springframework.
web.
servlet.
resource.
PathResourceResolver@2d7f005b]]","predicate":"/webjars/**"},{"handler":"ResourceHttpRequestHandler[locations=[classpathresource[META-INF/resources/],classpathresource[resources/],classpathresource[static/],classpathresource[public/],ServletContextresource[/]],resolvers=[org.
springframework.
web.
servlet.
resource.
PathResourceResolver@6495483b]]","predicate"}]},"servletFilters":[{"servletNameMappings":[],37"urlPatternMappings""name":"requestContextFilter","className":"org.
springframework.
boot.
web.
servlet.
filter.
OrderedRequestContextFilter"},{"servletNameMappings":[],"urlPatternMappings""name":"httpPutFormContentFilter","className":"org.
springframework.
boot.
web.
servlet.
filter.
OrderedHttpPutFormContentFilter"},{"servletNameMappings":[],"urlPatternMappings""name":"hiddenHttpMethodFilter","className":"org.
springframework.
boot.
web.
servlet.
filter.
OrderedHiddenHttpMethodFilter"}],"servlets":[{"mappings":[],"name":"default","className":"org.
apache.
catalina.
servlets.
DefaultServlet"},{"mappings""name":"dispatcherServlet","className":"org.
springframework.
web.
servlet.
DispatcherServlet"}]}}}}15.
1.
1.
ResponseStructureTheresponsecontainsdetailsoftheapplication'smappings.
Theitemsfoundintheresponsedependonthetypeofwebapplication(reactiveorServlet-based).
Thefollowingtabledescribesthestructureofthecommonelementsoftheresponse:PathTypeDescriptioncontextsObjectApplicationcontextskeyedbyid.
contexts.
*.
mappingsObjectMappingsinthecontext,keyedbymappingtype.
contexts.
*.
mappings.
dispatcherServletsObjectDispatcherservletmappings,ifany.
contexts.
*.
mappings.
servletFiltersArrayServletfiltermappings,ifany.
contexts.
*.
mappings.
servletsArrayServletmappings,ifany.
contexts.
*.
mappings.
dispatcherHandlersObjectDispatcherhandlermappings,ifany.
38PathTypeDescriptioncontexts.
*.
parentIdStringIdoftheparentapplicationcontext,ifany.
Theentriesthatmaybefoundincontexts.
*.
mappingsaredescribedinthefollowingsections.
15.
1.
2.
DispatcherServletsResponseStructureWhenusingSpringMVC,theresponsecontainsdetailsofanyDispatcherServletrequestmappingsbeneathcontexts.
*.
mappings.
dispatcherServlets.
Thefollowingtabledescribesthestructureofthissectionoftheresponse:PathTypeDescription*ArrayDispatcherservletmappings,ifany,keyedbydispatcherservletbeanname.
*.
[].
detailsObjectAdditionalimplementation-specificdetailsaboutthemapping.
Optional.
*.
[].
handlerStringHandlerforthemapping.
*.
[].
predicateStringPredicateforthemapping.
*.
[].
details.
handlerMethodObjectDetailsofthemethod,ifany,thatwillhandlerequeststothismapping.
*.
[].
details.
handlerMethod.
classNameStringFullyqualifiednameoftheclassofthemethod.
*.
[].
details.
handlerMethod.
nameStringNameofthemethod.
*.
[].
details.
handlerMethod.
descriptorStringDescriptorofthemethodasspecifiedintheJavaLanguageSpecification.
*.
[].
details.
requestMappingConditionsObjectDetailsoftherequestmappingconditions.
*.
[].
details.
requestMappingConditions.
consumesArrayDetailsoftheconsumescondition*.
[].
details.
requestMappingConditions.
consumes.
[].
mediaTypeStringConsumedmediatype.
*.
[].
details.
requestMappingConditions.
consumes.
[].
negatedBooleanWhetherthemediatypeisnegated.
*.
[].
details.
requestMappingConditions.
headersArrayDetailsoftheheaderscondition.
*.
[].
details.
requestMappingConditions.
headers.
[].
nameStringNameoftheheader.
39PathTypeDescription*.
[].
details.
requestMappingConditions.
headers.
[].
valueStringRequiredvalueoftheheader,ifany.
*.
[].
details.
requestMappingConditions.
headers.
[].
negatedBooleanWhetherthevalueisnegated.
*.
[].
details.
requestMappingConditions.
methodsArrayHTTPmethodsthatarehandled.
*.
[].
details.
requestMappingConditions.
paramsArrayDetailsoftheparamscondition.
*.
[].
details.
requestMappingConditions.
params.
[].
nameStringNameoftheparameter.
*.
[].
details.
requestMappingConditions.
params.
[].
valueStringRequiredvalueoftheparameter,ifany.
*.
[].
details.
requestMappingConditions.
params.
[].
negatedBooleanWhetherthevalueisnegated.
*.
[].
details.
requestMappingConditions.
patternsArrayPatternsidentifyingthepathshandledbythemapping.
*.
[].
details.
requestMappingConditions.
producesArrayDetailsoftheproducescondition.
*.
[].
details.
requestMappingConditions.
produces.
[].
mediaTypeStringProducedmediatype.
*.
[].
details.
requestMappingConditions.
produces.
[].
negatedBooleanWhetherthemediatypeisnegated.
15.
1.
3.
ServletsResponseStructureWhenusingtheServletstack,theresponsecontainsdetailsofanyServletmappingsbeneathcontexts.
*.
mappings.
servlets.
Thefollowingtabledescribesthestructureofthissectionoftheresponse:PathTypeDescription[].
mappingsArrayMappingsoftheservlet.
[].
nameStringNameoftheservlet.
[].
classNameStringClassnameoftheservlet15.
1.
4.
ServletFiltersResponseStructureWhenusingtheServletstack,theresponsecontainsdetailsofanyFiltermappingsbeneathcontexts.
*.
mappings.
servletFilters.
Thefollowingtabledescribesthestructureofthissectionoftheresponse:40PathTypeDescription[].
servletNameMappingsArrayNamesoftheservletstowhichthefilterismapped.
[].
urlPatternMappingsArrayURLpatterntowhichthefilterismapped.
[].
nameStringNameofthefilter.
[].
classNameStringClassnameofthefilter15.
1.
5.
DispatcherHandlersResponseStructureWhenusingSpringWebFlux,theresponsecontainsdetailsofanyDispatcherHandlerrequestmappingsbeneathcontexts.
*.
mappings.
dispatcherHandlers.
Thefollowingtabledescribesthestructureofthissectionoftheresponse:PathTypeDescription*ArrayDispatcherhandlermappings,ifany,keyedbydispatcherhandlerbeanname.
*.
[].
detailsObjectAdditionalimplementation-specificdetailsaboutthemapping.
Optional.
*.
[].
handlerStringHandlerforthemapping.
*.
[].
predicateStringPredicateforthemapping.
*.
[].
details.
requestMappingConditionsObjectDetailsoftherequestmappingconditions.
*.
[].
details.
requestMappingConditions.
consumesArrayDetailsoftheconsumescondition*.
[].
details.
requestMappingConditions.
consumes.
[].
mediaTypeStringConsumedmediatype.
*.
[].
details.
requestMappingConditions.
consumes.
[].
negatedBooleanWhetherthemediatypeisnegated.
*.
[].
details.
requestMappingConditions.
headersArrayDetailsoftheheaderscondition.
*.
[].
details.
requestMappingConditions.
headers.
[].
nameStringNameoftheheader.
*.
[].
details.
requestMappingConditions.
headers.
[].
valueStringRequiredvalueoftheheader,ifany.
*.
[].
details.
requestMappingConditions.
headers.
[].
negatedBooleanWhetherthevalueisnegated.
*.
[].
details.
requestMappingConditions.
methodsArrayHTTPmethodsthatarehandled.
41PathTypeDescription*.
[].
details.
requestMappingConditions.
paramsArrayDetailsoftheparamscondition.
*.
[].
details.
requestMappingConditions.
params.
[].
nameStringNameoftheparameter.
*.
[].
details.
requestMappingConditions.
params.
[].
valueStringRequiredvalueoftheparameter,ifany.
*.
[].
details.
requestMappingConditions.
params.
[].
negatedBooleanWhetherthevalueisnegated.
*.
[].
details.
requestMappingConditions.
patternsArrayPatternsidentifyingthepathshandledbythemapping.
*.
[].
details.
requestMappingConditions.
producesArrayDetailsoftheproducescondition.
*.
[].
details.
requestMappingConditions.
produces.
[].
mediaTypeStringProducedmediatype.
*.
[].
details.
requestMappingConditions.
produces.
[].
negatedBooleanWhetherthemediatypeisnegated.
*.
[].
details.
handlerMethodObjectDetailsofthemethod,ifany,thatwillhandlerequeststothismapping.
*.
[].
details.
handlerMethod.
classNameStringFullyqualifiednameoftheclassofthemethod.
*.
[].
details.
handlerMethod.
nameStringNameofthemethod.
*.
[].
details.
handlerMethod.
descriptorStringDescriptorofthemethodasspecifiedintheJavaLanguageSpecification.
*.
[].
details.
handlerFunctionObjectDetailsofthefunction,ifany,thatwillhandlerequeststothismapping.
*.
[].
details.
handlerFunction.
classNameStringFullyqualifiednameoftheclassofthefunction.
42Chapter16.
Metrics(metrics)Themetricsendpointprovidesaccesstoapplicationmetrics.
16.
1.
RetrievingMetricNamesToretrievethenamesoftheavailablemetrics,makeaGETrequestto/actuator/metrics,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/metrics'-i-XGETTheresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:154{"names":["jvm.
memory.
max","jvm.
memory.
committed","jvm.
buffer.
memory.
used","jvm.
memory.
used","jvm.
buffer.
count","jvm.
buffer.
total.
capacity"]}16.
1.
1.
ResponseStructureTheresponsecontainsdetailsofthemetricnames.
Thefollowingtabledescribesthestructureoftheresponse:PathTypeDescriptionnamesArrayNamesoftheknownmetrics.
16.
2.
RetrievingaMetricToretrieveametric,makeaGETrequestto/actuator/metrics/{metric.
name},asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/metrics/jvm.
memory.
max'-i-XGETTheprecedingexampleretrievesinformationaboutthemetricnamedjvm.
memory.
max.
Theresultingresponseissimilartothefollowing:43HTTP/1.
1200OKContent-Disposition:inline;filename=f.
txtContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:352{"name":"jvm.
memory.
max","measurements":[{"statistic":"VALUE","value":2.
375548927E9}],"availableTags":[{"tag":"area","values":["heap","nonheap"]},{"tag":"id","values":["CompressedClassSpace","PSOldGen","PSSurvivorSpace","Metaspace","PSEdenSpace","CodeCache"]}]}16.
2.
1.
QueryParametersTheendpointusesqueryparameterstodrilldownintoametricbyusingitstags.
Thefollowingtableshowsthesinglesupportedqueryparameter:ParameterDescriptiontagAtagtousefordrill-downintheformname:value.
16.
2.
2.
ResponsestructureTheresponsecontainsdetailsofthemetric.
Thefollowingtabledescribesthestructureoftheresponse:PathTypeDescriptionnameStringNameofthemetricmeasurementsArrayMeasurementsofthemetricmeasurements[].
statisticStringStatisticofthemeasurement.
(TOTAL,TOTAL_TIME,COUNT,MAX,VALUE,UNKNOWN,ACTIVE_TASKS,DURATION).
measurements[].
valueNumberValueofthemeasurement.
availableTagsArrayTagsthatareavailablefordrill-down.
44PathTypeDescriptionavailableTags[].
tagStringNameofthetag.
availableTags[].
valuesArrayPossiblevaluesofthetag.
16.
3.
DrillingDownTodrilldownintoametric,makeaGETrequestto/actuator/metrics/{metric.
name}usingthetagqueryparameter,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/metrics/jvm.
memory.
maxtag=area%3Anonheap&tag=id%3ACompressed+Class+Space'-i-XGETTheprecedingexampleretrievesthejvm.
memory.
maxmetric,wheretheareataghasavalueofnonheapandtheidattributehasavalueofCompressedClassSpace.
Theresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Disposition:inline;filename=f.
txtContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:141{"name":"jvm.
memory.
max","measurements":[{"statistic":"VALUE","value":1.
073741824E9}],"availableTags":[]}45Chapter17.
Prometheus(prometheus)TheprometheusendpointprovidesSpringBootapplication'smetricsintheformatrequiredforscrapingbyaPrometheusserver.
17.
1.
RetrievingtheMetricsToretrievethemetrics,makeaGETrequestto/actuator/prometheus,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/prometheus'-i-XGETTheresultingresponseissimilartothefollowing:46HTTP/1.
1200OKContent-Type:text/plain;version=0.
0.
4;charset=utf-8Content-Length:2338#HELPjvm_memory_used_bytesTheamountofusedmemory#TYPEjvm_memory_used_bytesgaugejvm_memory_used_bytes{area="nonheap",id="CodeCache",}4.
366336E7jvm_memory_used_bytes{area="nonheap",id="Metaspace",}1.
30893136E8jvm_memory_used_bytes{area="nonheap",id="CompressedClassSpace",}1.
7669808E7jvm_memory_used_bytes{area="heap",id="PSEdenSpace",}1.
14648736E8jvm_memory_used_bytes{area="heap",id="PSSurvivorSpace",}9681680.
0jvm_memory_used_bytes{area="heap",id="PSOldGen",}1.
13441728E8#HELPjvm_buffer_countAnestimateofthenumberofbuffersinthepool#TYPEjvm_buffer_countgaugejvm_buffer_count{id="direct",}3.
0jvm_buffer_count{id="mapped",}0.
0#HELPjvm_buffer_memory_used_bytesAnestimateofthememorythattheJavavirtualmachineisusingforthisbufferpool#TYPEjvm_buffer_memory_used_bytesgaugejvm_buffer_memory_used_bytes{id="direct",}28052.
0jvm_buffer_memory_used_bytes{id="mapped",}0.
0#HELPjvm_buffer_total_capacity_bytesAnestimateofthetotalcapacityofthebuffersinthispool#TYPEjvm_buffer_total_capacity_bytesgaugejvm_buffer_total_capacity_bytes{id="direct",}28051.
0jvm_buffer_total_capacity_bytes{id="mapped",}0.
0#HELPjvm_memory_committed_bytesTheamountofmemoryinbytesthatiscommittedfortheJavavirtualmachinetouse#TYPEjvm_memory_committed_bytesgaugejvm_memory_committed_bytes{area="nonheap",id="CodeCache",}4.
4957696E7jvm_memory_committed_bytes{area="nonheap",id="Metaspace",}1.
38747904E8jvm_memory_committed_bytes{area="nonheap",id="CompressedClassSpace",}1.
9267584E7jvm_memory_committed_bytes{area="heap",id="PSEdenSpace",}3.
0932992E8jvm_memory_committed_bytes{area="heap",id="PSSurvivorSpace",}2.
3068672E7jvm_memory_committed_bytes{area="heap",id="PSOldGen",}3.
26631424E8#HELPjvm_memory_max_bytesThemaximumamountofmemoryinbytesthatcanbeusedformemorymanagement#TYPEjvm_memory_max_bytesgaugejvm_memory_max_bytes{area="nonheap",id="CodeCache",}2.
5165824E8jvm_memory_max_bytes{area="nonheap",id="Metaspace",}-1.
0jvm_memory_max_bytes{area="nonheap",id="CompressedClassSpace",}1.
073741824E9jvm_memory_max_bytes{area="heap",id="PSEdenSpace",}3.
12475648E8jvm_memory_max_bytes{area="heap",id="PSSurvivorSpace",}2.
3068672E7jvm_memory_max_bytes{area="heap",id="PSOldGen",}7.
16177408E847Chapter18.
ScheduledTasks(scheduledtasks)Thescheduledtasksendpointprovidesinformationabouttheapplication'sscheduledtasks.
18.
1.
RetrievingtheScheduledTasksToretrievethescheduledtasks,makeaGETrequestto/actuator/scheduledtasks,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/scheduledtasks'-i-XGETTheresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:451{"cron":[{"runnable":{"target":"com.
example.
Processor.
processOrders"},"expression":"000/31/1*"}],"fixedDelay":[{"runnable":{"target":"com.
example.
Processor.
purge"},"initialDelay":5000,"interval":5000}],"fixedRate":[{"runnable":{"target":"com.
example.
Processor.
retrieveIssues"},"initialDelay":10000,"interval":3000}]}18.
1.
1.
ResponseStructureTheresponsecontainsdetailsoftheapplication'sscheduledtasks.
Thefollowingtabledescribesthestructureoftheresponse:48PathTypeDescriptioncronArrayCrontasks,ifany.
cron.
[]runnable.
targetStringTargetthatwillbeexecuted.
cron.
[].
expressionStringCronexpression.
fixedDelayArrayFixeddelaytasks,ifany.
fixedDelay.
[]runnable.
targetStringTargetthatwillbeexecuted.
fixedDelay.
[].
initialDelayNumberDelay,inmilliseconds,beforefirstexecution.
fixedDelay.
[].
intervalNumberInterval,inmilliseconds,betweentheendofthelastexecutionandthestartofthenext.
fixedRateArrayFixedratetasks,ifany.
fixedRate.
[].
runnable.
targetStringTargetthatwillbeexecuted.
fixedRate.
[].
intervalNumberInterval,inmilliseconds,betweenthestartofeachexecution.
fixedRate.
[].
initialDelayNumberDelay,inmilliseconds,beforefirstexecution.
49Chapter19.
Sessions(sessions)Thesessionsendpointprovidesinformationabouttheapplication'sHTTPsessionsthataremanagedbySpringSession.
19.
1.
RetrievingSessionsToretrievethesessions,makeaGETrequestto/actuator/sessions,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/sessionsusername=alice'-i-XGETTheprecedingexamplesretrievesallofthesessionsfortheuserwhoseusernameisalice.
Theresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:753{"sessions":[{"id":"6861ef7e-5f98-497d-b94d-b3498fccb57c","attributeNames":[],"creationTime":"2018-04-04T23:46:12.
260Z","lastAccessedTime":"2018-04-05T11:45:27.
260Z","maxInactiveInterval":1800,"expired":false},{"id":"8d71f697-6f3c-446d-aa19-4af5ca9b085c","attributeNames":[],"creationTime":"2018-04-05T09:46:12.
261Z","lastAccessedTime":"2018-04-05T11:46:00.
261Z","maxInactiveInterval":1800,"expired":false},{"id":"4db5efcc-99cb-4d05-a52c-b49acfbb7ea9","attributeNames":[],"creationTime":"2018-04-05T06:46:12.
261Z","lastAccessedTime":"2018-04-05T11:45:35.
261Z","maxInactiveInterval":1800,"expired":false}]}5019.
1.
1.
QueryParametersTheendpointusesqueryparameterstolimitthesessionsthatitreturns.
Thefollowingtableshowsthesinglerequiredqueryparameter:ParameterDescriptionusernameNameoftheuser.
19.
1.
2.
ResponseStructureTheresponsecontainsdetailsofthematchingsessions.
Thefollowingtabledescribesthestructureoftheresponse:PathTypeDescriptionsessionsArraySessionsforthegivenusername.
sessions.
[].
idStringIDofthesession.
sessions.
[].
attributeNamesArrayNamesoftheattributesstoredinthesession.
sessions.
[].
creationTimeStringTimestampofwhenthesessionwascreated.
sessions.
[].
lastAccessedTimeStringTimestampofwhenthesessionwaslastaccessed.
sessions.
[].
maxInactiveIntervalNumberMaximumpermittedperiodofinactivity,inseconds,beforethesessionwillexpire.
sessions.
[].
expiredBooleanWhetherthesessionhasexpired.
19.
2.
RetrievingaSingleSessionToretrieveasinglesession,makeaGETrequestto/actuator/sessions/{id},asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/sessions/4db5efcc-99cb-4d05-a52c-b49acfbb7ea9'-i-XGETTheprecedingexampleretrievesthesessionwiththeidof4db5efcc-99cb-4d05-a52c-b49acfbb7ea9.
Theresultingresponseissimilartothefollowing:51HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:228{"id":"4db5efcc-99cb-4d05-a52c-b49acfbb7ea9","attributeNames":[],"creationTime":"2018-04-05T06:46:12.
261Z","lastAccessedTime":"2018-04-05T11:45:35.
261Z","maxInactiveInterval":1800,"expired":false}19.
2.
1.
ResponseStructureTheresponsecontainsdetailsoftherequestedsession.
Thefollowingtabledescribesthestructureoftheresponse:PathTypeDescriptionidStringIDofthesession.
attributeNamesArrayNamesoftheattributesstoredinthesession.
creationTimeStringTimestampofwhenthesessionwascreated.
lastAccessedTimeStringTimestampofwhenthesessionwaslastaccessed.
maxInactiveIntervalNumberMaximumpermittedperiodofinactivity,inseconds,beforethesessionwillexpire.
expiredBooleanWhetherthesessionhasexpired.
19.
3.
DeletingaSessionTodeleteasession,makeaDELETErequestto/actuator/sessions/{id},asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/sessions/4db5efcc-99cb-4d05-a52c-b49acfbb7ea9'-i-XDELETETheprecedingexampledeletesthesessionwiththeidof4db5efcc-99cb-4d05-a52c-b49acfbb7ea9.
52Chapter20.
Shutdown(shutdown)Theshutdownendpointisusedtoshutdowntheapplication.
20.
1.
ShuttingDowntheApplicationToshutdowntheapplication,makeaPOSTrequestto/actuator/shutdown,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/shutdown'-i-XPOSTAresponsesimilartothefollowingisproduced:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:41{"message":"Shuttingdown,bye.
.
.
"}20.
1.
1.
ResponseStructureTheresponsecontainsdetailsoftheresultoftheshutdownrequest.
Thefollowingtabledescribesthestructureoftheresponse:PathTypeDescriptionmessageStringMessagedescribingtheresultoftherequest.
53Chapter21.
ThreadDump(threaddump)Thethreaddumpendpointprovidesathreaddumpfromtheapplication'sJVM.
21.
1.
RetrievingtheThreadDumpToretrievethethreaddump,makeaGETrequestto/actuator/threaddump,asshowninthefollowingcurl-basedexample:$curl'http://localhost:8080/actuator/threaddump'-i-XGETTheresultingresponseissimilartothefollowing:HTTP/1.
1200OKContent-Type:application/vnd.
spring-boot.
actuator.
v2+json;charset=UTF-8Content-Length:4522{"threads":[{"threadName":"Thread-200","threadId":543,"blockedTime":-1,"blockedCount":0,"waitedTime":-1,"waitedCount":1,"lockOwnerId":-1,"inNative":false,"suspended":false,"threadState":"TIMED_WAITING","stackTrace":[{"methodName":"sleep","fileName":"Thread.
java","lineNumber":-2,"className":"java.
lang.
Thread","nativeMethod":true},{"methodName":"performShutdown","fileName":"ShutdownEndpoint.
java","lineNumber":67,"className":"org.
springframework.
boot.
actuate.
context.
ShutdownEndpoint","nativeMethod":false},{"methodName":"run","lineNumber":-1,"className":"org.
springframework.
boot.
actuate.
context.
ShutdownEndpoint$$Lambda$1135/1435566314","nativeMethod":false},{54"methodName":"run","fileName":"Thread.
java","lineNumber":748,"className":"java.
lang.
Thread","nativeMethod":false}],"lockedMonitors":[],"lockedSynchronizers":[]},{"threadName":"pool-16-thread-1","threadId":538,"blockedTime":-1,"blockedCount":0,"waitedTime":-1,"waitedCount":2,"lockName":"java.
util.
concurrent.
locks.
AbstractQueuedSynchronizer$ConditionObject@5d82f1c5","lockOwnerId":-1,"inNative":false,"suspended":false,"threadState":"TIMED_WAITING","stackTrace":[{"methodName":"park","fileName":"Unsafe.
java","lineNumber":-2,"className":"sun.
misc.
Unsafe","nativeMethod":true},{"methodName":"parkNanos","fileName":"LockSupport.
java","lineNumber":215,"className":"java.
util.
concurrent.
locks.
LockSupport","nativeMethod":false},{"methodName":"awaitNanos","fileName":"AbstractQueuedSynchronizer.
java","lineNumber":2078,"className":"java.
util.
concurrent.
locks.
AbstractQueuedSynchronizer$ConditionObject","nativeMethod":false},{"methodName":"take","fileName":"ScheduledThreadPoolExecutor.
java","lineNumber":1093,"className":"java.
util.
concurrent.
ScheduledThreadPoolExecutor$DelayedWorkQueue","nativeMethod":false},{"methodName":"take","fileName":"ScheduledThreadPoolExecutor.
java","lineNumber":809,55"className":"java.
util.
concurrent.
ScheduledThreadPoolExecutor$DelayedWorkQueue","nativeMethod":false},{"methodName":"getTask","fileName":"ThreadPoolExecutor.
java","lineNumber":1074,"className":"java.
util.
concurrent.
ThreadPoolExecutor","nativeMethod":false},{"methodName":"runWorker","fileName":"ThreadPoolExecutor.
java","lineNumber":1134,"className":"java.
util.
concurrent.
ThreadPoolExecutor","nativeMethod":false},{"methodName":"run","fileName":"ThreadPoolExecutor.
java","lineNumber":624,"className":"java.
util.
concurrent.
ThreadPoolExecutor$Worker","nativeMethod":false},{"methodName":"run","fileName":"Thread.
java","lineNumber":748,"className":"java.
lang.
Thread","nativeMethod":false}],"lockedMonitors":[],"lockedSynchronizers":[],"lockInfo":{"className":"java.
util.
concurrent.
locks.
AbstractQueuedSynchronizer$ConditionObject","identityHashCode":1568862661}},{"threadName":"http-nio-auto-9-39983-AsyncTimeout","threadId":534,"blockedTime":-1,"blockedCount":0,"waitedTime":-1,"waitedCount":5,"lockOwnerId":-1,"inNative":false,"suspended":false,"threadState":"TIMED_WAITING","stackTrace":[{"methodName":"sleep","fileName":"Thread.
java","lineNumber":-2,"className":"java.
lang.
Thread",56"nativeMethod":true},{"methodName":"run","fileName":"AbstractProtocol.
java","lineNumber":1133,"className":"org.
apache.
coyote.
AbstractProtocol$AsyncTimeout","nativeMethod":false},{"methodName":"run","fileName":"Thread.
java","lineNumber":748,"className":"java.
lang.
Thread","nativeMethod":false}],"lockedMonitors":[],"lockedSynchronizers":[]}]}21.
1.
1.
ResponseStructureTheresponsecontainsdetailsoftheJVM'sthreads.
Thefollowingtabledescribesthestructureoftheresponse:PathTypeDescriptionthreadsArrayJVM'sthreads.
threads.
[].
blockedCountNumberTotalnumberoftimesthatthethreadhasbeenblocked.
threads.
[].
blockedTimeNumberTimeinmillisecondsthatthethreadhasspentblocked.
-1ifthreadcontentionmonitoringisdisabled.
threads.
[].
daemonBooleanWhetherthethreadisadaemonthread.
OnlyavailableonJava9orlater.
threads.
[].
inNativeBooleanWhetherthethreadisexecutingnativecode.
threads.
[].
lockNameStringDescriptionoftheobjectonwhichthethreadisblocked,ifany.
threads.
[].
lockInfoObjectObjectforwhichthethreadisblockedwaiting.
threads.
[].
lockInfo.
classNameStringFullyqualifiedclassnameofthelockobject.
57PathTypeDescriptionthreads.
[].
lockInfo.
identityHashCodeNumberIdentityhashcodeofthelockobject.
threads.
[].
lockedMonitorsArrayMonitorslockedbythisthread,ifanythreads.
[].
lockedMonitors.
[].
classNameStringClassnameofthelockobject.
threads.
[].
lockedMonitors.
[].
identityHashCodeNumberIdentityhashcodeofthelockobject.
threads.
[].
lockedMonitors.
[].
lockedStackDepthNumberStackdepthwherethemonitorwaslocked.
threads.
[].
lockedMonitors.
[].
lockedStackFrameObjectStackframethatlockedthemonitor.
threads.
[].
lockedSynchronizersArraySynchronizerslockedbythisthread.
threads.
[].
lockedSynchronizers.
[].
classNameStringClassnameofthelockedsynchronizer.
threads.
[].
lockedSynchronizers.
[].
identifyHashCodeNumberIdentityhashcodeofthelockedsynchronizer.
threads.
[].
lockOwnerIdNumberIDofthethreadthatownstheobjectonwhichthethreadisblocked.
-1ifthethreadisnotblocked.
threads.
[].
lockOwnerNameStringNameofthethreadthatownstheobjectonwhichthethreadisblocked,ifany.
threads.
[].
priorityNumberPriorityofthethread.
OnlyavailableonJava9orlater.
threads.
[].
stackTraceArrayStacktraceofthethread.
threads.
[].
stackTrace.
[].
classLoaderNameStringNameoftheclassloaderoftheclassthatcontainstheexecutionpointidentifiedbythisentry,ifany.
OnlyavailableonJava9orlater.
threads.
[].
stackTrace.
[].
classNameStringNameoftheclassthatcontainstheexecutionpointidentifiedbythisentry.
threads.
[].
stackTrace.
[].
fileNameStringNameofthesourcefilethatcontainstheexecutionpointidentifiedbythisentry,ifany.
58PathTypeDescriptionthreads.
[].
stackTrace.
[].
lineNumberNumberLinenumberoftheexecutionpointidentifiedbythisentry.
Negativeifunknown.
threads.
[].
stackTrace.
[].
methodNameStringNameofthemethod.
threads.
[].
stackTrace.
[].
moduleNameStringNameofthemodulethatcontainstheexecutionpointidentifiedbythisentry,ifany.
OnlyavailableonJava9orlater.
threads.
[].
stackTrace.
[].
moduleVersionStringVersionofthemodulethatcontainstheexecutionpointidentifiedbythisentry,ifany.
OnlyavailableonJava9orlater.
threads.
[].
stackTrace.
[].
nativeMethodBooleanWhethertheexecutionpointisanativemethod.
threads.
[].
suspendedBooleanWhetherthethreadissuspended.
threads.
[].
threadIdNumberIDofthethread.
threads.
[].
threadNameStringNameofthethread.
threads.
[].
threadStateStringStateofthethread(NEW,RUNNABLE,BLOCKED,WAITING,TIMED_WAITING,TERMINATED).
threads.
[].
waitedCountNumberTotalnumberoftimesthatthethreadhaswaitedfornotification.
threads.
[].
waitedTimeNumberTimeinmillisecondsthatthethreadhasspentwaiting.
-1ifthreadcontentionmonitoringisdisabled59