SKLTP VP - Status tjänst
Inledning
VP exponerar en tjänst för att visa statusinformation. Den kan nås t.ex. med Curl eller anrop via browser:
curl --data "username=uname&password=pw" http://<serveradress>:8080/status
Eller om man har en lokal installation anrop i en browser (med konfigurerad adress, t.ex.): http://localhost:1080/status
Syftet är att en statusprobe ska kunna anropa denna för att se om VP fungerar samt att support- och servicepersonal snabbt skall kunna se status och versionsinformation för VP.
För instruktioner hur man installerar applikationen, se StatusProbe.
Konfigurering
Port och adress som statustjänsten ska starta på kan konfigureras i application.properties enligt standard springboot förfarande.
Propertynamn enligt nedan:
# address för status tjänst
vp.status.url=http://${vp.host}:1080/status
Se även konfigureringsdokumentationen för VP.
Beskrivning av statussvar
Statustjänsten returnerar en json map med följande nycklar:
| Nyckel | Beskrivning |
|---|---|
| Name | Namn på applikationen, "vp-services-camel" |
| Version | version |
| BuildTime | Datum/tid när applikationen byggdes |
| ServiceStatus | Kommer alltid ha värdet "Started". |
| Uptime | Tiden applikationen har varit uppe |
| ManagementName | Namn på camel management, "vp-services" |
| JavaVersion | Java version |
| CamelVersion | Version av Camel |
| TakCacheInitialized | "true" om tak cache existerar |
| TakCacheResetInfo | Information om när TAK cache uppdaterades sist och resultatet |
| HsaCacheInitialized | "true"´om HSA cache initierats ok |
| HsaCacheResetInfo | information om när HSA cache uppdaterades sist och resultatet |
| JvmTotalMemory | JVM total memory |
| JvmFreeMemory | JVM free memory |
| JvmUsedMemory | JVM used memory |
| JvmMaxMemory | JVM max memory |
| Endpoints | Endpoints för VPs exponerade tjänster |
Extra information av minne kan fås genom att använda parametern "memory"i anropet. Ex. http://<serveradress>:8080/status?memory
| Nyckel | Beskrivning |
|---|---|
DirectMemBufferPool | Javas direct memory användning |
MaxDirectMemory | Max tillåtet direct memory användning (Samma gäller både Javas och Nettys användning). |
NonHeapMemory | Javas minnesanvändning som ligger utanför heapen |
NettyDirectMemory | Det direkta minnet som Netty komponenterna använder. Detta ligger utanför det som visas för Javas användning eftersom Netty använder en egen minnesallocator. Max memory är samma som för Javas max memory (Se MaxDirextMemory) |
Exempel på statussvar
{
"Name": "vp-services-camel",
"Version": "1.0.0-SNAPSHOT",
"BuildTime": "2019-05-23T10:06:04.614Z",
"ServiceStatus": "Started",
"Uptime": "54 minutes",
"ManagementName": "vp-services",
"JavaVersion": "1.8.0_172",
"CamelVersion": "2.24.0",
"TakCacheInitialized": "true",
"TakCacheResetInfo": "Date:2019-05-23T12:20 Status:RESTORED_FROM_LOCAL_CACHE vagval:2 behorigheter:2",
"HsaCacheInitialized": "false",
"HsaCacheResetInfo": "Date:2019-05-23T12:20 Status:false oldNum:0 newNum:0",
"JvmTotalMemory": "478 mB",
"JvmFreeMemory": "261 mB",
"JvmUsedMemory": "216 mB",
"JvmMaxMemory": "3564 mB",
"Endpoints": [
"http://localhost:1080/status",
"http://localhost:24000/resethsacache",
"http://localhost:23000/resetcache",
"https://localhost:443/vp",
"http://localhost:12312/vp"
]
}