データベース接続のチューニング

Jira  uses a database connection pool, based on Apache Commons DBCP (DataBase Connection Pool), to manage  Jira 's access to its underlying database.

In earlier Jira  versions, the database connection pool was handled purely through the Apache Tomcat application server running Jira . However, from Jira  version 4.4, Jira 's dbconfig.xml file provides a set of database connection pool settings to Tomcat, which in turn are used by Tomcat to manage  Jira 's database connection pool. From JIRA version 5.1, the number database connection pool settings defined in  Jira 's dbconfig.xml file substantially increased.

The information on this page can help you tweak Jira 's database connection pool settings. You can do this by using the Jira configuration tool or by directly editing  Jira 's dbconfig.xml file, as described below.

The Advanced tab of the Jira  Configuration Tool makes it easier to both configure and control Jira 's database connection pool. The Database monitoring page (accessible to Jira  system administrators) provides a visual tool for monitoring Jira 's database connection usage.

このページの内容

接続プールアーキテクチャー

Whenever Jira  needs to access (i.e. read from or write to) its database, a database connection is required.

A database connection is a large and complex object that handles all communication between Jira  and its database. As such, database connections are time consuming to establish and consume a significant amount of memory on both the client (the Jira  application) and database server.

To avoid the impact of creating a new database connection for each database access request made by Jira , a pool of pre-established database connections is maintained. Each new database access request made by Jira  uses a connection from this pool of pre-established connections, as required. Hence:

  1. When Jira  starts up, a minimum number of database connections are established in the pool between Jira  and its database.
  2. When Jira  needs to access its database, Jira :
    1. プールに対してデータベース接続を要求します
    2. そのデータベース接続を使用してデータベースの読み出しまたは書き込みを行います
    3. 処理が終了するとデータベース接続をプールに戻します。

If the frequency of Jira 's database access requests begin to exceed the number of available database connections in the pool, extra connections are automatically created to handle the load.

Conversely, if the frequency of Jira 's database access requests begin to drop below the number of available database connections in the pool, connections can be automatically closed to release resources back to the system.

最近のデータベースは多数の接続を比較的簡単に処理することが可能で、メモリーさえ十分にあれば同時接続可能数は数百にもなります。ただし、クライ アント側では接続は大量のメモリーを消費します。従って、最大接続数をそれよりずっと小さい数に制限して、接続する必要が生じたアプリケーションがほぼ待 つことなく接続を利用できるようにするのが一般的です。

Tuning Jira 's database connections

  1. Shut down your Jira  installation.
  2. 次のいずれかを行います。
    • Use the Jira configuration tool to tune Jira 's database connections.
      1. Start the Jira  configuration tool:
        (info) Please Note: You may need to set the JAVA_HOME environment variable to run the Jira  configuration tool. See Installing Java for details.
      2. Once the Jira  configuration tool is running, click its Advanced tab.
      3. このタブで指定可能なオプションの詳細については、下の 接続プールの設定 を参照してください。これらのオプションの値を指定するには、先に一番左のチェックボックスにチェックを入れる必要があります。
        (info) 上図のオプションのいくつかは、単なるチェックボックスです(たとえば、JIRA 設定ツールの中央付近にあるチェックボックス)。これらのチェックボックスにチェックを入れると、それに関連するオプションの値が「true」に設定されます。逆に、チェックをはずすと、それに関連するオプションの値が「false」に設定されます。
      4. [Save] ボタンをクリックして変更を保存すると、dbconfig.xml ファイルの要素として格納されます。
    • または、Jira ホーム ディレクトリのルートにある dbconfig.xml ファイルを編集します。
      1. Refer to Connection pool settings below for more information about the elements you can add to your dbconfig.xml file to fine tune Jira 's database connection.
      2. 編集済みの dbconfig.xml ファイルを保存します。
  3. Restart your Jira  installation.

接続プールの設定

Jira configuration tool 'Advanced' tab option

 dbconfig.xml の要素
説明
推奨事項/注意事項
デフォルト値*
最大サイズ

pool-max-size

同時にオープン可能なデータベース接続の最大数。

Jira がデータベース コネクション要求を送信したときに待機する必要がないよう、十分に大きい値を設定する必要があります。

このパラメーターの設定方法に関連するヒントは、下の「監視」の項目をご覧ください。

20

最大アイドル状態

pool-max-idle

プール内でアイドル状態のまま保持可能なデータベース接続の最大数。

この値を負に設定すると、プール内でアイドル状態のまま存在可能なデータベース接続の最大数は無制限になります。

下で説明する Minimum Idle/Size の値が上で説明した Maximum Size の値と同一の場合 (デフォルトではこれが成立します) は、この設定は無意味になります。

Maximum Size の値

最小アイドル状態/サイズ

pool-min-size

(min-idle)

同時にオープンしているアイドル状態のデータベース接続の最小数。

この値を上で説明した Maximum Size と同一にすると (デフォルトではこれが成立します)、プールにおける接続数は一定でアイドル接続がクローズされることはありません。

非常に大きな Jira インストールでは、これを Maximum Size よりも小さな値にすることでリソースが節約できる場合があります。

Maximum Size の値

初期サイズ

pool-initial-size

プール内でオープンされるデータベース接続の初期値。

Jira の起動時に多数のデータベース コネクションが迅速に作成されるため、この値は通常は (0 以外に) 設定しません。

0
(dbconfig.xml で指定されていない場合)

最大待機時間

pool-max-wait

プールに空きコネクションがない場合に、データベース コネクションが利用可能となるまでに Jira が待機する最大時間 (単位はミリ秒)。これを過ぎるとエラーが通知されます。

'-1' を指定すると Tomcat の待ち時間は無期限となります。

この値は、競合が発生してもそれに対応できる程度に十分長い時間としなければならないと同時に、無応答やブラウザータイムアウトとなる前にユーザーに対して適切なエラー情報を提供できる程度に短い時間でなければなりません。

30000

高度な設定

通常は以下の設定を変更する必要はありません。必要ならば、Apache DBCP ドキュメントをご覧ください。

プールステートメント

pool-prepared-statements

データベース接続プールにおいてプリペアドステートメントのプーリングを有効にします。

false の既定値を変更しないでください。詳細はJRA-44908 - 課題詳細の取得... ステータス を参照してください。

false
(dbconfig.xml で指定されていない場合)

最大オープンステートメント

max-open-prepared-statements

ステートメントプールから同時に割り当て可能な空きステートメントの最大数。

例外の原因となるため、デフォルト値を修正しないでください

0
(dbconfig.xml で指定されていない場合)

バリデーションクエリ

validation-query

接続プールから取り出された接続の検証を行う SQL クエリです。指定する場合、クエリは少なくとも1つの行を返す SQL SELECT 文でなければなりません。

詳細については、 コネクション切断の問題を乗り越える方法 を参照してください。

select 1
(MySQL の場合)

(または、dbconfig.xml で指定なし)

バリデーションクエリのタイムアウト

validation-query-timeout

検証クエリがデータベース接続の破損を検出するまでのシステム待ち時間 (単位は秒)。

検証クエリは処理量の小さいものを使用するためこの時間は非常に短い時間で構いません。

上で Validation Query を指定した場合は Validation Query Timeout の値も指定しなければなりません。指定しない場合は '-1' が設定され、データベースの破損が起こっていない場合でも、システムは破損を無期限に待ち続けます。

(warning) これは、MySQL でのみ行います。MySQL 以外のデータベースでバリデーション クエリ タイムアウトを使用すると、Jira インスタンスに重大な問題が生じます。

3
(MySQL の場合)

(または、dbconfig.xml で指定なし)

借りるときにテスト

pool-test-on-borrow

Tests if the database connection is valid when it is borrowed from the database connection pool by Jira .

そのデータベース接続が破損している場合はプールから削除されます。

Jira はデータベース処理のたびにコネクションを借りるため、この値は常に "false" にします。

(tick) テータベース接続のクローズがうまくいかないという問題が定常的に発生する場合はこのオプションを 'true' にしてみてください。ただし、この方法は、Time Between Eviction Runs の値を小さくしてもデータベース接続のクローズ時の問題発生を防ぐことも軽減することもできない場合の最終手段とするべきです。

True (dbconfig.xml で指定されていない場合)。ただし、バリデーション クエリが明示的に指定されていない場合、この設定は有効になりませんMySQL は既定のバリデーション クエリを備えているため、この影響を受けます。

返却時にテスト

pool-test-on-return

Tests if the database connection is valid when it is returned to the database connection pool by Jira .

そのデータベース接続が破損している場合はプールから削除されます。

Jira はデータベース処理のたびに借りたコネクションを返却するため、この値は常に "false" とします。

false
(dbconfig.xml で指定されていない場合)

アイドル状態にテスト

pool-test-while-idle

データベース接続がアイドル状態のときに正しく機能しているか否かを定期的にテストします。

そのデータベース接続が破損している場合はプールから削除されます。

MySQL の場合はこれを 'true' にします。

MySQL データベース サーバは既定で、一定の連続時間を過ぎると、使用されていないデータベース コネクションをクローズします。Jira インストールでは My SQL データベースを使用しますが、Jira では長時間 (たとえば一晩) におよぶ非アクティブ状態が発生することがあるため、このことが問題となります。このバラメーターを "true" にすることでこの問題を回避することができます。

なお、Test While Idle の指定が必要となるのは、上で説明した Validation Query を指定したときのみです。

true
(MySQL の場合)

false
(dbconfig.xml で指定されていない場合)

追い出し実行間の時間

time-between-eviction-runs-millis

アイドルオブジェクトのエビクションスレッド実行間隔 (単位はミリ秒)。ゼロまたは負の値を指定するとアイドルオブジェクトのエビクションスレッドは実行されません。

エビクションスレッドは、アイドル状態にあるデータベース接続数が上で説明した Minimum Idle/Size を超えたときにアイドル状態にあるデータベース接続を削除します。

MySQL の場合、接続のエビクションとテストを正常に行うためにはこのパラメーターを大きめの正の値に設定します。一般的に妥当な値は300000 (5 分) です。

(tick) テータベース接続のクローズがうまくいかないという問題が定常的に発生する場合はこのオプション値を小さめにしてみてください。

300000
(MySQL の場合)

5000
(HSQLDB の場合)

(または、dbconfig.xml で指定なし)

追い出し可能な最小限のアイドル時間

min-evictable-idle-time-millis

アイドルオブジェクトのエビクションを実行する場合に、データベース接続プール内のオブジェクトがアイドルオブジェクトエビクションの対象となるまでのアイドル状態最小時間。


60000
(MySQL の場合)

4000
(HSQLDB の場合)

(または、dbconfig.xml で指定なし)

クローズ漏れの削除

pool-remove-abandoned

データベース接続のクローズ漏れ状態が次の Removed Abandoned Timeout で指定した時間を超えたときにそれを削除するか否かのフラグ。

If an internal failure occurs, it is possible that Jira may borrow a connection and never return it. If this happens too often, then the pool may run short of database connections, causing Jira 's performance to degrade or Jira to fail altogether.

この値は 'true' にします。

これによってクローズ漏れ状態の接続を整理してプール内の接続数を回復し、システムパフォーマンスの低下を防止します。

true

クローズ漏れの削除のタイムアウト

pool-remove-abandoned-timeout

データベース接続がクローズ漏れと判定されるまでのアイドル状態継続時間 (単位は秒)。


300

* (info) 注意:

  • Jira  writes elements with their default values (in the right-hand column of the table above) to the dbconfig.xml file after:
    • Jira セットアップ ウィザード を最後まで実行したとき。
    • You use the Advanced tab of the Jira  configuration tool to configure/tune your database connection — even when the leftmost checkboxes of options associated with these elements have not been selected.
  • ただし、値の下に '(dbconfig.xml で指定されていない場合)' と表示されている要素は例外です。これらの要素は次のようになります。
    • Jira セットアップ ウィザードを最後まで実行したあとは、dbconfig.xml には書き込まれません。
    • 次の場合にのみ dbconfig.xml ファイルへの書き込みが行われます:
      • このファイルを手作業で書き換えたとき
      • Using the Advanced tab of the Jira  configuration tool, selecting the leftmost checkboxes of the options associated with these elements and specifying values for these options.
  • 上述の表の一番右の列で、既定値の下に "(dbconfig.xml で指定されていない場合)" と表示されている要素では、dbconfig.xml ファイルに要素が存在しない場合でも既定値が適用されます。

接続プールの監視

Jira  provides a view of its database connection usage via the 'Database Monitoring' page. See Monitoring database connection usage for more information.

最終更新日 2018 年 5 月 11 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.