AGP - Status tjänst
Inledning
AGP 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 AGP fungerar samt att support- och servicepersonal snabbt skall kunna se status och versionsinformation.
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
agp.status.url=http://0.0.0.0:1080/status |
Se även konfigureringsdokumentationen för AGP.
Beskrivning av statussvar
Statustjänsten returnerar en json map med följande nycklar:
Nyckel | Beskrivning |
|---|---|
Name | Namn på applikationen, "apg-application" |
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, "camel-1" |
JavaVersion | Java version |
CamelVersion | Version av Camel |
TakCacheInitialized | "true" om tak cache existerar |
TakCacheResetInfo | Information om när TAK cache uppdaterades sist och resultatet |
JvmTotalMemory | JVM total memory |
JvmFreeMemory | JVM free memory |
JvmUsedMemory | JVM used memory |
JvmMaxMemory | JVM max memory |
DirectMemBufferPool | Se nedan. |
NonHeapMemory | Se nedan. |
MaxDirectMemory | Se nedan. |
Endpoints | Endpoints för AGPs exponerade tjänster |
ServiceImplementations | En lista med de konfigurerade aggregerade tjänsterna och deras version |
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. |
NonHeapMemory | Javas minnesanvändning som ligger utanför heapen |
Exempel på statussvar
{
"Name" : "agp-application",
"Version" : "3.0.0",
"BuildTime" : "2020-09-14T09:40",
"ServiceStatus" : "Started",
"Uptime" : "51.499 seconds",
"ManagementName" : "AGP-Camel",
"JavaVersion" : "1.8.0_161",
"CamelVersion" : "3.5.0",
"TakCacheInitialized" : "true",
"TakCacheResetInfo" : "Date:2020-10-23T11:07 Status:REFRESH_OK vagval:1225 behorigheter:2569",
"JvmTotalMemory" : "377,5 MB",
"JvmFreeMemory" : "186,6 MB",
"JvmUsedMemory" : "190,9 MB",
"JvmMaxMemory" : "3,5 GB",
"Endpoints" : [
"jetty:http://0.0.0.0:8091/resetcache",
"jetty:http://0.0.0.0:8080/status",
"cxf://http://0.0.0.0:9010/GetAggregatedActivities/service/v1",
"cxf://http://0.0.0.0:9015/GetAggregatedAlertInformation/service/v2"
],
"ServiceImplementations" : {
"GetAggregatedActivities-v1-main" : "2.0.0",
"GetAggregatedAlertInformation-v2-main" : "2.0.0"
}
} |