sirius.web.health

Class SystemController

java.lang.Object

sirius.web.controller.BasicController

sirius.web.health.SystemController

All Implemented Interfaces:

Controller

public class SystemController
extends BasicController

Contains the default admin GUI.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERMISSION_SYSTEM_CONSOLE Describes the permission required to access the system console.
static String	PERMISSION_SYSTEM_STATE Describes the permission required to view the system state.
static String	PERMISSION_SYSTEM_TIMING Describes the permission required to access the system console.

Fields inherited from class sirius.web.controller.BasicController

defaultRoute

Constructor Summary

Constructors

Constructor and Description
SystemController()

Method Summary

Modifier and Type	Method and Description
void	console(WebContext ctx)
void	fail(WebContext ctx) Can be used to forcefully create an error.
void	info(WebContext ctx) Reports useful information for the current user agent and request.
void	metric(WebContext ctx, String key) Sends the value for the requested metric for /system/metric/[name]
void	monitorNode(WebContext ctx) Determines if there is currently an ALARM present or not for: /system/monitor Either reports OK or ERROR, if the cluster state is RED for at least two intervals (minutes).
void	ok(WebContext ctx) Simply responds with OK for /system/ok This can be used to monitoring tools the check the system health.
void	reset(WebContext ctx) Clears the server and client session.
void	state(WebContext ctx) Reports the system and cluster state.
void	timing(WebContext ctx) Provides a list of recorded micro timings.

Methods inherited from class sirius.web.controller.BasicController

assertNotNull, assertPermission, fail, getUser, hasPermission, onError, showDeletedMessage, showSavedMessage

Methods inherited from class java.lang.Object

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

Field Detail

PERMISSION_SYSTEM_CONSOLE

public static final String PERMISSION_SYSTEM_CONSOLE

Describes the permission required to access the system console.

See Also:

Constant Field Values

PERMISSION_SYSTEM_TIMING

public static final String PERMISSION_SYSTEM_TIMING

Describes the permission required to access the system console.

See Also:

Constant Field Values

PERMISSION_SYSTEM_STATE

public static final String PERMISSION_SYSTEM_STATE

Describes the permission required to view the system state.

See Also:

Constant Field Values

Constructor Detail

SystemController

public SystemController()

Method Detail

console

public void console(WebContext ctx)

ok

public void ok(WebContext ctx)

Simply responds with OK for /system/ok

This can be used to monitoring tools the check the system health.

Parameters:

ctx - the request being handled

monitorNode

public void monitorNode(WebContext ctx)

Determines if there is currently an ALARM present or not for: /system/monitor

Either reports OK or ERROR, if the cluster state is RED for at least two intervals (minutes).

Parameters:

ctx - the request being handled

metric

public void metric(WebContext ctx,
                   String key)

Sends the value for the requested metric for /system/metric/[name]

Parameters:

ctx - the request being handled

key - the name of the metric to fetch

fail

public void fail(WebContext ctx)

Can be used to forcefully create an error. (A HandledException in this case.)

Parameters:

ctx - the current request

info

public void info(WebContext ctx)

Reports useful information for the current user agent and request.

This will output all headers and session information available for the current request

Parameters:

ctx - the current request

reset

public void reset(WebContext ctx)

Clears the server and client session.

Clears all session data available for the current request.

Parameters:

ctx - the current request

state

public void state(WebContext ctx)

Reports the system and cluster state.

Parameters:

ctx - the current request

timing

public void timing(WebContext ctx)

Provides a list of recorded micro timings.

Parameters:

ctx - the current request