システムインフィニティ武石

はじめに

コネクションプールを使用した環境において実際に発生した落とし穴です。

環境

ＡＰサーバ：Resin 2.1.14

ＪＡＶＡ：J2SDK 1.4.2_07

ＤＢサーバ(Microsoft SQL Server 2000 SP3)は別マシン環境にありＡＰサーバ(Resin)のコネクションプールを利用してアプリケーションからJDBCで接続している。

問題点の解説

コネクションプールが一杯になりデータベース接続が遅延・滞留してしまう原因の１つとして以下のコネクションの存在が判明。

コネクション

import com.caucho.sql.DBPool;

import java.sql.Connection;

import java.sql.SQLException;

・・・・・

Connection conn = null;

try {

conn = DBPool.getPool([データソース名]).getConnection();

・・・・・

conn = DBPool.getPool([データソース名]).getConnection();

角丸四角形吹き出し: ②データベース接続を開放(クローズ)せずに再びコネクションプールを利用してデータベース接続を行う。・・・・・

} catch (SQLException e) {

・・・・・

} finally {

if (conn != null) {

角丸四角形吹き出し: ③データベース接続を開放(クローズ)してコネクションプールへリソースを返却するが、余計に取得(最初に取得した)データベース接続は開放されずコネクションプールが１つ消費されたままになる。 try {

conn.close();

} catch (SQLException e) {

// 例外は無視する

}

conn = null;

}

・・・・・

コネクションの問題点

今回コネクションの障害は同一のオブジェクト(Connection)に対して２回データベース接続を行ったことが原因であるが、このパターンの問題は通常あまり見られずまた見落としがちである。

データベース接続に対する開放(close)は多少の経験があれば必ず行う必要のある処理であることは理解できまた正しく確実に開放(close)されているか確認することであろう。

しかしながら今回の問題はデータベース接続を開放(close)する通常フォーカスしているのとはまったく違う意味で実装(不具合の実装)が可能でなおかつ見つけにくい問題であったが、ソース解析によってこの問題点にフォーカスできさらにこの問題を障害として再現可能であったため取り除くことが可能であった。

大げさだと思われるかもしれないがプログラマーのスキル(知識や経験)、そしてちょっとした処理フローの見落としで難なく発生することが可能になる。

また特定が難しい場合も多くある。特にオブジェクト(Connection)を広範囲のスコープで利用可能にしている場合は注意が必要であるしこういったオブジェクトは限られたスコープで用いるべきであろう。

発生するのは当たり前だと思っている貴方も今までのプログラムを注意深く観察してみては如何であろう。

先ほど「問題の障害を再現可能であったため」と言ったがコネクションプールを利用していたのが障害発生の諸原因であり逆にコネクションプールを利用することで障害の確認が容易に可能であった。

もしコネクションプールを使用していなかったら障害が発生していなかったかもしれない、あるいは違った形の障害となっていた可能性もある。しかしその場合その障害を確認するのは困難を極めたであろう。

※ コネクションプールを利用すべきであると説いているわけではないので誤解しないように。

問題点の確認

もしこの問題を実際に試してみたければ以下の内容を参考にＡＰサーバでご確認いただきたい。

なおＡＰサーバには Resin のバージョン 2 を想定しているのでご了承願いたい。

また Resin のバージョン 3 でも確認は出来ると思うので試してみても良いでしょう。

但しこの動作確認における責任は各自で負う事。

１．Resinのコンフィグレーションファイル

resin.conf(%RESIN_HOME%/conf/resin.conf)をテキストエディターで開くと40行目あたりに以下の記述が見つかる。

<resin.conf>

・・・・・

<resource-ref>

<res-ref-name>jdbc/test</res-ref-name>

<res-type>javax.sql.DataSource</res-type>

<init-param driver-name="com.caucho.jdbc.mysql.Driver"/>

<init-param url="jdbc:mysql_caucho://localhost:3306/test"/>

<init-param user=""/>

<init-param password=""/>

<init-param max-connections="20"/>

<init-param max-idle-time="30"/>

</resource-ref>

・・・・・

参考に以下の様にリソース定義を追加する。

なお追加する内容は動作可能な環境に合わせて記述願う。

<resource-ref>

<res-ref-name>jdbc/pool-test</res-ref-name> ①

<res-type>javax.sql.DataSource</res-type> ②

<init-param driver-name="com.microsoft.jdbc.sqlserver.SQLServerDriver"/> ③

<init-param url="jdbc:microsoft:sqlserver://④:⑤;databasename=⑥"/> ④～⑥

<init-param user="⑦"/> ⑦

<init-param password="⑧"/> ⑧

<init-param max-connections="20"/> ⑨

<init-param max-idle-time="30"/> ⑩

</resource-ref>

① リソース名(プーリングのデータソース名)を定義する。

② リソース(データソース)のタイプを設定。

③ Microsoft SQL Server のJDBCドライバを使用する場合。
他のデータベース及びJDBCドライバを使用する場合は合わせてください。

④ 接続先のデータベースサーバ名またはＩＰアドレスを指定。

⑤ 接続先のデータベースサーバのポート番号を定義
Microsoft SQL Server の場合通常は 1433 になる。

⑥ データベースアカウントの既定のデータベース以外に接続する場合や明示的に指定する場合、データベース名を指定。
データベースアカウントの既定のデータベースを使用する場合や明示的に指定をしない場合 'databasename=～' 部分は省略可能である。

⑦ データベースアカウントのユーザー

⑧ データベースアカウントのパスワード

⑨ コネクションプールの最大プール数を指定。
確認テストであれば多くは要らない。

⑩ コネクションプールからプールを取得する最大待ち時間と思われる(単位は分)
しかし１分に設定しても１分で帰ってこないので違うかも知れない。
知っている人は情報ください。

※ データベースに接続した後、テーブルなどのオブジェクトに対して操作はしないのでバックアップなどは不要である。

※ 次ページから確認用プログラム(JSP)が３本出てくるが、その３本のプログラムの配置場所はサーブレットコンテナ上で実行するのに有効な場所であればどこに配置しても問題は無い。ぜひ試していただきたい。

２．コネクションのプログラムで確認

コネクションプールを消費させるコネクションのサンプルソースを以下に載せる。

resin.confのリソース(データソース)定義に合わせればこのまま動くはずである。

<trouble_dbpool_resin.jsp>

<%@ page contentType="text/html;charset=MS932" pageEncoding="MS932" %>

<%@ page import="com.caucho.sql.DBPool" %>

<%@ page import="java.sql.Connection" %>

<%@ page import="java.sql.SQLException" %>

<%!

private static final String DATA_SOURCE_NAME = "jdbc/pool-test";

DBPool dbpool = DBPool.getPool(DATA_SOURCE_NAME);

String resule = "";

if (request.getParameter("connect") != null) {

Connection conn = null;

try {

// １回目のデータベース接続

conn = dbpool.getConnection();

// ２回目のデータベース接続

conn = dbpool.getConnection();

resule = "２回接続しました";

} catch (SQLException e) {

throw e;

} finally {

if (conn != null) {

try {

conn.close();

} catch (SQLException e) {

// 例外は無視する

}

conn = null;

}

resule += "<br>１回開放しました";

}

resule += "<br>現在のアクティブなコネクションプール数は";

resule += dbpool.getActiveConnections();

resule += "です";

<html>

<head>

<title>ＷＥＢアプリケーションにおけるデータベースプール使用時の障害事例</title>

</head>

<form action="<%= request.getRequestURI() %>" method="post" target="_top">

<hr>

接続ボタンを押してください。<br>

押す度にコネクションが１つずつ消費されていきます。

</font>

<hr>

<hr>

<%= resule %>

<hr>

</center>

</form>

</body>

</html>

３．コネクション未開放のプログラムで確認

コネクションを１回だけ行い開放(クローズ)しない場合でも確認してしてはどうなるであろう。聞くまでも無いだろう。

<noclose_dbpool_resin.jsp>

<%@ page contentType="text/html;charset=MS932" pageEncoding="MS932" %>

<%@ page import="com.caucho.sql.DBPool" %>

<%@ page import="java.sql.Connection" %>

<%@ page import="java.sql.SQLException" %>

<%!

private static final String DATA_SOURCE_NAME = "jdbc/pool-test";

DBPool dbpool = DBPool.getPool(DATA_SOURCE_NAME);

String resule = "";

if (request.getParameter("connect") != null) {

Connection conn = null;

try {

// １回目のデータベース接続

conn = dbpool.getConnection();

resule = "１回接続しました";

} catch (SQLException e) {

throw e;

}

resule += "<br>現在のアクティブなコネクションプール数は";

resule += dbpool.getActiveConnections();

resule += "です";

<html>

<head>

<title>ＷＥＢアプリケーションにおけるデータベースプール使用時の障害事例</title>

</head>

<form action="<%= request.getRequestURI() %>" method="post" target="_top">

<hr>

接続ボタンを押してください。<br>

押す度にコネクションが１つずつ消費されていきます。

</font>

<hr>

<hr>

<%= resule %>

<hr>

</center>

</form>

</body>

</html>

４．コネクションプールのリソース確認プログラム

コネクションプールの各情報とresinが使用するJVMヒープメモリなど情報を表示するツールを以下に載せる。

Resinにはコネクションプールを利用するためのライブラリ(com.caucho.sql.DBPool)が標準で付いているためコネクションプールを利用するのがとても楽である。

環境に合わせて本ソースを修正する場合は５行目～１６行目のみの修正でよいはずである。

<admin_dbpool_resin.jsp>

<%@ page contentType="text/html;charset=MS932" pageEncoding="MS932" %>

<%@ page import="java.text.DecimalFormat" %>

<%@ page import="com.caucho.sql.DBPool" %>

<%!

// ------------------------------------------------------------

// resin.conf の設定に併せて以下を変更してください。

// sDB_POOL_MANES : ＤＢプール名

// ------------------------------------------------------------

static final String[] sDB_POOL_MANES = { "jdbc/ pool-test"

};

// ------------------------------------------------------------

// 横に表示するＤＰプールの情報数(既定値は１列)

// iDISP_COLS : ＤＢプール表示数(横)

// ------------------------------------------------------------

static final int iDISP_COLS = 1;

// ------------------------------------------------------------

// ここから下のソースは変更しないでください！！

// ------------------------------------------------------------

int iDB_PoolCnt = sDB_POOL_MANES.length;

int[] iDB_Pool_Max = new int[iDB_PoolCnt];

int[] iDB_Pool_Used = new int[iDB_PoolCnt];

int[] iDB_Pool_Total = new int[iDB_PoolCnt];

DBPool[] dbpool = new DBPool[iDB_PoolCnt];

// リロード時間の初期値(3000ミリ秒)

int re = 3000;

if (request.getParameter("re") != null) {

re = Integer.parseInt(request.getParameter("re"));

}

// ＪＶＭの総ヒープメモリ取得、空きメモリ取得

DecimalFormat df = new DecimalFormat("###,###,###,###,###");

String freeMemory = df.format(Runtime.getRuntime().freeMemory());

String totalMemory = df.format(Runtime.getRuntime().totalMemory());

// 初期化

for (int i = 0; i < iDB_PoolCnt; i++) {

// ＤＢプールのＭＡＸ数

iDB_Pool_Max[i] = -1;

// ＤＢプールの使用数

iDB_Pool_Used[i] = -1;

// ＤＢプールの合計数

iDB_Pool_Total[i] = -1;

// ＤＢプール

dbpool[i] = null;

}

// ＪＤＢＣドライババージョン・初期化

String strVersion = "--";

// ＪＳＰバージョン・初期化

JspFactory jsFact = null;

JspEngineInfo jsEinf = null;

String strJspVersion = "--";

// サーブレットＡＰＩバージョン・初期化

String strServletApiVersion = "--";

// 例外時のエラー文字列・初期化

String errorStr = "";

try {

// ＤＢプール情報取得

for (int i = 0; i < iDB_PoolCnt; i++) {

dbpool[i] = DBPool.getPool(sDB_POOL_MANES[i]);

iDB_Pool_Max[i] = dbpool[i].getMaxConnections();

iDB_Pool_Used[i] = dbpool[i].getActiveConnections();

iDB_Pool_Total[i] = dbpool[i].getTotalConnections();

}

// ＪＤＢＣドライババージョン情報取得

strVersion = dbpool[0].getMajorVersion() + "." + dbpool[0].getMinorVersion();

// ＪＳＰバージョン取得

jsFact = JspFactory.getDefaultFactory();

jsEinf = jsFact.getEngineInfo();

strJspVersion = jsEinf.getSpecificationVersion();

// サーブレットＡＰＩバージョン取得

strServletApiVersion = getServletContext().getMajorVersion() + "." + getServletContext().getMinorVersion();

} catch (Exception e) {

errorStr = e.toString();

e.printStackTrace();

} finally {

jsFact = null;

jsEinf = null;

}

<html>

<head>

<title>Audit</title>

<!--

setTimeout("re()", <%= re %>);

function re() {

location.reload();

}

//-->

</SCRIPT>

</head>

<tr>

<b>ＤＢプールおよび、サーブレットコンテナ(Tomcat/Resin)監視画面<br></b>

<font color="gray"><%= (re / 1000) %>秒おきにリロードします。</font>

</td>

</tr>

<tr>

<td>

int iDispCols = iDISP_COLS;

if (iDispCols < 1) {

iDispCols = 1;

}

for (int cnt = 0; cnt < iDB_PoolCnt;) {

<tr>

for ( int cols = 0; cols < iDispCols && cnt < iDB_PoolCnt; cols++, cnt++) {

<td>

<tr>

</tr>

<tr>

<td align="left" width="200"> ＤＢプールのＭＡＸ数</td>

</tr>

<tr>

<td align="left"> コネクションの合計数</td>

</tr>

<tr>

<td align="left"> 現在、使用中のプール数</td>

if (((iDB_Pool_Used[cnt] * 10) / iDB_Pool_Max[cnt]) >= 4 &&

((iDB_Pool_Used[cnt] * 10) / iDB_Pool_Max[cnt]) <= 7) {

} else if ((( iDB_Pool_Used[cnt] * 10) / iDB_Pool_Max[cnt] ) > 7) {

} else {

}

</tr>

</table>

</td>

}

</tr>

<tr>

</tr>

}

</table>

</td>

</tr>

<tr>

<td>・pool数の背景が黄色、または赤色になりましたらシステム管理者に連絡して下さい。</td>

</tr>

<tr>

</tr>

<tr>

<td>・情報取得に失敗した場合は、-1が表示されます。</td>

</tr>

<tr>

<td>

</td>

</tr>

<tr>

<td>

<tr>

<td align="center" colspan="2" bgcolor="#FFCCCC">その他、ＪＡＶＡ環境の情報</td>

</tr>

<tr>

<td align="left" width="200"> ＪＤＢＣドライババージョン</td>

</tr>

<tr>

<td align="left"> ＪＳＰバージョン</td>

</tr>

<tr>

<td align="left"> サーブレットＡＰＩバージョン</td>

</tr>

<tr>

<td align="left"> ＪＶＭ総ヒープメモリ(バイト)</td>

</tr>

<tr>

<td align="left"> ＪＶＭ空きメモリ(バイト)</td>

</tr>

</table>

</td>

</tr>

</table>

<%= errorStr %>

</center>

</body>

</html>