- 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
-
- doHealthcheck(StaplerRequest) - Method in class jenkins.metrics.api.MetricsRootAction.AccessKeyPseudoservlet
-
Web binding for /healthcheck
- doHealthcheck(StaplerRequest) - Method in class jenkins.metrics.api.MetricsRootAction.CurrentUserPseudoservlet
-
Web binding for /healthcheck
- doHealthcheck(StaplerRequest, String) - Method in class jenkins.metrics.api.MetricsRootAction
-
Binds the health checks to the CORS aware URL /metrics/healthcheck
where the metrics access key is
provided in the form field key
or an Authorization: Jenkins-Metrics-Key {key}
header
- doHealthcheck(StaplerRequest) - Method in class jenkins.metrics.api.MetricsRootAction.Pseudoservlet
-
Web binding for /healthcheck
- doHealthcheckOk(StaplerRequest) - 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(StaplerRequest, String) - Method in class jenkins.metrics.api.MetricsRootAction
-
Binds the metrics to the CORS aware URL /metrics/metrics
where the metrics access key is
provided in the form field key
or an Authorization: Jenkins-Metrics-Key {key}
header
- doMetrics() - Method in class jenkins.metrics.api.MetricsRootAction.Pseudoservlet
-
Web binding for /metrics
- 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(StaplerRequest, String) - Method in class jenkins.metrics.api.MetricsRootAction
-
Binds the metrics history to the CORS aware URL /metrics/metricsHistory
where the metrics access key is
provided in the form field key
or an Authorization: Jenkins-Metrics-Key {key}
header
- doMetricsHistory() - Method in class jenkins.metrics.api.MetricsRootAction.Pseudoservlet
-
Web binding for /metricsHistory
- 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(StaplerRequest, String) - Method in class jenkins.metrics.api.MetricsRootAction
-
Binds the ping check to the CORS aware URL /metrics/ping
where the metrics access key is
provided in the form field key
or an Authorization: Jenkins-Metrics-Key {key}
header
- doPing() - Method in class jenkins.metrics.api.MetricsRootAction.Pseudoservlet
-
Web binding for /ping
- 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(StaplerRequest, String) - Method in class jenkins.metrics.api.MetricsRootAction
-
Binds the thread dump to the CORS aware URL /metrics/threads
where the metrics access key is
provided in the form field key
or an Authorization: Jenkins-Metrics-Key {key}
header
- doThreads() - Method in class jenkins.metrics.api.MetricsRootAction.Pseudoservlet
-
Web binding for /threads
- 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
-
- 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 or null
if the item was not
assigned to a label.
- getBlockedDurationMillis() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
-
Returns the duration this
SubTask
spent in the queue because it was blocked.
- getBlockedDurationMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the duration this
Run
spent in the queue because it was blocked.
- getBlockedDurationString() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
- getBlockedTimeMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the total time this
Run
, and any associated
SubTask
s, spent in the queue because they
were blocked.
- getBlockedTimeString() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
- getBuildableDurationMillis() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
-
Returns the duration this
SubTask
spent in the queue in a buildable state.
- getBuildableDurationMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the duration this
Run
spent in the queue in a buildable state.
- getBuildableDurationString() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
- getBuildableTimeMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the total time this
Run
, and any associated
SubTask
s, spent in the queue in a
buildable state.
- 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
-
- 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
-
- 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.SubTaskTimeInQueueAction
- getDisplayName() - Method in class jenkins.metrics.impl.TimeInQueueAction
- getDynamic(String) - Method in class jenkins.metrics.api.MetricsRootAction
-
- getEventMillis() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
- getEventTick() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
- getExecutable() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
Returns the Queue.Executable
created from the Queue.Item
belongs.
- getExecutingDurationMillis() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
-
Returns the duration this
SubTask
spent executing.
- getExecutingMillis() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
If the Queue.Executable
has finished executing, returns the number of milliseconds the item spent
executing.
- getExecutingTimeMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the duration this
Run
spent 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.Executable
has 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 Gauge
that 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
-
- getHealthCheckDuration() - Method in class jenkins.metrics.api.Metrics.HealthChecker
-
Gets the Timer
that 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 HealthCheck
instances keyed by name.
- getHealthChecks() - Method in class jenkins.metrics.impl.JenkinsHealthCheckProviderImpl
-
- getHealthCheckScore() - Method in class jenkins.metrics.api.Metrics.HealthChecker
-
Gets the Gauge
that tracks the health check score.
- getHistograms() - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
-
- getHistograms(MetricFilter) - Method in class jenkins.metrics.util.NameRewriterMetricRegistry
-
- 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
-
- getOrigins() - Method in class jenkins.metrics.api.MetricsAccessKey
-
- getQueuingBlockedMillis() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
If the Queue.Item
has 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.Item
has 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
-
- getQueuingDurationMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the duration this
Run
spent 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
Run
spent 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.Item
has 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.Item
has 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
Run
to which the
Queue.Item
belongs.
- getRun() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
- getState() - Method in class jenkins.metrics.api.QueueItemMetricsEvent
-
Returns the state of the Queue.Item
when 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 null
if 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 null
if that metric is unavailable.
- getWaitingDurationMillis() - Method in class jenkins.metrics.impl.SubTaskTimeInQueueAction
-
Returns the duration this
SubTask
spent in the queue waiting before it could be considered for execution.
- getWaitingDurationMillis() - Method in class jenkins.metrics.impl.TimeInQueueAction
-
Returns the duration this
Run
spent 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
-
Returns the total time this
Run
, and any associated
SubTask
s, spent in the queue waiting
before it could be considered for execution.
- 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
.
- 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
MetricRegistry
for the current
Jenkins
.
- 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.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
-
- 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
: {@code This
permission grants access to the health check functionality of the
Metrics servlet.
- 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
: {@code This
permission grants read-only access to the thread dump functionality of
the Metrics servlet.
- Metrics_ViewPermission_Description() - Static method in class jenkins.metrics.api.Messages
-
Key Metrics.ViewPermission.Description
: {@code This permission
grants read-only access to the Metrics servlet.
- MetricsAccessKey - Class in jenkins.metrics.api
-
- 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
-
- 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.
- 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}
.
- 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.