Performance Monitoring

Codahale Metrics is integrated into the framework.

• Counters are provided on service admin methods and meters on resource access (CRUD) methods.
• Monitoring page at http://host:port/restsql/monitoring
• Database health check as a simple ping ("SELECT 1") available at http://host:port/restsql/monitoring/healthcheck
• Thread dump at http://host:port/restsql/monitoring/threads
• restSQL availability tool - suitable for external ping at http://host:port/restsql/monitoring/ping

The following interfaces are available to access the metrics:

• HTTP/JSON at http://host:port/restsql/monitoring/metrics
• JMX - JRMC, VisualVM, JConsole. Metrics names start with org.restsql.service.
• Ganglia - see restsql.properties configuration in next section
• Graphite- see restsql.properties configuration in next section

Configuration

Out of the box the metrics are available to the HTTP/JSON and JMX interfaces.

Reporting to Ganglia is configured in the restsql.properties as follows:

# Ganglia monitoring configuration
monitoring.ganglia.host=hostName or ipAddress
monitoring.ganglia.port=portNumber
monitoring.ganglia.ttl=numberOfRouterHops
monitoring.ganglia.udpMode=[unicast,multicast]
monitoring.ganglia.frequency=seconds

Reporting to Graphite is configured in the restsql.properties as follows:

# Graphite monitoring configuration
monitoring.graphite.host=hostName or ipAddress
monitoring.graphite.port=portNumber
monitoring.graphite.frequency=seconds

Customization if availble via the MonitoringManager interface. The framework will use the default implementation if your restsql.properties file excludes the definition. The default in the restsql.properties is as follows:

# Implementation classes - use these to customize the framework
...
org.restsql.service.monitoring.MonitoringManager=org.restsql.service.monitoring.MonitoringManagerImpl