Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractProvider() - Constructor for class jenkins.metrics.api.MetricsAccessKey.AbstractProvider
- AccessKeyPseudoservlet(String) - Constructor for class jenkins.metrics.api.MetricsRootAction.AccessKeyPseudoservlet
-
Constructor.
- add(T) - Method in class jenkins.metrics.util.ExponentialLeakyBucket
- add(T, long) - Method in class jenkins.metrics.util.ExponentialLeakyBucket
-
Adds an old value with a fixed timestamp to the reservoir.
- addAction(Run) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- addListener(MetricRegistryListener) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- afterExtensionsAugmented() - Static method in class jenkins.metrics.api.Metrics
-
Initializes all the metrics providers and health check providers.
- all() - Static method in class jenkins.metrics.api.QueueItemMetricsListener
-
All the registered
QueueItemMetricsListenerinstances. - AutoSamplingHistogram - Class in jenkins.metrics.util
-
This is a
Histogramthat is derived from aGaugeby sampling it 4 times a minute. - AutoSamplingHistogram(Gauge<? extends Number>) - Constructor for class jenkins.metrics.util.AutoSamplingHistogram
- AutoSamplingHistogram(Gauge<? extends Number>, Reservoir) - Constructor for class jenkins.metrics.util.AutoSamplingHistogram
- AutoSamplingHistogram.PeriodicWorkImpl - Class in jenkins.metrics.util
B
- beforeExecute(Thread, Runnable) - Method in class jenkins.metrics.util.HealthChecksThreadPool
-
Manually handle the queue size so it doesn't grow over our calculated queue capacity based on the number of health checks
C
- CANCELLED - Enum constant in enum class jenkins.metrics.api.QueueItemMetricsEvent.State
- check(String, HealthCheck) - Static method in class jenkins.metrics.api.HealthCheckProvider
- check(String, HealthCheck, boolean) - Static method in class jenkins.metrics.api.HealthCheckProvider
- checkAccessKey(String) - Static method in class jenkins.metrics.api.Metrics
-
Checks an access key.
- checkAccessKey(String) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- checkAccessKeyHealthCheck(String) - Static method in class jenkins.metrics.api.Metrics
-
Checks an access key.
- checkAccessKeyHealthCheck(String) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- checkAccessKeyMetrics(String) - Static method in class jenkins.metrics.api.Metrics
-
Checks an access key.
- checkAccessKeyMetrics(String) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- checkAccessKeyPing(String) - Static method in class jenkins.metrics.api.Metrics
-
Checks an access key.
- checkAccessKeyPing(String) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- checkAccessKeyThreadDump(String) - Static method in class jenkins.metrics.api.Metrics
-
Checks an access key.
- checkAccessKeyThreadDump(String) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- checks(Map.Entry<String, HealthCheck>...) - Static method in class jenkins.metrics.api.HealthCheckProvider
- compareEventSequence(QueueItemMetricsEvent, QueueItemMetricsEvent) - Static method in class jenkins.metrics.api.QueueItemMetricsEvent
- compareQueueSequence(QueueItemMetricsEvent, QueueItemMetricsEvent) - Static method in class jenkins.metrics.api.QueueItemMetricsEvent
-
Sorts
QueueItemMetricsEvents by the orderQueue.Item.getId(). - configure(StaplerRequest2, JSONObject) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- cors(String, HttpResponse) - Static method in class jenkins.metrics.api.Metrics
- cors(String, HttpResponse) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- counter(String) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- createFor(Run) - Method in class jenkins.metrics.impl.MetricsDetailFactory
- createName(String, String, String) - Method in class jenkins.metrics.impl.ObjectNameFactoryImpl
- CurrentUserPseudoservlet() - Constructor for class jenkins.metrics.api.MetricsRootAction.CurrentUserPseudoservlet
D
- DescriptorImpl() - Constructor for class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- destroy() - Method in class jenkins.metrics.impl.MetricsFilter
- doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class jenkins.metrics.impl.MetricsFilter
- doGenerateNewToken() - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- doHealthcheck(StaplerRequest2) - Method in class jenkins.metrics.api.MetricsRootAction.AccessKeyPseudoservlet
-
Web binding for /healthcheck
- doHealthcheck(StaplerRequest2) - Method in class jenkins.metrics.api.MetricsRootAction.CurrentUserPseudoservlet
-
Web binding for /healthcheck
- doHealthcheck(StaplerRequest2) - Method in class jenkins.metrics.api.MetricsRootAction.Pseudoservlet
-
Web binding for /healthcheck
- doHealthcheck(StaplerRequest2, String) - Method in class jenkins.metrics.api.MetricsRootAction
-
Binds the health checks to the CORS aware URL
/metrics/healthcheckwhere the metrics access key is provided in the form fieldkeyor anAuthorization: Jenkins-Metrics-Key {key}header - doHealthcheckOk(StaplerRequest2) - Method in class jenkins.metrics.api.MetricsRootAction
-
Condense the health check into one bit of information for frontend reverse proxies like haproxy.
- doIndex() - Method in class jenkins.metrics.api.MetricsRootAction.CurrentUserPseudoservlet
-
Web binding for /
- doIndex() - Method in class jenkins.metrics.api.MetricsRootAction.Pseudoservlet
-
Web binding for /
- doMetrics() - Method in class jenkins.metrics.api.MetricsRootAction.AccessKeyPseudoservlet
-
Web binding for /metrics
- doMetrics() - Method in class jenkins.metrics.api.MetricsRootAction.CurrentUserPseudoservlet
-
Web binding for /metrics
- doMetrics() - Method in class jenkins.metrics.api.MetricsRootAction.Pseudoservlet
-
Web binding for /metrics
- doMetrics(StaplerRequest2, String) - Method in class jenkins.metrics.api.MetricsRootAction
-
Binds the metrics to the CORS aware URL
/metrics/metricswhere the metrics access key is provided in the form fieldkeyor anAuthorization: Jenkins-Metrics-Key {key}header - doMetricsHistory() - Method in class jenkins.metrics.api.MetricsRootAction.AccessKeyPseudoservlet
-
Web binding for /metricsHistory
- doMetricsHistory() - Method in class jenkins.metrics.api.MetricsRootAction.CurrentUserPseudoservlet
-
Web binding for /metricsHistory
- doMetricsHistory() - Method in class jenkins.metrics.api.MetricsRootAction.Pseudoservlet
-
Web binding for /metricsHistory
- doMetricsHistory(StaplerRequest2, String) - Method in class jenkins.metrics.api.MetricsRootAction
-
Binds the metrics history to the CORS aware URL
/metrics/metricsHistorywhere the metrics access key is provided in the form fieldkeyor anAuthorization: Jenkins-Metrics-Key {key}header - doPing() - Method in class jenkins.metrics.api.MetricsRootAction.AccessKeyPseudoservlet
-
Web binding for /ping
- doPing() - Method in class jenkins.metrics.api.MetricsRootAction.CurrentUserPseudoservlet
-
Web binding for /ping
- doPing() - Method in class jenkins.metrics.api.MetricsRootAction.Pseudoservlet
-
Web binding for /ping
- doPing(StaplerRequest2, String) - Method in class jenkins.metrics.api.MetricsRootAction
-
Binds the ping check to the CORS aware URL
/metrics/pingwhere the metrics access key is provided in the form fieldkeyor anAuthorization: Jenkins-Metrics-Key {key}header - doRun() - Method in class jenkins.metrics.api.Metrics.HealthChecker
-
Schedules this periodic work now in a new thread, if one isn't already running.
- doRun() - Method in class jenkins.metrics.api.MetricsRootAction.Sampler
- doRun() - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.PeriodicWorkImpl
- doRun() - Method in class jenkins.metrics.util.AutoSamplingHistogram.PeriodicWorkImpl
- doThreads() - Method in class jenkins.metrics.api.MetricsRootAction.AccessKeyPseudoservlet
-
Web binding for /threads
- doThreads() - Method in class jenkins.metrics.api.MetricsRootAction.CurrentUserPseudoservlet
-
Web binding for /threads
- doThreads() - Method in class jenkins.metrics.api.MetricsRootAction.Pseudoservlet
-
Web binding for /threads
- doThreads(StaplerRequest2, String) - Method in class jenkins.metrics.api.MetricsRootAction
-
Binds the thread dump to the CORS aware URL
/metrics/threadswhere the metrics access key is provided in the form fieldkeyor anAuthorization: Jenkins-Metrics-Key {key}header - DURATION_UNIT - Static variable in class jenkins.metrics.api.MetricsRootAction
-
The time unit to express durations in, that is all durations are in seconds.
- dynamicInstallHack() - Static method in class jenkins.metrics.api.Metrics.HealthChecker
- dynamicInstallHack() - Static method in class jenkins.metrics.api.MetricsRootAction.Sampler
- dynamicInstallHack() - Static method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.PeriodicWorkImpl
- dynamicInstallHack() - Static method in class jenkins.metrics.util.AutoSamplingHistogram.PeriodicWorkImpl
E
- equals(Object) - Method in class jenkins.metrics.api.MetricsAccessKey
- equals(Object) - Method in class jenkins.metrics.api.MetricsAccessKey.FixedListProviderImpl
- equals(Object) - Method in class jenkins.metrics.api.QueueItemMetricsEvent
- ExponentialLeakyBucket<T> - Class in jenkins.metrics.util
-
An exponentially-decaying random reservoir of
longs. - ExponentialLeakyBucket() - Constructor for class jenkins.metrics.util.ExponentialLeakyBucket
-
Creates a new
ExponentialLeakyBucketof 1028 elements, which offers a 99.9% confidence level with a 5% margin of error assuming a normal distribution, and an alpha factor of 0.015, which heavily biases the reservoir to the past 5 minutes of measurements. - ExponentialLeakyBucket(int, double) - Constructor for class jenkins.metrics.util.ExponentialLeakyBucket
-
Creates a new
ExponentialLeakyBucket. - ExponentialLeakyBucket(int, double, Clock) - Constructor for class jenkins.metrics.util.ExponentialLeakyBucket
-
Creates a new
ExponentialLeakyBucket.
F
- FINISHED - Enum constant in enum class jenkins.metrics.api.QueueItemMetricsEvent.State
- FixedListProviderImpl(List<MetricsAccessKey>) - Constructor for class jenkins.metrics.api.MetricsAccessKey.FixedListProviderImpl
G
- generateKey() - Static method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- getAccessKey(String) - Method in class jenkins.metrics.api.MetricsAccessKey.AbstractProvider
-
Returns the definition of the specific access key.
- getAccessKey(String) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- getAccessKey(String) - Method in interface jenkins.metrics.api.MetricsAccessKey.Provider
-
Returns the definition of the specific access key.
- getAccessKeys() - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- getAccessKeys() - Method in class jenkins.metrics.api.MetricsAccessKey.FixedListProviderImpl
- getAccessKeys() - Method in interface jenkins.metrics.api.MetricsAccessKey.Provider
- getAssignedLabel() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
Returns the
Queue.Item.getAssignedLabel()at the time of the event ornullif the item was not assigned to a label. - getBlockedDurationMillis() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
-
Returns the duration this
SubTaskspent in the queue because it was blocked. - getBlockedDurationMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the duration this
Runspent in the queue because it was blocked. - getBlockedDurationString() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getBlockedTimeMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getBlockedTimeString() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getBuildableDurationMillis() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
-
Returns the duration this
SubTaskspent in the queue in a buildable state. - getBuildableDurationMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the duration this
Runspent in the queue in a buildable state. - getBuildableDurationString() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getBuildableTimeMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getBuildableTimeString() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getBuildingDurationMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getBuildingDurationString() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getConsumedLabelAtoms() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
Returns the
Node.getAssignedLabels()of all the executor slots occupied by this task, if the task has been started. - getCounters() - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- getCounters(MetricFilter) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- getCurrentUser() - Method in class jenkins.metrics.api.MetricsRootAction
-
Binds the
MetricsRootAction.Pseudoservletfor the current user to the URL/metrics/currentUser - getDescription() - Method in class jenkins.metrics.api.MetricsAccessKey
- getDisplayName() - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- getDisplayName() - Method in class jenkins.metrics.api.MetricsRootAction
- getDisplayName() - Method in class jenkins.metrics.impl.MetricsDetail
- getDisplayName() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
- getDisplayName() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getDynamic(String) - Method in class jenkins.metrics.api.MetricsRootAction
-
Binds the
MetricsRootAction.Pseudoservletfor a metric access keys to the URL/metrics/{key} - getEventMillis() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
Returns the current
System.currentTimeMillis()comparable time when this event occurred. - getEventTick() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
Returns the
System.nanoTime()comparable tick when this event occurred. - getExecutable() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
Returns the
Queue.Executablecreated from theQueue.Itembelongs. - getExecutingDurationMillis() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
-
Returns the duration this
SubTaskspent executing. - getExecutingMillis() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
If the
Queue.Executablehas finished executing, returns the number of milliseconds the item spent executing. - getExecutingTimeMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the duration this
Runspent building, that is the wall time from when it left the queue until it was finished. - getExecutingTimeString() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getExecutorCount() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
If the
Queue.Executablehas started executing, returns the number of executors being used. - getExecutorUtilization() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getExpires() - Method in class jenkins.metrics.api.Metrics.HealthCheckData
-
The number of milliseconds since 1st January 1970 GMT when the results are expected to be superceded by a newer result.
- getGauges() - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- getGauges(MetricFilter) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- getHealthCheckCount() - Method in class jenkins.metrics.api.Metrics.HealthChecker
-
Gets the
Gaugethat tracks the number of health checks. - getHealthCheckData() - Static method in class jenkins.metrics.api.Metrics
-
Get the current health check data.
- getHealthCheckData() - Method in class jenkins.metrics.api.Metrics.HealthChecker
-
Gets the most recent health check data (which includes
Metrics.HealthCheckData.getLastModified()) - getHealthCheckDuration() - Method in class jenkins.metrics.api.Metrics.HealthChecker
-
Gets the
Timerthat tracks how long the health checks are taking to execute. - getHealthCheckResults() - Static method in class jenkins.metrics.api.Metrics
-
Get the last health check results
- getHealthCheckResults() - Method in class jenkins.metrics.api.Metrics.HealthChecker
-
Gets the most recent results.
- getHealthChecks() - Method in class jenkins.metrics.api.HealthCheckProvider
-
A map of
HealthCheckinstances keyed by name. - getHealthChecks() - Method in class jenkins.metrics.impl.JenkinsHealthCheckProviderImpl
- getHealthCheckScore() - Method in class jenkins.metrics.api.Metrics.HealthChecker
-
Gets the
Gaugethat tracks the health check score. - getHistograms() - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- getHistograms(MetricFilter) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- getIconClassName() - Method in class jenkins.metrics.impl.MetricsDetail
- getIconFileName() - Method in class jenkins.metrics.api.MetricsRootAction
- getIconFileName() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
- getIconFileName() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getId() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
Returns the
Queue.Item.getId(). - getItem() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
Returns the
Queue.Item. - getJenkinsExecutorTotalCount() - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl
- getJenkinsExecutorUsedCount() - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl
- getJenkinsNodeOnlineCount() - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl
- getJenkinsNodeTotalCount() - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl
- getKey() - Method in class jenkins.metrics.api.MetricsAccessKey
- getLastModified() - Method in class jenkins.metrics.api.Metrics.HealthCheckData
-
The number of milliseconds since 1st January 1970 GMT when the results were collected.
- getMeters() - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- getMeters(MetricFilter) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- getMetrics() - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- getMetricSet() - Method in class jenkins.metrics.api.MetricProvider
-
Returns the set of metrics to register.
- getMetricSet() - Method in class jenkins.metrics.api.Metrics.HealthCheckMetricsProvider
-
Returns the set of metrics to register.
- getMetricSet() - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl
-
Returns the set of metrics to register.
- getMetricSet() - Method in class jenkins.metrics.impl.JenkinsVersionsProviderImpl
-
Returns the set of metrics to register.
- getMetricSet() - Method in class jenkins.metrics.impl.VMMetricProviderImpl
- getNames() - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- getOrder() - Method in class jenkins.metrics.impl.MetricsDetail
- getOrigins() - Method in class jenkins.metrics.api.MetricsAccessKey
- getQueuingBlockedMillis() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
If the
Queue.Itemhas left the queue, returns the number of milliseconds the item was on the queue in the blocked state. - getQueuingBuildableMillis() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
If the
Queue.Itemhas left the queue, returns the number of milliseconds the item was on the queue in the buildable state. - getQueuingDurationMillis() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
-
How long spent queuing (this is the time from when the
WorkUnitContext.itementered the queue untilWorkUnitContext.synchronizeStart()was called. - getQueuingDurationMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the duration this
Runspent queuing, that is the wall time from when it entered the queue until it left the queue. - getQueuingDurationString() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getQueuingTimeMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the total time this
Runspent queuing, including the time spent by subtasks. - getQueuingTimeString() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getQueuingTotalMillis() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
If the
Queue.Itemhas left the queue, returns the number of milliseconds the item was on the queue. - getQueuingWaitingMillis() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
If the
Queue.Itemhas left the queue, returns the number of milliseconds the item was on the queue in the waiting state. - getRecurrencePeriod() - Method in class jenkins.metrics.api.Metrics.HealthChecker
- getRecurrencePeriod() - Method in class jenkins.metrics.api.MetricsRootAction.Sampler
- getRecurrencePeriod() - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.PeriodicWorkImpl
- getRecurrencePeriod() - Method in class jenkins.metrics.util.AutoSamplingHistogram.PeriodicWorkImpl
- getRejectedExecutions() - Static method in class jenkins.metrics.util.HealthChecksThreadPool
- getResults() - Method in class jenkins.metrics.api.Metrics.HealthCheckData
-
The results.
- getRun() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
Returns the
Runto which theQueue.Itembelongs. - getRun() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getState() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
Returns the state of the
Queue.Itemwhen the event occurred. - getSubTaskCount() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getSystemCpuLoad() - Method in class jenkins.metrics.impl.VMMetricProviderImpl
-
Returns a gauge that reports the current system CPU load or
nullif that metric is unavailable. - getTime() - Method in class jenkins.metrics.api.MetricsRootAction.Sampler.Sample
-
Gets the time the sample was taken.
- getTimers() - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- getTimers(MetricFilter) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- getTotalDurationMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns total duration for this
Run, that is the wall time from when it entered the queue until it was finished. - getTotalDurationString() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getUrlName() - Method in class jenkins.metrics.api.MetricsRootAction
- getUrlName() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
- getUrlName() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getValue(ObjectReader) - Method in class jenkins.metrics.api.MetricsRootAction.Sampler.Sample
-
Gets the JSON from the sample.
- getVmCpuLoad() - Method in class jenkins.metrics.impl.VMMetricProviderImpl
-
Returns a gauge that reports the current JVM CPU load or
nullif that metric is unavailable. - getWaitingDurationMillis() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
-
Returns the duration this
SubTaskspent in the queue waiting before it could be considered for execution. - getWaitingDurationMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the duration this
Runspent in the queue waiting before it could be considered for execution. - getWaitingDurationString() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getWaitingTimeMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getWaitingTimeString() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getWorkUnitCount() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
-
Returns the number of executor slots occupied by this
SubTask.
H
- hasAccessKeyHealthCheck(String) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- hasAccessKeyMetrics(String) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- hasAccessKeyPing(String) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- hasAccessKeyThreadDump(String) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- hashCode() - Method in class jenkins.metrics.api.MetricsAccessKey.FixedListProviderImpl
- hashCode() - Method in class jenkins.metrics.api.MetricsAccessKey
- hashCode() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
- HEALTH_CHECK - Static variable in class jenkins.metrics.api.Metrics
-
Permission to run healthchecks from the Codahale Metrics Operations Servlet.
- HEALTH_CHECK_INTERVAL_MINS - Static variable in class jenkins.metrics.api.Metrics
-
The frequency with which to run health checks.
- HealthCheckData(SortedMap<String, HealthCheck.Result>) - Constructor for class jenkins.metrics.api.Metrics.HealthCheckData
-
Constructor for when you do not know how long before the next collection.
- HealthCheckData(SortedMap<String, HealthCheck.Result>, long) - Constructor for class jenkins.metrics.api.Metrics.HealthCheckData
-
Constructor for when you know how long before the next collection.
- HealthChecker() - Constructor for class jenkins.metrics.api.Metrics.HealthChecker
-
Default constructor.
- HealthCheckMetricsProvider() - Constructor for class jenkins.metrics.api.Metrics.HealthCheckMetricsProvider
- HealthCheckProvider - Class in jenkins.metrics.api
-
Provides
HealthCheckinstances to register. - HealthCheckProvider() - Constructor for class jenkins.metrics.api.HealthCheckProvider
- healthCheckRegistry() - Static method in class jenkins.metrics.api.Metrics
-
Returns the
HealthCheckRegistryfor the currentJenkins. - HealthChecksThreadPool - Class in jenkins.metrics.util
-
Thread pool for running health checks.
- HealthChecksThreadPool(HealthCheckRegistry) - Constructor for class jenkins.metrics.util.HealthChecksThreadPool
- HeathCheckMetricsProvider() - Constructor for class jenkins.metrics.api.Metrics.HeathCheckMetricsProvider
-
Deprecated.
- histogram(String) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
I
- init(FilterConfig) - Method in class jenkins.metrics.impl.MetricsFilter
- instance() - Static method in class jenkins.metrics.impl.JenkinsMetricProviderImpl
- instance() - Static method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- isCanHealthCheck() - Method in class jenkins.metrics.api.MetricsAccessKey
- isCanMetrics() - Method in class jenkins.metrics.api.MetricsAccessKey
- isCanPing() - Method in class jenkins.metrics.api.MetricsAccessKey
- isCanThreadDump() - Method in class jenkins.metrics.api.MetricsAccessKey
- isEnabled() - Static method in class jenkins.metrics.api.MetricsRootAction.Sampler
- isHasSubTasks() - Method in class jenkins.metrics.impl.TimeInQueueAction
- isOriginAllowed(String) - Method in class jenkins.metrics.api.MetricsAccessKey
J
- jenkins.metrics.api - package jenkins.metrics.api
- jenkins.metrics.impl - package jenkins.metrics.impl
- jenkins.metrics.util - package jenkins.metrics.util
- JenkinsHealthCheckProviderImpl - Class in jenkins.metrics.impl
-
Provides some simple standard health checks.
- JenkinsHealthCheckProviderImpl() - Constructor for class jenkins.metrics.impl.JenkinsHealthCheckProviderImpl
- JenkinsMetricProviderImpl - Class in jenkins.metrics.impl
-
Provides Jenkins specific metrics.
- JenkinsMetricProviderImpl() - Constructor for class jenkins.metrics.impl.JenkinsMetricProviderImpl
- JenkinsMetricProviderImpl.PeriodicWorkImpl - Class in jenkins.metrics.impl
- JenkinsMetricProviderImpl.ResultRunListener - Class in jenkins.metrics.impl
- JenkinsMetricProviderImpl.RunListenerImpl - Class in jenkins.metrics.impl
- JenkinsMetricProviderImpl.ScheduledRate - Class in jenkins.metrics.impl
- JenkinsMetricProviderImpl.SchedulingRate - Class in jenkins.metrics.impl
- JenkinsVersionsProviderImpl - Class in jenkins.metrics.impl
-
Exposes details of various versions as metrics, which should make it easier to cross-correlate metric changes with version changes.
- JenkinsVersionsProviderImpl() - Constructor for class jenkins.metrics.impl.JenkinsVersionsProviderImpl
- JMX_DOMAIN - Static variable in class jenkins.metrics.api.Metrics
-
JMX domain
M
- Messages - Class in jenkins.metrics.api
-
Generated localization support class.
- Messages() - Constructor for class jenkins.metrics.api.Messages
- meter(String) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- metric(String, Metric) - Static method in class jenkins.metrics.api.MetricProvider
- MetricProvider - Class in jenkins.metrics.api
-
Provides metrics to register.
- MetricProvider() - Constructor for class jenkins.metrics.api.MetricProvider
- metricRegistry() - Static method in class jenkins.metrics.api.Metrics
-
Returns the
MetricRegistryfor the currentJenkins. - metrics(Map.Entry<String, Metric>...) - Static method in class jenkins.metrics.api.MetricProvider
- metrics(Map<String, Metric>) - Static method in class jenkins.metrics.api.MetricProvider
- Metrics - Class in jenkins.metrics.api
-
Entry point for all things metrics.
- Metrics() - Constructor for class jenkins.metrics.api.Metrics
- Metrics_afterExtensionsAugmented() - Static method in class jenkins.metrics.api.Messages
-
Key
Metrics.afterExtensionsAugmented:Registering metric provider and health check provider extensions. - Metrics_HealthCheckPermission_Description() - Static method in class jenkins.metrics.api.Messages
-
Key
Metrics.HealthCheckPermission.Description:This permission grants access to the health check functionality of the Metrics servlet. Please be aware that depending on the nature of the health checks in your system,this could be abused to deliver a denial of service attack if the credentials of a user with this permission become compromised.. - Metrics_PermissionGroup() - Static method in class jenkins.metrics.api.Messages
-
Key
Metrics.PermissionGroup:Metrics. - Metrics_ThreadDumpPermission_Description() - Static method in class jenkins.metrics.api.Messages
-
Key
Metrics.ThreadDumpPermission.Description:This permission grants read-only access to the thread dump functionality of the Metrics servlet. Please be aware that potentially sensitive information in your stack trace, such as job names, will be exposed to users with this permission.. - Metrics_ViewPermission_Description() - Static method in class jenkins.metrics.api.Messages
-
Key
Metrics.ViewPermission.Description:This permission grants read-only access to the Metrics servlet. Please be aware that potentially sensitive information in your stack trace, such as job names, will be exposed to a wider audience by granting this permission.. - Metrics.HealthCheckData - Class in jenkins.metrics.api
-
Health check data.
- Metrics.HealthChecker - Class in jenkins.metrics.api
-
Performs the periodic running of health checks and re-indexing of access keys.
- Metrics.HealthCheckMetricsProvider - Class in jenkins.metrics.api
-
provides the health check related metrics.
- Metrics.HeathCheckMetricsProvider - Class in jenkins.metrics.api
-
Deprecated.use HealthCheckMetricsProvider
- MetricsAccessKey - Class in jenkins.metrics.api
- MetricsAccessKey(String, Secret, boolean, boolean, boolean, boolean, String) - Constructor for class jenkins.metrics.api.MetricsAccessKey
- MetricsAccessKey(String, String) - Constructor for class jenkins.metrics.api.MetricsAccessKey
- MetricsAccessKey(String, String, boolean, boolean, boolean, boolean, String) - Constructor for class jenkins.metrics.api.MetricsAccessKey
-
Deprecated.
- MetricsAccessKey_displayName() - Static method in class jenkins.metrics.api.Messages
-
Key
MetricsAccessKey.displayName:Metrics access key. - MetricsAccessKey_invalidAccessKey(Object) - Static method in class jenkins.metrics.api.Messages
-
Key
MetricsAccessKey.invalidAccessKey:Invalid/unknown access key: {0}. - MetricsAccessKey.AbstractProvider - Class in jenkins.metrics.api
-
An extension point that allows for plugins to provide their own set of access keys.
- MetricsAccessKey.DescriptorImpl - Class in jenkins.metrics.api
- MetricsAccessKey.FixedListProviderImpl - Class in jenkins.metrics.api
-
A provider that is a simple fixed list of keys.
- MetricsAccessKey.Provider - Interface in jenkins.metrics.api
-
An extension point that allows for plugins to provide their own set of access keys.
- MetricsDetail - Class in jenkins.metrics.impl
- MetricsDetail(Actionable) - Constructor for class jenkins.metrics.impl.MetricsDetail
- MetricsDetailFactory - Class in jenkins.metrics.impl
- MetricsDetailFactory() - Constructor for class jenkins.metrics.impl.MetricsDetailFactory
- MetricsFilter - Class in jenkins.metrics.impl
-
The metrics filter.
- MetricsFilter() - Constructor for class jenkins.metrics.impl.MetricsFilter
- MetricsRootAction - Class in jenkins.metrics.api
-
Root action that exposes the metrics via the REST UI.
- MetricsRootAction() - Constructor for class jenkins.metrics.api.MetricsRootAction
- MetricsRootAction.AccessKeyPseudoservlet - Class in jenkins.metrics.api
-
Web binding for the access keys
- MetricsRootAction.CurrentUserPseudoservlet - Class in jenkins.metrics.api
-
Web binding for the current user.
- MetricsRootAction.Pseudoservlet - Class in jenkins.metrics.api
-
A binding of the standard dropwizard metrics servlet into the stapler API
- MetricsRootAction.Sampler - Class in jenkins.metrics.api
-
Sampler that captures an exponential sample of metrics snapshots.
- MetricsRootAction.Sampler.Sample - Class in jenkins.metrics.api
-
A sample.
N
- NameRewriterMetricRegistry - Class in jenkins.metrics.util
-
A pseudo
MetricRegistrythat adds a prefix / postfix to every metric name. - NameRewriterMetricRegistry(String, MetricRegistry, String) - Constructor for class jenkins.metrics.util.NameRewriterMetricRegistry
- NameRewriterMetricRegistry(String, MetricRegistry, String, boolean) - Constructor for class jenkins.metrics.util.NameRewriterMetricRegistry
- notifyCancelled(QueueItemMetricsEvent) - Static method in class jenkins.metrics.api.QueueItemMetricsListener
-
Notify all listeners about the cancellation of an item.
- notifyFinished(QueueItemMetricsEvent) - Static method in class jenkins.metrics.api.QueueItemMetricsListener
-
Notify all listeners about an item having finished execution.
- notifyQueued(QueueItemMetricsEvent) - Static method in class jenkins.metrics.api.QueueItemMetricsListener
-
Notify all listeners about the enqueuing of an item.
- notifyStarted(QueueItemMetricsEvent) - Static method in class jenkins.metrics.api.QueueItemMetricsListener
-
Notify all listeners about an item having started execution.
O
- ObjectNameFactoryImpl - Class in jenkins.metrics.impl
- ObjectNameFactoryImpl() - Constructor for class jenkins.metrics.impl.ObjectNameFactoryImpl
- onAttached(Run<?, ?>) - Method in class jenkins.metrics.impl.TimeInQueueAction
- onCancelled(QueueItemMetricsEvent) - Method in class jenkins.metrics.api.QueueItemMetricsListener
-
Called at most once for each
Queue.Itemsome time after it is cancelled from the queue. - onCompleted(Run, TaskListener) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ResultRunListener
- onCompleted(Run, TaskListener) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.RunListenerImpl
- onEnterBlocked(Queue.BlockedItem) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- onEnterBuildable(Queue.BuildableItem) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- onEnterWaiting(Queue.WaitingItem) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- onFinished(QueueItemMetricsEvent) - Method in class jenkins.metrics.api.QueueItemMetricsListener
-
Called at most once for each
Queue.Itemsome time after it finishes executing. - onLeaveBlocked(Queue.BlockedItem) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- onLeaveBuildable(Queue.BuildableItem) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- onLeaveWaiting(Queue.WaitingItem) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- onLeft(Queue.LeftItem) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- onLoad(Run<?, ?>) - Method in class jenkins.metrics.impl.TimeInQueueAction
- onQueued(QueueItemMetricsEvent) - Method in class jenkins.metrics.api.QueueItemMetricsListener
-
Called at most once for each
Queue.Itemsome time after it enters the queue. - onStarted(Run, TaskListener) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.RunListenerImpl
- onStarted(QueueItemMetricsEvent) - Method in class jenkins.metrics.api.QueueItemMetricsListener
-
Called at most once for each
Queue.Itemsome time after it leaves the queue and starts executing.
P
- PeriodicWorkImpl() - Constructor for class jenkins.metrics.impl.JenkinsMetricProviderImpl.PeriodicWorkImpl
- PeriodicWorkImpl() - Constructor for class jenkins.metrics.util.AutoSamplingHistogram.PeriodicWorkImpl
- PERMISSIONS - Static variable in class jenkins.metrics.api.Metrics
-
Permission group for Metrics related permissions.
- Pseudoservlet() - Constructor for class jenkins.metrics.api.MetricsRootAction.Pseudoservlet
Q
- queued(Object) - Static method in class jenkins.metrics.api.Messages
-
Key
queued:Queued {0}. - QUEUED - Enum constant in enum class jenkins.metrics.api.QueueItemMetricsEvent.State
- QueueItemMetricsEvent - Class in jenkins.metrics.api
-
Holds the metrics about a queue item.
- QueueItemMetricsEvent(Queue.Item, Label, QueueItemMetricsEvent.State, Run<?, ?>, Queue.Executable, List<Set<LabelAtom>>, Long, Long, Long, Long, Long, Integer) - Constructor for class jenkins.metrics.api.QueueItemMetricsEvent
- QueueItemMetricsEvent.State - Enum Class in jenkins.metrics.api
-
The state of the item when this metrics event was created.
- QueueItemMetricsListener - Class in jenkins.metrics.api
-
Receives details of metrics events about queue items.
- QueueItemMetricsListener() - Constructor for class jenkins.metrics.api.QueueItemMetricsListener
R
- RATE_UNIT - Static variable in class jenkins.metrics.api.MetricsRootAction
-
The time units to express rates in, that is all rates are events per minute.
- register(String, T) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- registerAll(MetricSet) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- reindexAccessKeys() - Static method in class jenkins.metrics.api.Metrics
-
Re-indexes all the access keys from the different
MetricsAccessKey.Providerextensions. - reindexAccessKeys() - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
- remove(String) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- removeListener(MetricRegistryListener) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- removeMatching(MetricFilter) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- ResultRunListener() - Constructor for class jenkins.metrics.impl.JenkinsMetricProviderImpl.ResultRunListener
- RunListenerImpl() - Constructor for class jenkins.metrics.impl.JenkinsMetricProviderImpl.RunListenerImpl
S
- sample() - Method in class jenkins.metrics.api.MetricsRootAction.Sampler
- sample(String, String) - Method in class jenkins.metrics.api.MetricsRootAction.Sampler
- Sample(long, byte[]) - Constructor for class jenkins.metrics.api.MetricsRootAction.Sampler.Sample
-
Constructor.
- Sampler() - Constructor for class jenkins.metrics.api.MetricsRootAction.Sampler
-
Default constructor.
- ScheduledRate() - Constructor for class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- SchedulingRate() - Constructor for class jenkins.metrics.impl.JenkinsMetricProviderImpl.SchedulingRate
- setAccessKeys(List<MetricsAccessKey>) - Method in class jenkins.metrics.api.MetricsAccessKey.DescriptorImpl
-
Setter for the list of access keys
- shouldSchedule(Queue.Task, List<Action>) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.SchedulingRate
- size() - Method in class jenkins.metrics.util.ExponentialLeakyBucket
- start() - Method in class jenkins.metrics.api.Metrics
- STARTED - Enum constant in enum class jenkins.metrics.api.QueueItemMetricsEvent.State
- stop() - Method in class jenkins.metrics.api.Metrics
- SubTaskTimeInQueueAction - Class in jenkins.metrics.impl
-
Tracks the time occupied by subtasks.
- SubTaskTimeInQueueAction(long, long, long, long, long, int) - Constructor for class jenkins.metrics.impl.SubTaskTimeInQueueAction
-
Constructor
T
- taskCompleted(Executor, Queue.Task, long) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- taskCompletedWithProblems(Executor, Queue.Task, long, Throwable) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- taskStarted(Executor, Queue.Task) - Method in class jenkins.metrics.impl.JenkinsMetricProviderImpl.ScheduledRate
- THREAD_DUMP - Static variable in class jenkins.metrics.api.Metrics
-
Permission to get a thread dump from the Codahale Metrics Operations Servlet.
- TimeInQueueAction - Class in jenkins.metrics.impl
-
Tracks the time spent in the queue
- TimeInQueueAction(long) - Constructor for class jenkins.metrics.impl.TimeInQueueAction
-
Deprecated.
- TimeInQueueAction(long, long, long, long) - Constructor for class jenkins.metrics.impl.TimeInQueueAction
-
Constructor.
- timer(String) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
- toMetricSet() - Method in class jenkins.metrics.util.AutoSamplingHistogram
- toString() - Method in class jenkins.metrics.api.MetricsAccessKey.FixedListProviderImpl
- toString() - Method in class jenkins.metrics.api.MetricsAccessKey
- toString() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
- toString() - Method in class jenkins.metrics.util.AutoSamplingHistogram
- type() - Method in class jenkins.metrics.impl.MetricsDetailFactory
U
- update() - Method in class jenkins.metrics.util.AutoSamplingHistogram
V
- valueOf(String) - Static method in enum class jenkins.metrics.api.QueueItemMetricsEvent.State
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class jenkins.metrics.api.QueueItemMetricsEvent.State
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in class jenkins.metrics.util.ExponentialLeakyBucket
- VIEW - Static variable in class jenkins.metrics.api.Metrics
-
Permission to view the Codahale Metrics Operations Servlet.
- VMMetricProviderImpl - Class in jenkins.metrics.impl
- VMMetricProviderImpl() - Constructor for class jenkins.metrics.impl.VMMetricProviderImpl
_
- _Metrics_afterExtensionsAugmented() - Static method in class jenkins.metrics.api.Messages
-
Key
Metrics.afterExtensionsAugmented:Registering metric provider and health check provider extensions. - _Metrics_HealthCheckPermission_Description() - Static method in class jenkins.metrics.api.Messages
-
Key
Metrics.HealthCheckPermission.Description:This permission grants access to the health check functionality of the Metrics servlet. Please be aware that depending on the nature of the health checks in your system,this could be abused to deliver a denial of service attack if the credentials of a user with this permission become compromised.. - _Metrics_PermissionGroup() - Static method in class jenkins.metrics.api.Messages
-
Key
Metrics.PermissionGroup:Metrics. - _Metrics_ThreadDumpPermission_Description() - Static method in class jenkins.metrics.api.Messages
-
Key
Metrics.ThreadDumpPermission.Description:This permission grants read-only access to the thread dump functionality of the Metrics servlet. Please be aware that potentially sensitive information in your stack trace, such as job names, will be exposed to users with this permission.. - _Metrics_ViewPermission_Description() - Static method in class jenkins.metrics.api.Messages
-
Key
Metrics.ViewPermission.Description:This permission grants read-only access to the Metrics servlet. Please be aware that potentially sensitive information in your stack trace, such as job names, will be exposed to a wider audience by granting this permission.. - _MetricsAccessKey_displayName() - Static method in class jenkins.metrics.api.Messages
-
Key
MetricsAccessKey.displayName:Metrics access key. - _MetricsAccessKey_invalidAccessKey(Object) - Static method in class jenkins.metrics.api.Messages
-
Key
MetricsAccessKey.invalidAccessKey:Invalid/unknown access key: {0}. - _queued(Object) - Static method in class jenkins.metrics.api.Messages
-
Key
queued:Queued {0}.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form