PE - Using Prometheus Exporter for Confluence

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 AdministrationManage appsPrometheus ExporterMetrics 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

MetricsTypeDescription

Request Duration Prometheus Metrics Module

confluence_request_duration_on_pathHistogramShows how long requests were executed on the server. It does not take into consideration the browser execution and network execution time. Read more here.

Confluence JMX Metrics Module

confluence_jmx_indexstat_flushing

GaugeIndicates whether the cache is currently flushing

confluence_jmx_indexstat_last_duration

CounterTime taken during last indexing (ms)

confluence_jmx_indexstat_task_queue

CounterShows number of tasks in the queue

confluence_jmx_indexstat_reindexing

GaugeIndicates whether Confluence is currently reindexing

confluence_jmx_systemstat_db_latency

CounterShows the latency of an example query performed against the database

confluence_jmx_request_avg_exectime_of_ten_requests

CounterShows the latency of an example query performed against the database

confluence_jmx_request_current_served_number

CounterNumber of requests being served at this instant

confluence_jmx_request_errorpage_count

CounterNumber of times the Confluence error page was served

confluence_jmx_request_num_in_last_ten_seconds

CounterThe number of requests in the last ten seconds

confluence_jmx_emails_attempted_count

Counter

The number of email messages Confluence has tried to send. for each mail server added in Confluence. This metric has a label called mailservername (only for Data Center from v.1.0.26)

confluence_jmx_emails_sent_count

CounterThe number of email messages sent successfully for each mail server added in Confluence. This metric has a label called mailservername (only for Data Center from v.1.0.26)

confluence_jmx_mail_queue_error_queue_size

GaugeNumber of errors in the queue (only for Data Center from v.1.0.26)

confluence_jmx_mail_queue_flushing

GaugeShows state (i.e. flushing, or not) (only for Data Center from v.1.0.26)

confluence_jmx_mail_queue_retry_count

GaugeThe number of retries that were performed (only for Data Center from v.1.0.26)

confluence_jmx_mail_queue_tasks_size

GaugeNumber of email messages queued for dispatch (only for Data Center from v.1.0.26)

jvm_uptime_gauge

GaugeJVM Uptime Gauge

Confluence System Metrics Module

confluence_maintenance_expiry_days_gauge

GaugeMaintenance Expiry Days Gauge

confluence_license_expiry_days_gauge

Gauge

License Expiry Days Gauge (since version 1.0.21)

confluence_total_cluster_nodes_gauge

GaugeTotal Cluster Nodes Gauge

confluence_cluster_panic_count

CounterCluster Panic Count

confluence_plugin_enabled_count

CounterPlugin Enabled Count

confluence_plugin_disabled_count

CounterPlugin Disabled Count

confluence_plugin_install_count

CounterPlugin Install Count

confluence_plugin_uninstall_count

CounterPlugin Uninstall Count

Confluence User Metrics Module

confluence_active_users_gauge

GaugeActive Users Gauge

confluence_one_hour_active_users_gauge

GaugeThe total number of logins within the last hour

confluence_today_active_users_gauge

GaugeUsers Login Today Gauge

confluence_allowed_users_gauge

GaugeAllowed Users Gauge

confluence_user_logout_count

CounterUser Logout Count

confluence_user_login_count

CounterUser Login Count. See example below.

confluence_user_failed_login_count

CounterUser Failed Login Count

Confluence Entity Metrics Module

confluence_total_attachment_size_gauge

GaugeTotal Attachments Size Gauge

confluence_current_contents_gauge

GaugeCurrent Contents Gauge

confluence_global_spaces_gauge

GaugeGlobal Spaces Gauge

confluence_personal_spaces_gauge

GaugePersonal Spaces Gauge

confluence_pages_gauge

GaugeTotal Pages Gauge

confluence_blogposts_gauge

GaugeTotal BlogPosts Gauge

confluence_label_create_count

CounterLabel Create Count

confluence_label_add_count

CounterLabel Add Count

confluence_label_remove_count

CounterLabel Remove Count

confluence_label_delete_count

CounterLabel Delete Count

confluence_space_create_count

CounterSpace Create Count

confluence_space_delete_count

CounterSpace Delete Count

Confluence Mail Metrics Module

confluence_mail_queue_gaugeGauge
Current Mail Queue Gauge
confluence_mail_queue_errors_gaugeGauge
Current Mail Queue Errors Gauge

On top of predefined metrics within Prometheus Exporter PRO for Confluence there is an option to add custom metrics by creating your own app. For more details refer to the following detailed guide. Creating app for Confluence is similar to creating app for Jira.

JVM metrics examples

 JVM threads


 Memory usage


Login / logout statistics example

 Login count


What's next

Configuring Prometheus Exporter for Confluence