この記事は、JMX クライアントでの監視用に Jira 内で JMX MBeans を表示する方法、および製品内診断用に JMX MBeans を使用する方法について説明します。

JMX とは何か

JMX (Java Management Extensions) は、Java アプリケーションを監視及び管理するための技術です。JMX は、MBeans (Managed Beans) と呼ばれるオブジェクトを使用して、アプリケーションからデータやリソースを表示します。Jira Server または Jira Data Center の大規模なインスタンスでは、JMX を有効化することで、アプリケーション リソースの消費量をより簡単に監視したり、インデックス関連のパフォーマンスの問題をより簡単に診断したりできるようになります。これにより、マシン リソースの保持 / 最適化方法について、より優れた判断を行えます。

Jira によって収集されるメトリック

次のテーブルは、Jira が収集するメトリック (MBeans) を示します。これらはすべて、com.atlassian.jira プロパティにグループ化されます。

次のメトリックは 8.1 以降の Jira に追加されており、com.atlassian.jira/metrics で公開されています。次のメトリックは、Jira を再起動するとすべてリセットされます。 

Jira Service Management でアセットによって収集されるメトリック

次の表は、Jira Service Management でアセットによって収集されるメトリック (MBean) のリストです。 

Jira の監視

Jira を監視する前に、JMX の監視を有効にしてから、JMX クライアントを使用してメトリックを表示する必要があります。

Jira で JMX 監視を有効化する

既定ではすべてのメトリックが収集されますが、それらを公開するには JMX 監視を有効にする必要があります。これは Jira で実行できますが、Jira 管理者である必要があります。

1. 上部のナビゲーション バーから [管理者 ] > [システム] を選択します。 
2. JMX モニタリングに移動します。
3. JMX 監視の有効化を切り替えます。

JConsole を使って監視する

JMX 監視を有効にした後、任意の JMX クライアントを使用してメトリックを表示できます。これをすばやく簡単に行うために、ここでは、JConsole を使用して表示する方法について説明しています。Jira インスタンスはローカルでもリモートでも監視できます。

• 特定の課題のトラブルシューティングを行う場合、または Jira を短期間のみ監視する必要がある場合は、Jira のローカル監視が便利です。ローカル監視はサーバーのパフォーマンスに影響を与える可能性があるため、本番システムの長期的な監視にはお勧めしません。

  手順について

   ローカルに監視するには:

  1. JConsole を起動します。これは、JDK インストール ディレクトリの bin ディレクトリにあります。(JConsole は JDK の一部としてのみ利用可能です。)
  2. ローカル プロセス を選択します。
  3. Jira プロセスを選択します。org.apache.catalina.startup.Bootstrap start などが該当します。
  4. 接続後、すべてのメトリックをグループ化する com.atlassian.jira プロパティを展開します。

  ローカル監視の詳細については、JConsole の使用を参照してください。

• Jira のリモート監視は、Jira Server のリソースを消費しないため、本番環境システムにお勧めです。

  手順について

   リモートで監視するには:

  1. 次のプロパティを setenv.sh / setenv.bat ファイルに追加します。ポートは未使用の任意のポートに設定できます。
     
     CATALINA_OPTS

     Windows

     SET CATALINA_OPTS="-Dcom.sun.management.jmxremote.authenticate=true ${CATALINA_OPTS}"
     SET CATALINA_OPTS="-Dcom.sun.management.jmxremote.password.file=/atlassian-jira-software-x.y.z-standalone/jmxremote.password ${CATALINA_OPTS}"
     SET CATALINA_OPTS="-Dcom.sun.management.jmxremote.access.file=/atlassian-jira-software-x.y.z-standalone/jmxremote.access ${CATALINA_OPTS}"

     x.y.z は、使用している Jira バージョンを表します。

     Linux

     CATALINA_OPTS="-Dcom.sun.management.jmxremote.authenticate=true ${CATALINA_OPTS}"
     CATALINA_OPTS="-Dcom.sun.management.jmxremote.password.file=/atlassian-jira-software-x.y.z-standalone/jmxremote.password ${CATALINA_OPTS}"
     CATALINA_OPTS="-Dcom.sun.management.jmxremote.access.file=/atlassian-jira-software-x.y.z-standalone/jmxremote.access ${CATALINA_OPTS}"

     x.y.z は、使用している Jira バージョンを表します。
     
     詳細については、「JMX テクノロジーを使用した監視と管理」の「パスワード認証の使用」セクションを参照してください。
     
     また、JMX プロパティにアクセスするには、SSL の設定が必要になる場合があります。詳細については、「JMX テクノロジーを使用した監視と管理」の SSL に関するセクションを参照してください。
     
     JAVA_OPTS

     JAVA_OPTS を使用すると、JMX MBeans をリモート アクセス用に公開できますが、Jira のシャットダウン中にエラーが発生します。

     Windows

     JAVA_OPTS=-Dcom.sun.management.jmxremote %JAVA_OPTS%
     JAVA_OPTS=-Dcom.sun.management.jmxremote.port=8099 %JAVA_OPTS%
     JAVA_OPTS=-Dcom.sun.management.jmxremote.authenticate=false %JAVA_OPTS%

     Linux

     JAVA_OPTS="-Dcom.sun.management.jmxremote ${JAVA_OPTS}"
     JAVA_OPTS="-Dcom.sun.management.jmxremote.port=8099 ${JAVA_OPTS}"
     JAVA_OPTS="-Dcom.sun.management.jmxremote.authenticate=false ${JAVA_OPTS}"
     export JAVA_OPTS

  2. リモート接続の保護方法を決定します。詳細については、リモート監視と管理を参照してください。
     認証を無効にすることは可能ですが、本番環境システムではお勧めしません。
  3. JConsole を起動します。これは、JDK インストール ディレクトリの bin ディレクトリにあります。
  4. リモート プロセス を選択します。
  5. ホスト名とポートを入力します。これは、Jira ポートではなく、前に指定したポートです。
  6. [Connect] を選択します。
  7. 接続後、すべてのメトリックをグループ化する com.atlassian.jira プロパティを展開します。

  リモート監視の詳細については、JConsole の使用を参照してください。

既知のセキュリティ問題

RCE (リモート コード実行) JMX 攻撃によって引き起こされる可能性のある潜在的なセキュリティの脆弱性に対する堅牢な修正を提供しています。この攻撃の最中でも、JMX モニタリング用の有効な認証情報を持つリモート ユーザーは、たとえそのユーザーのアカウントが readOnly (montiorRole) であっても、Java 逆シリアル化によって Jira Data Center で任意のコードを実行できます。

捏造されたデータがリクエストによってシステムに侵入するのを防ぐために、 JVM の ObjectInputFilter に基づくブロックリスト逆シリアル化フィルターを使用しています。

カスタム JDK を使用していて、Java バージョンに基づくクラスパスに適切なクラスがない場合、Jira ノードは起動しません。

atlassian.jira.log には、「BlocklistDeserializationFilter has not been set up」というエラーが記録されます。これは、使用している Java 環境にセキュリティ上の問題があることを意味します。

JMX から利用できる製品内診断

Jira 9.3 以降では、製品内診断用の一連のデータベース接続メトリックを JMX から利用できるようになりました。

製品内診断 (IPD) では、実行中のインスタンスの動作についてより深いインサイトが得られます。

IPD には、Jira とそのデータベースの間の相互作用を対象とした追加のメトリックが用意されています。データベース接続メトリックを使用すると、環境やインフラストラクチャでパフォーマンスの問題を発生させる可能性のある要素を効率的に特定できます。 

Jira 9.5 では、製品内診断に HTTP 接続メトリックとメール キュー メトリックという新しいメトリックが追加されました。Jira 9.8 では、メール キューのコンテンツをより詳細に把握したり、より多くのデータを収集してパフォーマンスを監視しやすくしたりできるように、いくつかの新しいメール キュー メトリックが追加されました。

既定では、この機能は無効になっています。実際のメトリックは次の形式で利用できます。

• 新しい JMX MBeans として
• 新しい IPD ログ ファイル (atlassian-jira-ipd-monitoring.log) 内の JMX 値のスナップショットの履歴として

このログ ファイルは、すべての既存のログ ファイルが格納されている {jira_home}\log フォルダにあります。このログ ファイルは、ATST プラグインで作成されるサポート ZIP ファイルにも含まれています。必要に応じて、Atlassian troubleshooting & support tools プラグインでサポート ZIP ファイルを生成し、ファイルをアトラシアン サポートに送信できます (アトラシアン社内にはファイル解釈用のツールがあります)。プラグインの詳細をご確認ください。

コミュニケーション

この機能では通信に次の方法が使用されます。

• JMX: JMX MBean は内部スケジュールに基づいて定期的に更新されます。
• ログ ファイル atlassian-jira-ipd-monitoring.log: JMX 値は、設定可能なスケジュールでスナップショットが作成され、ログ ファイルに記録されます。既定では、60 秒ごとに JMX 値がポーリングされ、ログ ファイルに書き込まれます (このパラメータは Jira 9.3 EAP 02 以降に更新されています)。

製品内診断メトリック

次のセクションを展開して、製品内診断で利用できるメトリックの詳細を学習してください。

製品内診断モニタリングを有効にする

IPD モニタリングは初期設定で有効になっています。管理する方法は次のとおりです。

1. 上部のナビゲーション バーから [管理者 ] > [システム] を選択します。 

2. 左側のパネルで、[システム サポート] に移動し、[モニタリング] を選択します。

3. [製品内診断モニタリング] トグルを使用して、IPD モニタリングを有効または無効にします。
   このトグルはバージョン 9.4.3 でも利用できます。アップデートについては、Jira Software のリリース ノートを参照してください。

REST API

Jira 9.5 では、IPD モニタリングを管理するための新しい REST API エンドポイント、具体的にはユーザー インターフェイスの製品内診断モニタリング トグル (/rest/api/2/monitoring/ipd) が導入されています。

{
  "enabled": true
}

{
  "enabled": false
}

ログ形式

atlassian-jira-ipd-monitoring.log への書き込みは log4j を使用して行われます。その設定は log4j.properties で管理します。

#####################################################
# In-product diagnostics monitoring logging
#####################################################

log4j.appender.ipd=com.atlassian.jira.logging.JiraHomeAppender
log4j.appender.ipd.File=atlassian-jira-ipd-monitoring.log
log4j.appender.ipd.MaxFileSize=20480KB
log4j.appender.ipd.MaxBackupIndex=5
log4j.appender.ipd.layout=com.atlassian.logging.log4j.NewLineIndentingFilteringPatternLayout
log4j.appender.ipd.layout.ConversionPattern=%d %m%n

log4j.logger.ipd-monitoring = INFO, filelog
log4j.additivity.ipd-monitoring = false
log4j.logger.ipd-monitoring-data-logger = INFO, ipd
log4j.additivity.ipd-monitoring-data-logger = false

ログの内容

既定では、各ログ エントリには簡潔データ セットが含まれています。拡張データ セットをログに記録するには、com.atlassian.jira.in.product.diagnostics.extended.logging 機能フラグを有効にします。

拡張データを有効にするには、次の手順に従います。

1. <JIRA_URL>/secure/admin/SiteDarkFeatures!default.jspa に移動します。ここで、<JIRA_URL> は Jira インスタンスのベース URL です。
2. [有効にする開発中機能] テキスト領域で com.atlassian.jira.in.product.diagnostics.extended.logging.enabled と入力します。[追加] を選択します。ダーク機能を管理する方法をご確認ください。
   1. 拡張データを無効にするには、[開発中機能 (サイト経由)] パネルで com.atlassian.jira.in.product.diagnostics.extended.logging.enabled を探して [無効化] を選択します。

次の各表で、簡潔ログ形式と拡張ログ形式の構造の違いを参照してください。

簡潔データ

2022-09-06 18:37:48,011 IPDMONITORING {"timestamp":"1662453468","label":"DB.CONNECTION.LATENCY.STATISTICS","attributes":{"_mean":"6.704470250010645E-25","_max":"1.0","_99thPercentile":"0.0","_min":"0.0"}}

拡張データ

2022-09-06 18:38:48,015 IPDMONITORING {"timestamp":"1662453528","label":
"DB.CONNECTION.LATENCY.STATISTICS","objectName":
"com.atlassian.jira: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"}}

指標属性の定義

指標属性の詳細は、次のセクションを展開してご確認ください。

プロパティを処理する

• JMX ログ記録のポーリング間隔は 60 秒に設定されており、変更できません。

• ログ ファイルのポーリング間隔は 60 秒に設定されており、システム プロパティ jira.diagnostics.ipdlog.poll.seconds を使用して変更できます。

• 既定では、JMX 値はポーリングされて atlassian-jira-ipd-monitoring.log に書き込まれます。