PE - Using Prometheus Exporter for Jira
- Karina Zoin
- Iryna Ihnatiuk
- Elena Kolesnik
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.
Once you configure your Prometheus Exporter, you can expose the following metrics into Prometheus.
Metrics description
Metrics | Type | Description |
|---|---|---|
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. |
jira_authorized_sessions_gauge | Gauge | Authorized sessions gauge. Read more here. |
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_http_session_objects_gauge | 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. Also you can read here. |
jira_all_users_gauge | Gauge | All users gauge. Read more here. |
jira_active_users_gauge | Gauge | Active users for each application gauge. Read more here. |
jira_allowed_users_gauge | 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. |
| jira_total_attachments_gauge | Gauge | Number of attachments in Jira. |
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 14681669 below. The number of onDashboardViewEvent events. Read more here. |
jira_concurrent_number_of_quicksearches_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. |
| 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 | ||
jvm_uptime_gauge | Gauge | JVM uptime gauge |
jira_plugin_enabled_count | Counter | Plugin enabled count. Read more here. |
jira_plugin_disabled_count | Counter | Plugin disabled count. Read more here. |
jira_plugin_uninstalled_count | Counter | Plugin uninstalled count. Read more here. |
jira_maintenance_expiry_days_gauge | Gauge | Days till maintenance expiry |
jira_license_expiry_days_gauge | Gauge | Days till license expiry |
jira_total_cluster_nodes_gauge | Gauge | Total cluster nodes gauge. Read more here. |
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. |
jira_cluster_cache_replication_stopped_counter | Gauge | Cluster cache replication stopped counter. Read more here. |
Prometheus Standard Metrics
| ||
jvm_buffer_pool_used_bytes | Gauge | 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. |
jvm_threads_daemon | Gauge | Daemon thread count of a JVM. Read more here. |
jvm_threads_peak | Gauge | Peak thread count of a JVM. Read more here. |
jvm_threads_started_total | Counter | Started thread count of a JVM. Read more here. |
jvm_threads_deadlocked | Gauge | Cycles of JVM threads that are in deadlock waiting to acquire object monitors or ownable synchronizers. Read more here. |
jvm_threads_deadlocked_monitor | Gauge | Cycles of JVM threads that are in deadlock waiting to acquire object monitors. Read more here. |
jvm_threads_state | Gauge | Current count of threads by state. Read more here. |
jvm_gc_collection_seconds | Counter | 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. |
jvm_memory_bytes_used | 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. |
jvm_memory_pool_bytes_committed | 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 | Gauge | Number of 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
Issue statistics example
