JMX (Java Management Extensions API) allows you to monitor the status of your Confluence instance in real time. JMX uses objects called MBeans (Managed Beans) to expose data and resources from your application, providing useful data such as the resource usage of your instance and its database latency, allowing you to diagnose problems or performance issues.
On this page, we'll guide you through how to use JConsole to monitor Confluence locally and remotely. JConsole is included in the Java Development Kit (JDK), but you can use any JMX client.
This page also contains information about In-product diagnostics available through JMX.
JMX によって Confluence を監視する APM によって Confluence をリモート監視する To monitor Confluence in your Application Performance Monitoring (APM) tool, you'll need to install a JMX exporter to transform theJMX MBeans into the right format for your tool. See Monitor application performance to find out how to do this.
If you don't have an Application Performance Monitoring (APM) system, we've created a guide to get you started with Prometheus and Grafana, including some template dashboards that you can use as a jumping off point. See Monitor Confluence with Prometheus and Grafana .
JConsole を使用してた Confluence のリモート監視 リモート監視は、Confluence サーバーのリソースを消費しないため、本番環境システムにお勧めです。
リモートで監視するには:
以下のプロパティを setenv.sh / setenv.bat ファイルに追加します。ポートは未使用の任意のポートに設定できます。
set CATALINA_OPTS=-Dcom.sun.management.jmxremote%CATALINA_OPTS%
set CATALINA_OPTS=-Dcom.sun.management.jmxremote.port=8099%CATALINA_OPTS%
Decide how you will secure your remote connection. See Remote Monitoring and Management for more information.
JConsole を起動します (JDK インストール ディレクトリの bin ディレクトリにあります)。 リモート プロセス を選択します。ホスト名とポートを (Confluence ポートではなく、以前に指定したポート) を入力します。 接続 をクリックします。See Using JConsole for more information on remote monitoring.
JConsole を使用して Confluence をローカルで監視する 特定の課題のトラブルシューティングや、Confluence を短期間のみ監視する必要がある場合は、ローカル監視を使用できます。ローカル監視はサーバーのパフォーマンスに影響を与える可能性があるため、本番システムの長期的な監視にはお勧めしません。
ローカルに監視するには:
JConsole を起動します (JDK インストール ディレクトリの bin ディレクトリにあります)。
ローカル プロセス を選択します。Confluence プロセスを選択します。org.apache.catalina.startup.Bootstrap start のようになります。
See Using JConsole for more information on local monitoring.
JMX メトリックをログ ファイルに書き込む 次の JMX メトリクスをログ ファイルに書き込むことも選択できます。これは、問題をトラブルシューティングする際に便利です。
キャッシュ統計 IndexingStatistics MailTaskQueue RequestMetrics システム情報 スレッド プール OS GC Threading TomcatManager RequestProcessor JMX メトリクスをログ ファイルに書き込むには、次の手順に従います。
Go to Administration menu General Configuration Scheduled jobs JMX メトリックをログ ジョブを有効にします。 This job runs once per minute by default, and writes metrics to the <local-home/logs/atlassian-confluence-jmx.log file. See Working with Confluence Logs
JMX 監視を無効にする JMX 監視を無効にするには、次の手順に従います。
Go to Administration menu General Configuration [JMX 監視 ] を選択解除します。 これによって、JMX を有効にする必要があるためアプリ監視も無効になります。
Confluence MBeans 以下の Confluence MBeans を使用して、Confluence インスタンスに関するライブ情報を確認できます。
キャッシュ統計 This MBean shows information about Confluence caches. This info can also be found on the Cache Statistics page.
IndexingStatistics この MBean は検索インデックス作成に関連する情報を表示します。便利な属性をいくつか示します。
プロパティ名
機能
値
Flushing
キャッシュが現在フラッシュ中かどうかを示す
True/False
LastElapsedMilliseconds
最後のインデックス作成の所要時間
ミリ秒
TaskQueueLength
キューにあるタスクの数を表示
整数
ReIndexing Confluence が現在再インデックス中かどうかを示す True/False
This MBean shows information such as the Confluence version and uptime. This info can also be found on the System Information page.
プロパティ名
機能
値
DatabaseExampleLatency
データベース対して実行されたクエリ例の待ち時間を表示。
ミリ秒
RequestMetrics この MBean はシステム負荷と表示されたエラーページに関連する情報を表示します。
プロパティ名
機能
値
AverageExecutionTimeForLastTenRequests
最新 10 件の要求の平均実行時間。
ミリ秒
CurrentNumberOfRequestsBeingServed
この時点で提供されている要求の数。
整数
ErrorCount
Confluence エラーページが提供された回数。
整数
NumberOfRequestsInLastTenSeconds
最近 10 秒間の要求数。
整数
MailServer-SMTPServer この MBean は、メールディスパッチの試行と失敗に関連する情報を表示します。Confluence インスタンスで設定された SMTP メールサーバーごとに MBean があります。
プロパティ名
機能
値
EmailsAttempted
Confluence が送信しようとしたメールメッセージの数。
整数
EmailsSent
正常に送信されたメールメッセージの数。
整数
MailTaskQueue この MBean は、メールワークロードに関連する情報を示します。
プロパティ名
機能
値
ErrorQueueSize
キュー内のエラー数。
整数
Flushing
状態 (フラッシュの有無) を表示。
True/False
FlushStarted
稼働を開始した時間。
時間
RetryCount
実行された再試行の回数。
整数
TaskSize
ディスパッチのためにキューに入れられたメールメッセージの数。
整数
SchedulingStatistics この MBean は現在のジョブ、スケジュール済みタスク、およびそれらが最後に実行された時間に関連する情報を表示します。
プロパティ名 機能 値 AllJobNames 現在のジョブ、スケジュール済みタスク、およびそれらが最後に実行された時間に関連する情報を表示する 文字列 CurrentlyRunningJobNames 現在実行中のスケジュール済みジョブを一覧表示する 一覧
アプリ固有の指標 Enable app monitoring to expose additional metrics that are useful when troubleshooting issues with Marketplace and custom-built apps.
See App metrics reference for a full list of app-specific metrics.
追加の MBeans Hibernate および Hazelcast を監視する (Confluence Data Center のみ) には、まず、setenv.sh / setenv.bat ファイルに次のプロパティを追加する必要があります。
set CATALINA_OPTS=-Dconfluence.hazelcast.jmx.enable=true%CATALINA_OPTS%
set CATALINA_OPTS=-Dconfluence.hibernate.jmx.enable=true%CATALINA_OPTS%
これにより、お使いの JMX クライアントでハイバーネイトおよび Hazelcast MBeans を使用できるようになります。
CPU 消費量が多いスレッドを監視する The Top Threads Plugin for JConsole is useful for monitoring whether the CPU is spiking. Use the following command to start JConsole with this plugin:
JConsole -pluginpath /pathto/topthreads.jar
データベース接続、HTTP 接続、インデックス作成に関する製品内診断用メトリックを組み合わせて JMX から利用できるようになりました。
製品内診断 (IPD) では、実行中のインスタンスの動作についてより深いインサイトが得られます。
IPD では、Confluence とそのデータベースの間のやりとりを処理する追加のメトリックを使用します。たとえば、データベース接続メトリックを使用することで、環境やインフラストラクチャでパフォーマンスの問題を発生させる可能性のある要素を効率的に特定できます。
この機能は既定で有効になっています。実際のメトリックは次の形式で利用できます。
The log file is also included in the Support Zip file created in the Atlassian Troubleshooting and Support app . If needed, send the zip file to Atlassian Support who has the internal tools to interpret it.
The log file is available in the {confluence_home}\logs folder where you can find all the existing log files. The log file is also included in the Support Zip file created in the ATST plugin. If needed, you can generate the Support Zip file in the Atlassian troubleshooting & support tools plugin and send the file to Atlassian Support, where we have internal tools to interpret it. Learn more about the plugin
コミュニケーション この機能では通信に次の方法が使用されます。
製品内診断メトリック 次のセクションを展開して、製品内診断で利用できるメトリックの詳細を学習してください。
データベース接続メトリック
MBean オブジェクト名
メトリックの説明
com.atlassian.confluence:type=metrics,category00=db,category01=connection,
データベースに対するクエリ送信時の最新のレイテンシ測定値
データベース接続が失われた場合は -1 に設定します。
com.atlassian.confluence:type=metrics,
前回の再起動以降のレイテンシの集計統計
com.atlassian.confluence:type=metrics,
前回の再起動以降のデータベース接続プール内のアクティブ接続数の集計統計
com.atlassian.confluence:type=metrics,
データベース接続プール内のアクティブ接続数の最新の測定値。
データベース接続が失われた場合は -1 に設定します。
com.atlassian.confluence:type=metrics,
前回の再起動以降のデータベース接続プール内のアイドル接続数の集計統計
com.atlassian.confluence:type=metrics,
データベース接続プール内のアイドル接続数の最新の測定値。
データベース接続が失われた場合は -1 に設定します。
com.atlassian.confluence:type=metrics,
データベースへの接続状態を示す最新のインジケーター (0 は接続に失敗した、1 は正常に動作している)
com.atlassian.confluence:type=metrics,
前回の再起動以降のデータベース接続障害の回数
HTTP 接続メトリック
Bean オブジェクト名
メトリックの説明
com.atlassian.confluence:type=metrics,
HTTP 接続プール内のアクティブ接続数の最新の測定値。複数のプールが定義されている場合、すべてのプールからアクティブな接続の合計が返されます。
com.atlassian.confluence:type=metrics,
HTTP 接続プール内のアイドル接続数の最新の測定値。複数のプールが定義されている場合、すべてのプールからアイドル接続の合計が返されます。
com.atlassian.confluence:type=metrics,
HTTP コネクタによって作成され、リクエストに使用できるスレッドの最大数。
com.atlassian.confluence:type=metrics,
アクティブなユーザー セッション数の最新の指標
com.atlassian.confluence:type=metrics,
アクティブなユーザー セッション数の集計統計
com.atlassian.confluence:type=metrics,
最近のユーザー セッション数の最新の指標。最近のセッションとは、直近 1 時間にアクティブだったセッションのことです
com.atlassian.confluence:type=metrics
1 分あたりの HTTP リクエストの総数の最新の測定値
com.atlassian.confluence:type=metrics,
1 分あたりの HTTP リクエストの総数の集計統計
インデックス作成メトリック
Bean オブジェクト名 メトリックの説明 com.atlassian.confluence:type=metrics, 完全なインデックス再作成の所要時間 。複数のノードの場合、メトリックはインデックス再作成が行われているノードでのみ発行されます。
com.atlassian.confluence:type=metrics, 完全なインデックス再作成 の所要時間の集計統計
com.atlassian.confluence:type=metrics, tag.queueName: main
main キューに残っているアイテムの数。main キューに残っているアイテムの数が増えている場合、同じ期間に処理されたアイテムよりも多くのアイテムがキューに追加されていることを示している可能性があります。
com.atlassian.confluence:type=metrics, tag.queueName: change
change キューに残っているアイテムの数。change キューに残っているアイテムの数が増えている場合、同じ期間に処理されたアイテムよりも多くのアイテムがキューに追加されていることを示している可能性があります。
com.atlassian.confluence:type=metrics, com.atlassian.confluence.metrics. tag.queueName: edge
edge キューに残っているアイテムの数。edge キューに残っているアイテムの数が増えている場合、同じ期間に処理されたアイテムよりも多くのアイテムがキューに追加されていることを示している可能性があります。
com.atlassian.confluence:type=metrics, com.atlassian.confluence.metrics. tag.queueName: change
change キューの IPD 測定間隔における
既定の IPD 測定間隔は 1 分です。
com.atlassian.confluence:type=metrics, com.atlassian.confluence.metrics. tag.queueName: edge
edge キュー の IPD 測定間隔における
既定の IPD 測定間隔は 1 分です。
com.atlassian.confluence:type=metrics, com.atlassian.confluence.metrics. tag.queueName: main
main キューの IPD 測定間隔におけるメイン のインデックス キューは、コンテンツ インデックス キュー とも呼ばれます。
既定の IPD 測定間隔は 1 分です。
com.atlassian.confluence:type=metrics, com.atlassian.confluence.metrics.
tag.queueName: change
change キューのバッチ処理時間の集計統計。
com.atlassian.confluence:type=metrics, tag.queueName: edge
edge キューのバッチ処理時間の集計統計。
com.atlassian.confluence:type=metrics, tag.queueName: main
main キューのバッチ処理時間の集計統計。
com.atlassian.confluence:type=metrics, tag.queueName: change
change キューに追加されたアイテムの数。
com.atlassian.confluence:type=metrics, tag.queueName: edge
edge キューに追加されたアイテムの数。
com.atlassian.confluence:type=metrics, tag.queueName: main
main キューに追加されたアイテムの数。
com.atlassian.confluence:type=metrics, tag.queueName: change
1 分以内に処理された変更キューのアイテムの数。
com.atlassian.confluence:type=metrics, tag.queueName: edge
1 分以内 edge キュー内のアイテムの数。
com.atlassian.confluence:type=metrics, tag.queueName: main
1 分以内 main キュー内のアイテムの数。
インフラストラクチャのメトリック
MBean オブジェクト名 メトリックの説明 クラスタ メトリック com.atlassian.confluence:type=metrics, node.latency.statisticsdestNode=<nodeId>
com.atlassian.confluence:type=metrics, node.connection.state.customdestNode=<nodeId>
メール サーバー メトリック com.atlassian.confluence:type=metrics, mail.outgoing.connection.state.custom
com.atlassian.confluence:type=metrics, mail.incoming.connection.state.customserverName=<mailName>
共有ストレージ メトリック com.atlassian.confluence:type=metrics, home.shared.write.latency.value
com.atlassian.confluence:type=metrics, home.shared.write.latency.statistics
ローカル ストレージ メトリック com.atlassian.confluence:type=metrics, home.local.write.latency.synthetic.value
com.atlassian.confluence:type=metrics, home.local.write.latency.synthetic.statistics
com.atlassian.confluence:type=metrics, home.local.write.latency.indexwriter.statistics
ユーザー ディレクトリ メトリック com.atlassian.confluence:type=metrics, user.directory.connection.latency.valueuserDirName=<directoryName>
com.atlassian.confluence:type=metrics, user.directory.connection.latency.statisticsuserDirName=<directoryName>
com.atlassian.confluence:type=metrics, user.directory.connection.state.customuserDirName=<directoryName>
Synchrony のメトリック com.atlassian.confluence:type=metrics, synchrony.connection.state.custom
To learn more details about the infrastructure metrics, check the article Interpreting infrastructure metrics for in-product diagnostics .
製品内診断モニタリングを有効にする IPD モニタリングは初期設定で有効になっています。管理する方法は次のとおりです。
Go to Administration menu General Configuration
左側のパネルで [モニタリング ] を選択します。
[製品内診断を有効化
スクリーンショット: 製品内診断が無効になっている JMX モニタリング設定
atlassian-confluence-ipd-monitoring.log への書き込みは log4j を使用して行われます。その設定は log4j.properties で管理します。
#####################################################
# In-product diagnostics monitoring logging
#####################################################
log4j.appender.ipdLogAppender=com.atlassian.confluence.logging.ConfluenceHomeLogAppender
log4j.appender.ipdLogAppender.LogFileName=atlassian-confluence-ipd-monitoring.log
log4j.appender.ipdLogAppender.MaxFileSize=20480KB
log4j.appender.ipdLogAppender.MaxBackupIndex=5
log4j.appender.ipdLogAppender.layout=com.atlassian.logging.log4j.NewLineIndentingFilteringPatternLayout
log4j.appender.ipdLogAppender.layout.ConversionPattern=%d %m%n
log4j.logger.ipd-monitoring = INFO, consolelog
log4j.additivity.ipd-monitoring = false
log4j.logger.ipd-monitoring-data-logger = INFO, ipdLogAppender
log4j.additivity.ipd-monitoring-data-logger = false
ログの内容 初期設定では、各ログ エントリに簡潔データ セットが含まれています。拡張データ セットをログに記録するには、confluence.in.product.diagnostics.extended.logging 機能フラグを有効にします。
拡張データを有効にするには、次の手順に従います。
<CONFLUENCE_URL>/admin/darkfeatures.action に移動します。ここで、<CONFLUENCE_URL> は Confluence インスタンスのベース URL です。
[Enable dark feature (ダーク機能を有効) ] フィールドに confluence.in.product.diagnostics.extended.logging と入力します。
Select Submit . Learn how to manage dark features
拡張データを無効にするには、[サイトのダーク機能 ] セクションで、confluence.in.product.diagnostics.extended.logging を探して [削除 ] を選択します。
次の各表で、簡潔ログ形式と拡張ログ形式の構造をご確認ください。
簡潔データ MBean タイプ
Properties
属性
カウンター
timestamp
ラベル
属性
_count
値
_value
統計
_99thPercentile
_max
_min
_mean
簡潔ログの行形式の例を表示
2023-01-13 11:51:13,106 IPDMONITORING {"timestamp":"1673610673","label":"DB.CONNECTION.POOL.NUMACTIVE.STATISTICS","attributes":{"_max":"2.0","_mean":"1.2436699769063984","_99thPercentile":"2.0","_count":"5","_min":"1.0"}}
拡張データ MBean タイプ
Properties
属性
カウンター
timestamp
ラベル
属性
オブジェクト名
_count
_fifteenMinuteRate
_fiveMinuteRate
_meanRate
_oneMinuteRate
_rateUnit
値
_value
_number
統計
_50thPercentile
_75thPercentile
_95thPercentile
_98thPercentile
_99thPercentile
_999thPercentile
_count
_min
_max
_mean
_stdDev
_durationUnit
_fifteenMinuteRate
_fiveMinuteRate
_meanRate
_oneMinuteRate
_rateUnit
拡張ログの行形式の例を表示
2022-09-06 18:38:48,015 IPDMONITORING {"timestamp":"1662453528","label":
"DB.CONNECTION.LATENCY.STATISTICS","objectName":
"com.atlassian.confluence:category00\u003ddb,category01\u003dconnection,category02\
u003dlatency,name\u003dstatistics,type\u003dmetrics",
"attributes":{"_oneMinuteRate":"0.02012497818617073","_50thPercentile":"0.0",
"_mean":"1.9379304604014412E-25","_max":"1.0","_stdDev":"4.40219315841711E-13",
"_98thPercentile":"0.0","_meanRate":"0.003612560785169162","_rateUnit":
"events/second","_99thPercentile":"0.0","_count":"16","_durationUnit":
"milliseconds","_75thPercentile":"0.0","_fiveMinuteRate":
"0.005912972095043379","_fifteenMinuteRate":"0.0037696657500141968",
"_999thPercentile":"0.0","_95thPercentile":"0.0","_min":"0.0"}}
指標属性の詳細は、次のセクションを展開してご確認ください。
回数の指標属性
属性
定義
_count
現在の時間枠で 指標が出現した回数
_fifteenMinuteRate
直近 15 分間で 指標が出現した回数
_fiveMinuteRate
直近 5 分間で 指標が出現した回数
_meanRate
メーターの作成後にイベントが発生した 平均 レート
_oneMinuteRate
直近 1 分間で指標が出現した回数
_rateUnit
レート に使用される測定単位
値の指標属性
属性
定義
_value
指標の直近の サンプル値
_number
_value 属性 と同じ値が含まれています
統計の指標属性
MBean タイプの統計の指標は、集計値とも呼ばれます。この指標は、一定期間で変更が行われた項目の統計を提供します。たとえば、メール キューで処理された項目や、エラー メール キューに追加された項目などです。
時間枠
特に明記されていない限り、集計値はスライディング時間枠で算出されます。これは、直近の 5 分間を概ねカバーします。
パーセンタイル値は、蓄積サンプリング技法で算出されます。この技法では、データ ストリーム全体を統計的に表す、小さくて管理しやすい値のセットを使用するため、メモリに保存する必要のあるデータの量が軽減します。
リセット
スライディング時間枠の外では、集計値が次のタイミングですべてリセットされます。
その他の Data Center 製品の JMX モニタリングと製品内診断に関する詳細をご確認ください。
次の表に、統計の指標属性の定義を示します。
属性
定義
_50thPercentile
現在の時間枠における、すべての測定値の 50 % を下回る 測定値。 中央 値 とも呼ばれます。
この属性は、中間の測定値を表す手段として、 平均値 の代わりになります。 中央値 は、 平均値
_75thPercentile
現在の時間枠内における、すべての測定値の 75 ％ を 下回る測定値。 第 3 四分位数
_95thPercentile
現在の時間枠内における、 すべての測定値の 95 ％ を下回る測定値
_98thPercentile
現在の時間枠内における、 すべての測定値の 98 ％ を下回る測定値
_99thPercentile
現在の時間枠内における、 すべての測定値の 99 ％ を下回る測定値
_999thPercentile
現在の時間枠内における、 すべての測定値の 999 ％ を下回る測定値
_count
現在の時間枠で 指標が出現した回数
_min
現在の時間枠内における 最小測定値
_max
現在の時間枠内における 最大測定値 。 _max と _min の間の統計的範囲 で値の変動性を測定する尺度
_mean
現在の時間枠における平均値。
この属性は、大きな外れ値の測定値によって歪む可能性があります。このような場合は、 _50thPercentile が中間値としてより適切な指標を提供します。
_stdDev
データのばらつきを示す指標。
標準偏差が低い場合は、値がセットの平均値 に近い傾向があることを示します。一方、標準偏差が高い場合は、値がより広い範囲 に分散していることを示します。
_durationUnit
期間 に使用される測定単位
_fifteenMinuteRate
直近 15 分間で 指標が出現した回数
_fiveMinuteRate
直近 5 分間で 指標が出現した回数
_meanRate
メーターの作成後にイベントが発生した 平均 レート
_oneMinuteRate
直近 1 分間で指標が出現した回数
_rateUnit
レート に使用される測定単位
, then General Configuration > Scheduled jobs