jenkins.metrics.api

Class MetricsRootAction

java.lang.Object

jenkins.metrics.api.MetricsRootAction

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Action, hudson.model.ModelObject, hudson.model.RootAction, hudson.model.UnprotectedRootAction

@Extension
public class MetricsRootAction
extends Object
implements hudson.model.UnprotectedRootAction

Author:

Stephen Connolly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MetricsRootAction.AccessKeyPseudoservlet
class	MetricsRootAction.CurrentUserPseudoservlet
class	MetricsRootAction.Pseudoservlet
static class	MetricsRootAction.Sampler

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static TimeUnit	DURATION_UNIT
static TimeUnit	RATE_UNIT

Constructor Summary

Constructors

Constructor and Description
MetricsRootAction()

Method Summary

Methods

Modifier and Type	Method and Description
org.kohsuke.stapler.HttpResponse	doHealthcheck(org.kohsuke.stapler.StaplerRequest req, String key)
org.kohsuke.stapler.HttpResponse	doHealthcheckOk() Condense the health check into one bit of information for frontend reverse proxies like haproxy.
org.kohsuke.stapler.HttpResponse	doMetrics(org.kohsuke.stapler.StaplerRequest req, String key)
org.kohsuke.stapler.HttpResponse	doMetricsHistory(org.kohsuke.stapler.StaplerRequest req, String key)
org.kohsuke.stapler.HttpResponse	doPing(org.kohsuke.stapler.StaplerRequest req, String key)
org.kohsuke.stapler.HttpResponse	doThreads(org.kohsuke.stapler.StaplerRequest req, String key)
Object	getCurrentUser()
String	getDisplayName()
Object	getDynamic(String key)
String	getIconFileName()
String	getUrlName()

Methods inherited from class java.lang.Object

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

Field Detail

RATE_UNIT

public static final TimeUnit RATE_UNIT

DURATION_UNIT

public static final TimeUnit DURATION_UNIT

Constructor Detail

MetricsRootAction

public MetricsRootAction()

Method Detail

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface hudson.model.Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.Action

Specified by:

getDisplayName in interface hudson.model.ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface hudson.model.Action

getDynamic

public Object getDynamic(String key)

getCurrentUser

public Object getCurrentUser()

doHealthcheck

public org.kohsuke.stapler.HttpResponse doHealthcheck(org.kohsuke.stapler.StaplerRequest req,
                                             @QueryParameter(value="key")
                                             String key)
                                               throws IllegalAccessException

Throws:

IllegalAccessException

doHealthcheckOk

public org.kohsuke.stapler.HttpResponse doHealthcheckOk()

Condense the health check into one bit of information for frontend reverse proxies like haproxy. Other health check calls requires authentication, which is not suitable for the haproxy use. But this endpoint only exposes one bit information, it's deemed OK to be exposed unsecurely. return status 200 if everything is OK, 503 (service unavailable) otherwise

doMetrics

public org.kohsuke.stapler.HttpResponse doMetrics(org.kohsuke.stapler.StaplerRequest req,
                                         @QueryParameter(value="key")
                                         String key)
                                           throws IllegalAccessException

Throws:

IllegalAccessException

doMetricsHistory

public org.kohsuke.stapler.HttpResponse doMetricsHistory(org.kohsuke.stapler.StaplerRequest req,
                                                @QueryParameter(value="key")
                                                String key)
                                                  throws IllegalAccessException

Throws:

IllegalAccessException

doPing

public org.kohsuke.stapler.HttpResponse doPing(org.kohsuke.stapler.StaplerRequest req,
                                      @QueryParameter(value="key")
                                      String key)
                                        throws IllegalAccessException

Throws:

IllegalAccessException

doThreads

public org.kohsuke.stapler.HttpResponse doThreads(org.kohsuke.stapler.StaplerRequest req,
                                         @QueryParameter(value="key")
                                         String key)
                                           throws IllegalAccessException

Throws:

IllegalAccessException