org.apache.cocoon.webservices.instrument
Interface InstrumentationService

All Superinterfaces:

Component, InstrumentManageable

All Known Implementing Classes:

InstrumentationServiceImpl

public interface InstrumentationService
extends InstrumentManageable, Component

Component interface for retrieving sample information from the InstrumentManager.

Version:

CVS $Id: InstrumentationService.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Marcus Crafter

Field Summary

static String

ROLE Component ROLE name

Method Summary

String[]	getSampleNames() Obtains an array of instrumentable sample names
int[]	getSampleSnapshot(String path) Obtain an array of samples from a specified sample name.

Methods inherited from interface org.apache.excalibur.instrument.InstrumentManageable

setInstrumentManager

Field Detail

ROLE

static final String ROLE

Component ROLE name

Method Detail

getSampleSnapshot

int[] getSampleSnapshot(String path)
                        throws Exception

Obtain an array of samples from a specified sample name.

The specified path parameter identifies a sample, hierarchically from Instrumentable name to Instrument name, to Instrument sample name (including any child Instrumentables) using the '.' character as a separator.

  eg: instrument-manager.active-thread-count.maximum_1000_600
 

The above example identifies the sample 'maximum_1000_600' on instrument 'active-thread-count', on instrumentable 'instrument-manager'.

The length of the returned array is dependant on the configuration of the sample being accessed. Check instrumentation.xconf for the length of pre- defined samples that operate constantly, when instrumentation is enabled.

Parameters:

path - path value

Returns:

an int[] array of samples

Throws:

Exception - if an error occurs

getSampleNames

String[] getSampleNames()

Obtains an array of instrumentable sample names

Returns:

a String[] array of sample names