com.netflix.genie.web.aspect

Class HealthCheckMetricsAspect

java.lang.Object

com.netflix.genie.web.aspect.HealthCheckMetricsAspect

@Component
public class HealthCheckMetricsAspect
extends java.lang.Object

Aspect woven into Spring Boot 'Health' machinery to publish metrics such as time taken, errors and other signals useful for dashboards and alerting.

Since:

3.2.4

Constructor Summary

Constructors

Constructor and Description
HealthCheckMetricsAspect(com.netflix.spectator.api.Registry registry) Autowired constructor.

Method Summary

Modifier and Type	Method and Description
void	abstractHealthAggregatorAggregateDetailsMonitor(org.aspectj.lang.JoinPoint joinPoint) Intercept calls to the main AbstractHealthAggregator and publish counters for number of invocation and failures, tagged with status and indicator name.
void	abstractHealthIndicatorDoHealthCheckMonitor(org.aspectj.lang.ProceedingJoinPoint joinPoint) Intercept call to AbstractHealthIndicator beans loaded and publish a timer tagged with error, if any.
org.springframework.boot.actuate.health.Health	healthEndpointInvokeMonitor(org.aspectj.lang.ProceedingJoinPoint joinPoint) Intercept call to the Health endpoint publish a timer tagged with error, status.
org.springframework.boot.actuate.health.Health	healthIndicatorHealthMonitor(org.aspectj.lang.ProceedingJoinPoint joinPoint) Intercept call to HealthIndicator beans loaded and publish a timer tagged with error, if any.

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheckMetricsAspect

@Autowired
public HealthCheckMetricsAspect(com.netflix.spectator.api.Registry registry)

Autowired constructor.

Parameters:

registry - metrics registry

Method Detail

healthEndpointInvokeMonitor

public org.springframework.boot.actuate.health.Health healthEndpointInvokeMonitor(org.aspectj.lang.ProceedingJoinPoint joinPoint)
                                                                           throws java.lang.Throwable

Intercept call to the Health endpoint publish a timer tagged with error, status.

Parameters:

joinPoint - joinPoint for the actual call to invoke()

Returns:

Health, as returned by the actual invocation

Throws:

java.lang.Throwable - as thrown by joinPoint.proceed()

healthIndicatorHealthMonitor

public org.springframework.boot.actuate.health.Health healthIndicatorHealthMonitor(org.aspectj.lang.ProceedingJoinPoint joinPoint)
                                                                            throws java.lang.Throwable

Intercept call to HealthIndicator beans loaded and publish a timer tagged with error, if any.

Parameters:

joinPoint - joinPoint for the actual call to health()

Returns:

Health, as returned by the actual invocation

Throws:

java.lang.Throwable - as thrown by joinPoint.proceed()

abstractHealthIndicatorDoHealthCheckMonitor

public void abstractHealthIndicatorDoHealthCheckMonitor(org.aspectj.lang.ProceedingJoinPoint joinPoint)
                                                 throws java.lang.Throwable

Intercept call to AbstractHealthIndicator beans loaded and publish a timer tagged with error, if any. This interception is required because these beans are not captured by HealthIndicator.doHealthCheck(), even tho they implement that interface.

Parameters:

joinPoint - joinPoint for the actual call to doHealthCheck()

Throws:

java.lang.Throwable - as thrown by joinPoint.proceed()

abstractHealthAggregatorAggregateDetailsMonitor

public void abstractHealthAggregatorAggregateDetailsMonitor(org.aspectj.lang.JoinPoint joinPoint)

Intercept calls to the main AbstractHealthAggregator and publish counters for number of invocation and failures, tagged with status and indicator name.

Parameters:

joinPoint - joinPoint for the aggregateDetails() call