Page Comparison

Info
Starting with version 3.0.0-jira8 for Prometheus Exporter PRO, you are able to see and manage collected metrics in the app configuration.

Go to Administration → Manage apps → Prometheus Exporter → Metrics and select which metrics must be collected and how (in real-time or by a scheduled job), see the last execution date and how long metrics were executed.

Image Added

Once you configure your Prometheus Exporter, you can expose the following metrics into Prometheus:.

...

Table of Contents

...

maxLevel

...

4
minLevel	4

Metrics description

Metrics	Type	Description

JVM Metrics - see examples below

jvm_buffer_pool_used_bytes

GaugeUsed bytes of a given JVM buffer pool

jvm_buffer_pool_capacity_bytes

GaugeBytes capacity of a given JVM buffer pool

jvm_buffer_pool_used_buffers

GaugeUsed buffers of a given JVM buffer pool

jvm_threads_current

GaugeCurrent thread count of a JVM

Request Duration Prometheus Metrics Module
jira_request_duration_on_path	Histogram	Shows how long requests were executed on the Jira server. It does not take into consideration the browser execution and network execution time. Read more here.
Mail Metrics Module
jira_mail_queue_gauge	Gauge	Mail queue gauge. Read more here.
jira_mail_queue_error_gauge	Gauge	Mail queue error gauge. Read more here.
User Metrics Module
jira_total_sessions_gauge	Gauge	Sessions gauge. Read more here.

jvm

jira_authorized_

threads

sessions_

daemon

gauge

Gauge

Daemon thread count of a JVM

Authorized sessions gauge. Read more here.

jvm

jira_user_

threads

login_

peak

count

Gauge

Counter

Peak thread count of a JVM

User login count. The number of onLoginEvent events.Read more here.

jvm

jira_

threads

user_

started

logout_

total

count

Counter

Started thread count of a JVM.

User logout count. The number of onLogoutEvent eventsRead more here.

jvm_threads_deadlocked

jira_http_session_objects_gauge

Gauge

Cycles of JVM threads that are in deadlock waiting to acquire object monitors or ownable synchronizers. Read more here.

jvm_threads_deadlocked_monitor

GaugeCycles of JVM threads that are in deadlock waiting to acquire object monitors

Number of HTTP session objects gauge. This gauge uses Jira Instrumentation API metric HTTP_SESSION_OBJECTS. It shows how many session attributes existed in Jira at a certain period of time. Also you can read here.
jira_all_users_gauge	Gauge	All users gauge. Read more here.

jvm

jira_active_

threads

users_

state

gauge

Gauge

Current count of threads by state

Active users for each application gauge. Read more here.

jvm

jira_

gc

allowed_

collection

users_

seconds

gauge

CounterTime spent in a given JVM garbage collector in seconds.
See this page for a an example with details.

jvm_info

GaugeJVM version info

jvm_memory_pool_allocated_bytes_total

CounterTotal bytes allocated in a given JVM memory pool. Only updated after GC, not continuously.

Gauge	Allowed users gauge. Read more here.
jira_all_active_users_gauge	Gauge	All active users for Jira gauge
Jira Entities Metrics Module
jira_total_attachment_size_gauge	Gauge	Total attachments size gauge. Read more here.

jvm

jira_

memory

total_

bytes

attachments_

used

gauge

Gauge

Used bytes of a given JVM memory area

jvm_memory_bytes_committed

GaugeCommitted (bytes) of a given JVM memory area

jvm_memory_bytes_max

GaugeMax (bytes) of a given JVM memory area

jvm_memory_bytes_init

GaugeInitial bytes of a given JVM memory area

jvm_memory_pool_bytes_used

GaugeUsed bytes of a given JVM memory pool

Number of attachments in Jira. This metric is available for Jira versions 8.0 and above.
jira_total_issues_gauge	Gauge	Issues gauge. Read more here.
jira_issue_update_count	Counter	Issue update count. Read more here.
jira_issue_view_count	Counter	Issue view count. The number of onIssueViewEvent events. Read more here.
jira_dashboard_view_count	Counter	Dashboard view count, see example below. The number of onDashboardViewEvent events. Read more here.

jvm

jira_concurrent_

memory

number_

pool

of_

bytes

quicksearches_

committedDays till license expiry

gauge

Gauge

Committed bytes of a given JVM memory pool. Read more here.

jvm_memory_pool_bytes_max

Gauge

Max bytes of a given JVM memory pool. Read more here.

jvm_memory_pool_bytes_init

Gauge

Initial bytes of a given JVM memory pool. Read more here.

jvm_classes_loaded

GaugeNumber of classes that are currently loaded in the JVM

jvm_classes_loaded_total

CounterNumber of classes that have been loaded since the JVM has started execution

jvm_classes_unloaded_total

CounterNumber of classes that have been unloaded since the JVM has started execution

jvm_uptime_gauge

GaugeJVM uptime gauge

process_cpu_seconds_total

CounterTotal user and system CPU time spent in seconds

process_start_time_seconds

Gauge

Start time of the process since Unix epoch in seconds

process_open_fds

GaugeNumber of open file descriptors

process_max_fds

GaugeMaximum number of open file descriptors

process_virtual_memory_bytes

GaugeVirtual memory size in bytes

process_resident_memory_bytes

GaugeResident memory size in bytes

jira_maintenance_expiry_days_gauge

Gauge

Days till maintenance expiry

jira_license_expiry_days_gauge

Gauge

Number of concurrent quick searches. This gauge uses Jira Instrumentation API metric QUICKSEARCH_CONCURRENT_REQUESTS. It shows how many requests were executed concurrently at a certain point of time from the quick search in the Jira navigation bar. Also you can read here.
jira_issue_index_reads_counter	Counter	Issue index reads requests count. Read more here. This metric is available for Jira versions 8.0 and above.
jira_issue_index_writes_counter	Counter	Issue index writes requests count. Read more here. This metric is available for Jira versions 8.0 and above.
jira_total_workflows_gauge	Gauge	Workflows gauge. Read more here. This metric is available for Jira versions 8.0 and above.
jira_total_customfields_gauge	Gauge	Custom fields gauge. Read more here. This metric is available for Jira versions 8.0 and above.
jira_total_groups_gauge	Gauge	Number of groups in Jira. Read more here. This metric is available for Jira versions 8.0 and above.
jira_total_projects_gauge	Gauge	Number of projects in Jira. Read more here. This metric is available for Jira versions 8.0 and above.
jira_total_versions_gauge	Gauge	Number of versions in Jira. Read more here. This metric is available for Jira versions 8.0 and above.
jira_total_filters_gauge	Gauge	Number of filters in Jira. Read more here. This metric is available for Jira versions 8.0 and above.
jira_total_components_gauge	Gauge	Number of components in Jira. Read more here. This metric is available for Jira versions 8.0 and above.
jira_application_link_count_gauge	Gauge	Application Link Count Gauge
jira_application_link_status_gauge	Gauge	Application Link Status Gauge
Jira Database Metrics Module
jira_dbcp_num_active_gauge	Gauge	DBCP number of active connections gauge. Read more here.
jira_dbcp_num_idle_gauge	Gauge	DBCP number of idle connections gauge. Read more here.
jira_dbcp_max_active_gauge	Gauge	DBCP max number of connections gauge. Read more here.
jira_db_connections_counter	Counter	DB Number of connections. Read more here.
jira_db_borrowed_connections_gauge	Gauge	DB Number of borrowed connections gauge. Read more here.
jira_db_reads_counter	Counter	DB Number of reads gauge. Read more here.
jira_db_writes_counter	Counter	DB Number of writes gauge. Read more here.
Jira Request Metrics Module
jira_web_requests_counter	Counter	Number of web requests gauge. This gauge uses Jira Instrumentation API metric WEB_REQUESTS. This metric shows how many web requests, including rest requests, were executed. You can also read more here.
jira_rest_requests_gauge	Gauge	Number of REST requests gauge. This gauge uses Jira Instrumentation API metric REST _REQUESTS. This metric shows how many rest requests were executed . You can also read more here.
jira_concurrent_requests_gauge	Gauge	Number of concurrent requests being processed in a Jira instance. This gauge uses Jira Instrumentation API metric CONCURRENT_REQUESTS.
Jira System Metrics Module

jira_concurrent_number_of_quicksearches


jvm_uptime_gauge	Gauge

Number of concurrent quick searches. This gauge uses Jira Instrumentation API metric QUICKSEARCH_CONCURRENT_REQUESTS. It shows how many requests were executed concurrently at a certain point of time from the quick search in the Jira navigation bar. Also you can read

JVM uptime gauge
jira_plugin_enabled_count	Counter	Plugin enabled count. Read more here.
jira_

http

plugin_

session

disabled_

objects_gaugeAlso you can read

count

Gauge

Number of HTTP session objects gauge. This gauge uses Jira Instrumentation API metric HTTP_SESSION_OBJECTS. It shows how many session attributes existed in Jira at a certain period of time.

Counter	Plugin disabled count. Read more here.
jira_

mail

plugin_

queue

uninstalled_

gauge

count

GaugeMail queue gauge

Counter	Plugin uninstalled count. Read more here.
jira_

mail

maintenance_

queue

expiry_

error

days_gauge

Gauge

Mail queue error gauge. Read more here.

Days till maintenance expiry

jira_license_

total

expiry_

workflows

days_gauge

Gauge

Workflows gauge. Read more here.
This metric is available for Jira versions 8.0 and above.

Days till license expiry

jira_total_

customfields

cluster_nodes_gauge

Gauge

Custom fields

Total cluster nodes gauge. Read more here.
This metric is available for Jira versions

8

7.7.

0

1 and above.

jira_active_

total

cluster_

groups

nodes_gauge

Gauge

Number of groups in Jira

Active cluster nodes gauge. Read more here.

This metric is available for Jira versions 8.0 and above.

jira_

total

cluster_

projects

heartbeat_

gauge

counter

Gauge

Number of projects in Jirajira_total_versions_gaugeGaugeNumber of versions in Jira

Cluster heartbeat counter. Read more here.

This metric is available for Jira versions 8.0 and above.

jira_cluster_cache_replication_resumed_counter

Gauge

Cluster cache replication resumed counter. Read more here.
This metric is available for Jira versions

8

7.7.

0

1 and above.

jira_

total_filters_gauge

cluster_cache_replication_stopped_counter

Gauge

Number of filters in Jira

Cluster cache replication stopped counter. Read more here.
This metric is available for Jira versions

8

7.7.

0

1 and above.

jira_total_components_gaugeThe number of onIssueViewEvent events

Prometheus Standard Metrics

^{*cannot be managed on the app side}

jvm_buffer_pool_used_bytes

Gauge

Number of components in Jira. Read more here.
This metric is available for Jira versions 8.0 and above.

Issue statistics - see example below

jira_issue_update_count

Counter

Issue update count. Read more here.

jira_issue_view_count

CounterIssue view count.

Used bytes of a given JVM buffer pool
jvm_buffer_pool_capacity_bytes	Gauge	Bytes capacity of a given JVM buffer pool
jvm_buffer_pool_used_buffers	Gauge	Used buffers of a given JVM buffer pool
jvm_threads_current	Gauge	Current thread count of a JVM. Read more here.

jira

jvm_

total

threads_

issues_gauge

daemon

Gauge

Issues gauge

Daemon thread count of a JVM. Read more here.

jira

jvm_

total

threads_

sessions_gauge

peak

Gauge

Sessions gauge

Peak thread count of a JVM. Read more here.

jira

jvm_

authorized

threads_

sessions

started_

gauge

total

GaugeAuthorized sessions gauge

Counter

Started thread count of a JVM. Read more here.

jira

jvm_

dashboard

threads_

view_counthe number of onDashboardViewEvent events

deadlocked

CounterDashboard view count, see example below. T

Gauge

Cycles of JVM threads that are in deadlock waiting to acquire object monitors or ownable synchronizers. Read more here.

jira

jvm_

plugin

threads_

enabled

deadlocked_

count

monitor

CounterPlugin enabled count

Gauge

Cycles of JVM threads that are in deadlock waiting to acquire object monitors. Read more here.

jira

jvm_

plugin

threads_

disabled_count

state

Counter

Gauge

Plugin disabled count

Current count of threads by state. Read more here.

jira

jvm_

plugin

gc_

uninstalled

collection_

count

seconds

Counter

Plugin uninstalled count. Read more here.

jira_request_duration_on_path

Histogramthe jira_request_duration_on_path metric shows how long requests were executed on the Jira server. It does not take into consideration the browser execution and network execution time

Time spent in a given JVM garbage collector in seconds. See this page for a an example with details.
jvm_info	Gauge	JVM version info
jvm_memory_pool_allocated_bytes_total	Counter	Total bytes allocated in a given JVM memory pool. Only updated after GC, not continuously. Read more here.

jira

jvm_

issue

memory_

index

bytes_

reads_counter

used

CounterIssue index reads requests count. Read more here.
This metric is available for Jira versions 8.0 and above.jira_issue_index_writes_counterCounterIssue index writes requests count. Read more here.
This metric is available for Jira versions 8.0 and above.

User sessions

jira_user_login_count

Counter

User login count. The number of onLoginEvent events.Read more here.

jira_user_logout_count

Counter

User logout count. The number of onLogoutEvent eventsRead more here.

jira_allowed_users_gauge

GaugeAllowed users gauge

Gauge	Used bytes of a given JVM memory area
jvm_memory_bytes_committed	Gauge	Committed (bytes) of a given JVM memory area
jvm_memory_bytes_max	Gauge	Max (bytes) of a given JVM memory area
jvm_memory_bytes_init	Gauge	Initial bytes of a given JVM memory area
jvm_memory_pool_bytes_used	Gauge	Used bytes of a given JVM memory pool. Read more here.

jira

jvm_memory_

all

pool_

users

bytes_

gauge

committed

Gauge

All users gauge

Committed bytes of a given JVM memory pool. Read more here.

jira

jvm_memory_

active

pool_

users

bytes_

gauge

max

Gauge

Active users gauge

Max bytes of a given JVM memory pool. Read more here.

Attachment disk space

jira_total_attachment_size_gauge

GaugeTotal attachments size gauge

jvm_memory_pool_bytes_init

Gauge

Initial bytes of a given JVM memory pool. Read more here.

jira

jvm_

total

classes_

attachments_gauge

loaded

Gauge

Number of

attachments in Jira.
This metric is available for Jira versions 8.0 and above.

Cluster metrics

jira_total_cluster_nodes_gauge

Gauge

Total cluster nodes gauge. Read more here.
This metric is available for Jira versions 7.7.1 and above.

jira_active_cluster_nodes_gauge

Gauge

Active cluster nodes gauge. Read more here.

jira_cluster_heartbeat_counter

Gauge

Cluster heartbeat counter. Read more here.

jira_cluster_cache_replication_resumed_counter

Gauge

Cluster cache replication resumed counter. Read more here.
This metric is available for Jira versions 7.7.1 and above.

jira_cluster_cache_replication_stopped_counter

GaugeCluster cache replication stopped counter. Read more here.
This metric is available for Jira versions 7.7.1 and above.

classes that are currently loaded in the JVM
jvm_classes_loaded_total	Counter	Number of classes that have been loaded since the JVM has started execution
jvm_classes_unloaded_total	Counter	Number of classes that have been unloaded since the JVM has started execution
process_cpu_seconds_total	Counter	Total user and system CPU time spent in seconds
process_start_time_seconds	Gauge	Start time of the process since Unix epoch in seconds
process_open_fds	Gauge	Number of open file descriptors
process_max_fds	Gauge	Maximum number of open file descriptors
process_virtual_memory_bytes	Gauge	Virtual memory size in bytes
process_resident_memory_bytes	Gauge	Resident memory size in bytes

Examples

JVM metrics examples

Expand

title	Jira CPU Usage

Expand

title	Memory Usage

Issue statistics example

Expand

title	Example - Dashboard Views statistics example

...

Versions Compared

Old Version 1

New Version Current

Key

Metrics description

Metrics

Type

Description

JVM Metrics - see examples below

Request Duration Prometheus Metrics Module

Mail Metrics Module

User Metrics Module

Jira Entities Metrics Module

Jira Database Metrics Module

Jira Request Metrics Module

Jira System Metrics Module

Prometheus Standard Metrics

Issue statistics - see example below

User sessions

Attachment disk space

Cluster metrics

Examples

JVM metrics examples

Issue statistics example

Related articles