org.springframework.analytics.rest.controller

Class CounterController

java.lang.Object

org.springframework.analytics.rest.controller.CounterController

@RestController
@RequestMapping(value="/metrics/counters")
@ExposesResourceFor(value=CounterResource.class)
public class CounterController
extends Object

Allows interaction with Counters.

Author:

Eric Bottard, Mark Fisher

Field Summary

Fields

Modifier and Type	Field and Description
static String	COUNTER_PREFIX
protected org.springframework.hateoas.ResourceAssembler<org.springframework.boot.actuate.metrics.Metric<Double>,? extends MetricResource>	shallowResourceAssembler

Constructor Summary

Constructors

Constructor and Description
CounterController(org.springframework.boot.actuate.metrics.repository.MetricRepository metricRepository) Create a CounterController that delegates to the provided MetricRepository.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	delete(String name) Delete (reset) a specific counter.
CounterResource	display(String name) Retrieve information about a specific counter.
org.springframework.hateoas.PagedResources<? extends MetricResource>	list(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<org.springframework.boot.actuate.metrics.Metric<Double>> pagedAssembler, boolean detailed) List Counters that match the given criteria.

Methods inherited from class java.lang.Object

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

Field Detail

COUNTER_PREFIX

public static final String COUNTER_PREFIX

See Also:

Constant Field Values

shallowResourceAssembler

protected final org.springframework.hateoas.ResourceAssembler<org.springframework.boot.actuate.metrics.Metric<Double>,? extends MetricResource> shallowResourceAssembler

Constructor Detail

CounterController

public CounterController(org.springframework.boot.actuate.metrics.repository.MetricRepository metricRepository)

Create a CounterController that delegates to the provided MetricRepository.

Parameters:

metricRepository - the MetricRepository used by this controller

Method Detail

list

@RequestMapping(value="",
                method=GET)
public org.springframework.hateoas.PagedResources<? extends MetricResource> list(org.springframework.data.domain.Pageable pageable,
                                                                                       org.springframework.data.web.PagedResourcesAssembler<org.springframework.boot.actuate.metrics.Metric<Double>> pagedAssembler,
                                                                                       @RequestParam(value="detailed",defaultValue="false")
                                                                                       boolean detailed)

List Counters that match the given criteria.

display

@RequestMapping(value="/{name}",
                method=GET)
public CounterResource display(@PathVariable(value="name")
                                     String name)

Retrieve information about a specific counter.

delete

@RequestMapping(value="/{name}",
                method=DELETE)
@ResponseStatus(value=OK)
protected void delete(@PathVariable(value="name")
                                        String name)

Delete (reset) a specific counter.