コネクション切断の問題を乗り越える方法

When a database server reboots or a network failure has occurred, all connections in the database connection pool are broken. To overcome this issue, Jira would normally need restarting.

しかし、単純な SQL クエリの実行によって、データベースのコネクションプール内のコネクションを有効にすることができます。プール内で切断されたデータベースコネクションが検出されると、新しいものが作成されてこれに置き替えられます。

これを行うには、Jira ホーム ディレクトリの dbconfig.xml ファイルで、オプションの <validation-query/> 要素を指定する必要があります。これは、データベース コネクション プール内のコネクションのバリデーション クエリです。詳しくは、以下の手順を参照してください。

Ensuring Jira validates connections to its database

1. Shut down Jira (or the Tomcat installation running Jira).
2. Jira ホームディレクトリで dbconfig.xml ファイルを編集するか、 Jira 設定ツール の [詳細] タブを使用して、関連する設定を行います。
3. お使いのデータベース向けのバリデーションクエリを設定します:
   

   • dbconfig.xml ファイルを編集する際は、以下の MySQL 用の例にあるように、使用するタイプのデータベースに適したバリデーション クエリを持つ <validation-query/> 要素を追加します (詳細については、以下の バリデーション クエリの決定 を参照してください)。

     <?xml version="1.0" encoding="UTF-8"?>
      
     <jira-database-config>
       <name>defaultDS</name>
       <delegator-name>default</delegator-name>
       <database-type>mysql</database-type>
       <jdbc-datasource>
         <url>jdbc:mysql://dbserver:3306/jiradb?useUnicode=true&amp;characterEncoding=UTF8&amp;sessionVariables=storage_engine=InnoDB</url>
         <driver-class>com.mysql.jdbc.Driver</driver-class>
         <username>jiradbuser</username>
         <password>password</password>
         <pool-min-size>20</pool-min-size>
         <pool-max-size>20</pool-max-size>
         <pool-max-wait>30000</pool-max-wait>
      
         <validation-query>select 1</validation-query>
         <min-evictable-idle-time-millis>60000</min-evictable-idle-time-millis>
         <time-between-eviction-runs-millis>300000</time-between-eviction-runs-millis>
      
         <pool-max-idle>20</pool-max-idle>
         <pool-remove-abandoned>true</pool-remove-abandoned>
         <pool-remove-abandoned-timeout>300</pool-remove-abandoned-timeout>
      
         <pool-test-while-idle>true</pool-test-while-idle>
         <pool-test-on-borrow>false</pool-test-on-borrow>
         <validation-query-timeout>3</validation-query-timeout>
      
       </jdbc-datasource>
     </jira-database-config>
     

   • Jira 設定ツールを利用する場合、[詳細] タブから [バリデーション クエリ] チェックボックスを選択して、使用するデータベースのタイプに適したバリデーション クエリを入力します (詳細については、以降の「バリデーション クエリの決定」を参照してください)。
4. バリデーションクエリのタイムアウトを指定します。この値は、データベースコネクションが切断されたものとシステムが判断するまで、システムが待機しなくてはならない適当な時間 (秒単位) となります:
   
   • If editing the dbconfig.xml file, add the <validation-query-timeout/> element with the appropriate length of time (in seconds).  This should only be done for MySQL.
   • Jira 設定ツールを利用する場合、[詳細] タブから [バリデーション クエリ タイムアウト] チェックボックスを選択し、適切な時間の長さ (秒単位) を入力します。

5. 上記のバリデーション クエリのオプションに関連する、以下のオプションを指定することもできます（詳細については、 データベース接続のチューニング － コネクション プールの設定  を参照して下さい）。

   Jira configuration tool 'Advanced' tab option	dbconfig.xml の要素
   アイドル状態にテスト	pool-test-while-idle
   追い出し実行間の時間	time-between-eviction-runs-millis
   追い出し可能な最小限のアイドル時間	min-evictable-idle-time-millis

6. 編集した dbconfig.xml ファイルを保存します (Jira 設定ツールを使用している場合は [保存] ボタンをクリックします)。

7. Restart Jira (or the Tomcat installation running Jira).

Please Note: If you continue to have problems with connections closing, you may need to set the time-between-eviction-runs-millis parameter to a lower value or as a last resort, set test-on-borrow to true. For more information about test-on-borrow, see Tuning database connections - connection pool settings section.

バリデーション クエリおよびタイムアウトの決定

各データベースの種類におけるバリデーションクエリは、それぞれ若干異なる SQL 構文の条件を有しています。バリデーションクエリは、プールからコネクションが回収される度に実行されるため、可能な限りシンプルなものが臨まれます。バ リデーションクエリのタイムアウトは、MySQL 向けにおいてのみ設定します。

各バリデーションクエリに推奨されるバリデーションクエリを以下に紹介します。:

 If the Validation query timeout is used on any database other than MySQL it will cause significant problems with the Jira instance.

結果

You should now be able to recover from a complete loss of all connections in the database connection pool without the need to restart Jira or the application server running Jira.

パフォーマンス上の留意点

• このオプションを設定すると、パフォーマンスに影響が及びますが、クエリそのものは素早く実行されるため、パフォーマンス上の全体的な影響は最低 限に保たれます。更に、このクエリが実行されるのは、コネクションが成立した場合においてのみとなります。よって、リクエストの間ずっとコネクションが保 たれると、クエリは一回のリクエストに対して一度のみしか発生しません。
• If you are running a large Jira installation, you may wish to assess the performance impact of this change before implementing it.