jenkins.metrics.api

Class Metrics

java.lang.Object

hudson.Plugin

jenkins.metrics.api.Metrics

All Implemented Interfaces:

hudson.model.Saveable

public class Metrics
extends hudson.Plugin

Entry point for all things metrics.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Metrics.HealthChecker Performs the periodic running of health checks and re-indexing of access keys.
static class	Metrics.HeathCheckMetricsProvider provides the health check related metrics.

Nested classes/interfaces inherited from class hudson.Plugin

hudson.Plugin.DummyImpl

Field Summary

Fields

Modifier and Type	Field and Description
static hudson.security.Permission	HEALTH_CHECK Permission to run healthchecks from the Codahale Metrics Operations Servlet.
static int	HEALTH_CHECK_INTERVAL_MINS The frequency with which to run health checks.
static hudson.security.PermissionGroup	PERMISSIONS Permission group for Metrics related permissions.
static hudson.security.Permission	THREAD_DUMP Permission to get a thread dump from the Codahale Metrics Operations Servlet.
static hudson.security.Permission	VIEW Permission to view the Codahale Metrics Operations Servlet.

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
Metrics()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkAccessKey(String accessKey) Checks an access key.
static void	checkAccessKeyHealthCheck(String accessKey) Checks an access key.
static void	checkAccessKeyMetrics(String accessKey) Checks an access key.
static void	checkAccessKeyPing(String accessKey) Checks an access key.
static void	checkAccessKeyThreadDump(String accessKey) Checks an access key.
static org.kohsuke.stapler.HttpResponse	cors(String accessKey, org.kohsuke.stapler.HttpResponse resp)
static com.codahale.metrics.health.HealthCheckRegistry	healthCheckRegistry() Returns the HealthCheckRegistry for the current Jenkins.
static com.codahale.metrics.MetricRegistry	metricRegistry() Returns the MetricRegistry for the current Jenkins.
void	postInitialize()
static void	reindexAccessKeys() Re-indexes all the access keys from the different MetricsAccessKey.Provider extensions.
void	start()
void	stop()

Methods inherited from class hudson.Plugin

configure, configure, doDynamic, getConfigXml, getWrapper, load, save, setServletContext

Methods inherited from class java.lang.Object

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

Field Detail

HEALTH_CHECK_INTERVAL_MINS

public static final int HEALTH_CHECK_INTERVAL_MINS

The frequency with which to run health checks.

PERMISSIONS

public static final hudson.security.PermissionGroup PERMISSIONS

Permission group for Metrics related permissions.

VIEW

public static final hudson.security.Permission VIEW

Permission to view the Codahale Metrics Operations Servlet.

THREAD_DUMP

public static final hudson.security.Permission THREAD_DUMP

Permission to get a thread dump from the Codahale Metrics Operations Servlet.

HEALTH_CHECK

public static final hudson.security.Permission HEALTH_CHECK

Permission to run healthchecks from the Codahale Metrics Operations Servlet.

Constructor Detail

Metrics

public Metrics()

Method Detail

healthCheckRegistry

@NonNull
public static com.codahale.metrics.health.HealthCheckRegistry healthCheckRegistry()

Returns the HealthCheckRegistry for the current Jenkins.

Returns:

the HealthCheckRegistry for the current Jenkins

Throws:

AssertionError - if there is no Jenkins or Metrics or HealthCheckRegistry

metricRegistry

@NonNull
public static com.codahale.metrics.MetricRegistry metricRegistry()

Returns the MetricRegistry for the current Jenkins.

Returns:

the MetricRegistry for the current Jenkins

Throws:

AssertionError - if there is no Jenkins or Metrics or MetricRegistry

checkAccessKey

public static void checkAccessKey(@CheckForNull
                  String accessKey)

Checks an access key.

Parameters:

accessKey - the access key.

checkAccessKeyPing

public static void checkAccessKeyPing(@CheckForNull
                      String accessKey)

Checks an access key.

Parameters:

accessKey - the access key.

checkAccessKeyThreadDump

public static void checkAccessKeyThreadDump(@CheckForNull
                            String accessKey)

Checks an access key.

Parameters:

accessKey - the access key.

checkAccessKeyHealthCheck

public static void checkAccessKeyHealthCheck(@CheckForNull
                             String accessKey)

Checks an access key.

Parameters:

accessKey - the access key.

checkAccessKeyMetrics

public static void checkAccessKeyMetrics(@CheckForNull
                         String accessKey)

Checks an access key.

Parameters:

accessKey - the access key.

cors

public static org.kohsuke.stapler.HttpResponse cors(@CheckForNull
                                    String accessKey,
                                    org.kohsuke.stapler.HttpResponse resp)

reindexAccessKeys

public static void reindexAccessKeys()

Re-indexes all the access keys from the different MetricsAccessKey.Provider extensions.

start

public void start()
           throws Exception

Overrides:

start in class hudson.Plugin

Throws:

Exception

postInitialize

public void postInitialize()
                    throws Exception

Overrides:

postInitialize in class hudson.Plugin

Throws:

Exception

stop

public void stop()
          throws Exception

Overrides:

stop in class hudson.Plugin

Throws:

Exception