Package org.craftercms.engine.controller.rest

Class MonitoringController

java.lang.Object

org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase

org.craftercms.engine.controller.rest.MonitoringController

@Validated
@CrafterRestController
@RequestMapping("/api/1")
public class MonitoringController
extends org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase

Rest controller to provide monitoring information & site logs

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOG_URL
static final String	URL_ROOT

Fields inherited from class org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase

DISK_URL, MEMORY_URL, ROOT_URL, STATUS_URL, SYSINFO_URL, VERSION_URL

Constructor Summary

Constructors

Constructor	Description
MonitoringController(SiteHealthCheckService siteHealthCheckService, String configuredToken)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity	getCurrentStatus(String site, String token)
List<Map<String,Object>>	getLoggedEvents(String site, @jakarta.validation.constraints.Positive long since, String token)

Methods inherited from class org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase

getCurrentMemory, getCurrentSysInfo, getCurrentVersion, validateToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

URL_ROOT

public static final String URL_ROOT

See Also:

• Constant Field Values

LOG_URL

public static final String LOG_URL

See Also:

• Constant Field Values

Constructor Details

MonitoringController

@ConstructorProperties({"siteHealthCheckService","configuredToken"})
public MonitoringController(SiteHealthCheckService siteHealthCheckService,
 String configuredToken)

Method Details

getLoggedEvents

@GetMapping("/monitoring/log")
public List<Map<String,Object>> getLoggedEvents(@RequestParam
 String site,
 @Positive @RequestParam
 @jakarta.validation.constraints.Positive long since,
 @RequestParam
 String token)
                                         throws org.craftercms.commons.exceptions.InvalidManagementTokenException

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException

getCurrentStatus

@GetMapping("/monitoring/status")
public org.springframework.http.ResponseEntity getCurrentStatus(@RequestParam(name="crafterSite",required=false)
 String site,
 @RequestParam(name="token")
 String token)
                                                         throws org.craftercms.commons.exceptions.InvalidManagementTokenException

Overrides:

getCurrentStatus in class org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase

Throws:

org.craftercms.commons.exceptions.InvalidManagementTokenException