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

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. Jira の起動時にはプール内で Jira とそのデータベース間の最小限のデータベース コネクションが確立されます。
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.

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

Jira のデータベース コネクションの調整

1. Jira のインストール環境をシャットダウンします。
2. 次のいずれかを行います。
   
   • Use the Jira configuration tool to tune Jira's database connections.
     
     1. Start the Jira configuration tool:
        
        • Windows: コマンド プロンプトを開いて、Jira インストール ディレクトリの bin サブディレクトリにある config.bat を実行します。
        • Linux/Unix: Open a console and execute config.sh in the bin sub-directory of the Jira installation directory.
           This may fail with the error as described in our Unable to Start Jira applications Config Tool due to No X11 DISPLAY variable was set error KB article. Please refer to it for the workaround.
        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. Refer to Connection pool settings below for more information about the options on this tab. To specify a value for one of these options, ensure its leftmost checkbox has been selected first.
        Some options above are simple checkboxes (i.e. in the centre of the JIRA configuration tool). Selecting these checkboxes sets the values of their associated options to 'true'. Conversely, clearing these checkboxes sets the values of their associated options to '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. Jira のインストール環境を再起動します。

接続プールの設定

* Please note:

• 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.