本項は、パフォーマンスチューニングする際のポイント及びチューニングに関するヒントを説明します。
1. Tips
チューニングする際の必要なログについて
iPLAssが出力するログには、Action及びWebAPIの処理実行時間及び、その中で発行されるSQLの回数や実行時間が遅いSQL(閾値を設定し、それ以上遅いSQLの抽出)、INDEXを利用しないEQLを確認するログが存在します。
出力ログの設定方法は、ConnectionFactoryの「DriverManagerConnectionFactoryの設定」を参照
※警告を無視してもよいと判断したEQLには、suppress_warningsヒントコメントを付けておくと、そのEQLは警告ログ出力の対象から除外されます。適宜、判断の上、設定してください。Entityのストレージスペース変更による高速化
iPLAssは、一つのテーブルに複数のEntityを保持する構造になっており、大量なデータをEntityに登録する場合、他Entityを検索する際に処理時間に影響が出る可能性があります。
そのような場合は、大量なデータを登録するEntityを別のストレージスペースに登録します。
ストレージスペースを利用した場合、登録テーブルが別れるため、統計情報の精度が高まり、より良い実行計画になる事が見込まれます。設定方法は、StorageSpaceを参照Entityのカラムマッピング定義による高速化
iPLAssのプロパティに対するINDEX設定では複合INDEXを設定する事が出来ません。
定義したい場合は、カラムマッピングにてプロパティを特定のカラムに固定することで、データベースネイティブのINDEXを当該カラムに定義する事が可能です。設定方法は、column-mappingを参照
また、カラムマッピングを利用することにより、当該カラムをパーティションのキーとして利用する等、データベースネイティブのチューニングも可能となります。EQLへヒント句の設定
EQLに対してヒント句を設定する事が可能です。 ヒント句の設定方法は、hint-commentを参照
例えば、以下のような設定例があります。実行計画を確認して、想定しているINDEXが適応されていない場合は、indexヒントコメントを利用し、明示的にINDEXを使用する事が可能です。※ただし、Entity定義にて、INDEX、UNIQUE INDEX指定されている必要有
EQLから変換されたSQLを実行する際の実行計画が適切に作成されない場合があり、その場合の対応方法として、DBネイティブのヒント句(LEADING等)を用いてテーブルの結合順序を制御し、処理速度の向上を図ります。
EQLクエリーキャッシュの設定
上述したhint-commentのcacheヒントコメントを設定する事により、EQLの実行結果をキャッシュする事が可能です。
※キャッシュには、同一トランザクション内キャッシュのTRANSACTIONと、共有キャッシュのGLOBALが存在します。GLOBALを利用する場合は、Entity定義のqueryCacheを有効化した上で、EQLのcacheヒントを設定する必要があります。
※設定の注意点として、繰り返し実行されるようなEQL(キャッシュヒット率が高い)は有効ですが、実行頻度の少ないEQL(キャッシュヒット率が低い)の場合には、効果が低いため、キャッシュヒット率が高いEQLを見極めつつ設定を検討してください。
※キャッシュは、APサーバ上のメモリに保持されるため、メモリ消費量を確認しつつ、設定の検討してください。Entity権限設定時の注意事項
Entity権限の参照、登録、更新、削除可能範囲条件を設定する場合、セキュリティ設定としてEQLに検索条件が自動付与されます。 そのため、参照プロパティを多用している場合は、EQLが複雑になり、EQLから変換後のSQLもより複雑になります。極力、参照プロパティは利用しないでください。もし、必要な場合でもEntity内のプロパティに置き換えられないかの検討をしてください。ロール条件や各種権限条件による注意事項
ロール条件及び、Entity(参照、登録、更新、削除可能範囲条件),Action(許可条件),WebApi(許可条件),Workflow(許可条件)は、条件判定のチェックのため、処理を実行する度に呼び出される処理となります。そのため、条件内でDB検索処理や複雑な処理を組み込んだ場合、処理速度に影響します。
DB検索が必要な場合は、事前にキャッシュするなど検索しなくても可能な形への置き換えを検討してください。データ検索時の注意事項
検索条件未指定の場合は、データ件数が絞り込まれないため、検索速度が遅くなります。データ件数が多くないと、速度が遅い事に気づかないので、ご注意ください。
iPLAss汎用データ操作画面(GEM)のEntityView(設定から自動生成される検索画面)を利用する場合、対象のデータ件数が多くなることが見込まれる場合は考慮が必要です。
デフォルトの設定では、検索時にページングに利用するための件数のカウントとソート処理が実施されます。
検索条件未指定時、Index項目での絞り込みができない等の場合に検索速度が遅くなることがあります。
開発時などのデータ件数が十分に多くない状況下では、速度が遅い事に気が付きにくいので、ご注意ください。
軽減策として、検索条件に、十分な絞り込みができる必須項目を設け、且つ、必須項目にINDEX設定をする。
検索画面の設定で、「ページングを非表示」、「件数を非表示」を設定する。searchresult_settingを参照
ただし、「件数を非表示」を有効にした場合、初期ページ表示時は速くなりますが、2ページ目以降を表示する際に遅くなります。また、ソートされていないため、表示順に一貫性がないので、注意が必要です。合わせて、カスタムロジックでEQLを発行する際にも同様のことが言えますので、ご注意ください。
Expression型のプロパティ利用時の注意事項
検索画面の設定にてExpression型が設定できますが、Expression型は実体を持ちません。
実体を持たないため、利用する場合にパフォーマンスに影響が出ます。具体的な例としてINDEXを定義できないので、検索条件の絞り込み項目に設定しても、検索が速くなることはありません。
Expression型は検索時に処理されるため、クエリを実行する際に負荷がかかります。
負荷がかかる例として、Expression型で相関サブクエリを利用する場合があります。 例えば、
・見積Entity(mtp.transaction.Estimate)に参照プロパティとして、明細Entity(mtp.transaction.Detail)を多重度*で定義
・明細Entity(mtp.transaction.Detail)に参照プロパティとして、見積Entity(mtp.transaction.Estimate)を多重度1で定義
といった構造の場合に明細の個数をカウントするExpression型を見積Entity(mtp.transaction.Estimate)に定義
定義例:(select count() from mtp.transaction.Detail on .oid = estimate.oid )
上記のようなパターンの改善策として、Expression型をやめて、実体としてプロパティを定義し、更新時にEntityEventListenerなどで値を更新する方法等の検討をしてください。
AutoNumber型の採番ルールの注意事項
Entity定義において、AutoNumber型を利用する際に、採番ルール「同一トランザクションで採番」とした場合、同時にデータを登録する際には、前処理がコミットされるまで待ってしまうため、待ち時間が増えてしまいます。
採番の飛び番を許容する場合は、「別トランザクションで採番」を設定するようにしてください。Entityデータのバージョン管理利用時の注意事項
Entity定義において、データのバージョン管理を利用する際、検索処理時のEQL(SQL)の複雑性を軽減するため、要件が許す限り、STATE BASE方式もしくはSIMPLE TIME BASE方式を利用することを推奨します。
また、現在無効なバージョン含めてデータはすべて同じRDBテーブルに保存されますので、大量のデータが登録されることが予見される場合は、利用しないバージョンのデータの定期的なメンテナンス(削除、別Entity・RDBテーブルへの移動など)を検討してください。Entity設計時の注意事項
Entityの設計をする際には、正規化をする事が多いですが、過度な正規化はパフォーマンスへの悪影響が懸念されます。
通常のシステム開発時と同様の注意事項ではありますが、iPLAssの場合、Entity定義の作成・変更が容易なため、気が付かず過度に正規化してしまうこともあるためご注意ください。設計時には、非正規化とする事も検討ください。
正規化して参照プロパティが増加した場合、EQLからSQLへの変換時に関連テーブル(obj_refテーブル)が挟まるので、結合するテーブル数が増えます。結果、DB側の制限にてSQL自体が実行できなくなる場合や、パフォーマンスへの影響が出ます。 参照プロパティを多用すると結合するテーブル数が増えるので、留意して設計してください。非同期処理の活用
設計時に非同期処理に適した処理がないか検討してください。検討する内容として、負荷集中時にボトルネックとなる処理を非同期化する。非同期化した処理をキューで処理することで、スケールアップ、スケールアウトといった物理的な負荷分散ではなく、時間的に負荷分散する事ができます。結果、負荷のピークを平準化する事ができます。
例えば、処理時間がかかる集計処理を、集計ボタンを押してからレスポンスを返すまでの一つの処理とするわけではなく、集計処理の受付だけを実施し、時間のかかる集計処理自体は非同期で実行。その後、結果を取得する機能を別途用意し、集計結果を取得する。
ピーク性がある処理(チケット申込など)は、同期処理は受付のみとし、複雑な処理や、メール送信処理などを非同期で処理する。場合によっては、処理先を別サーバで実施する事も検討して、負荷集中してもスケールしやすくする。
非同期処理の設定は、RdbQueueServiceにてキューの設定を実施し、AsyncCommandコマンドを実装し、CommandInvokerクラスのexecuteAsyncメソッドにて呼び出す事で実行が可能です。
大量データ登録及び更新の高速化
データ移行などの大量データを登録及び更新、削除を実施する際には、bulk更新処理を活用する事ができます。
bulk更新処理は、EntityExplorerによる画面による方法
BatchTool Importを利用する方法
EntityManagerのbulkUpdateメソッドを利用する事により、bulk更新処理自体をプログラムから呼び出す方法
がありますので、必要に応じて利用を検討してください。
ログイン処理カスタマイズ時の注意点
ログイン認証コマンドをカスタマイズして、ログイン以外の処理を組み込む場合、トップページが表示されるまでの処理時間が長くなるため、注意が必要です。ログインする際に必要な処理かどうかの判断をした上で処理の組み込みをしてください。
例えば、トップページに表示する内容の取得のためにDB検索をしている場合は、トップページ表示後に非同期で取得する仕組みの検討や、データ自体をキャッシュして、ログイン時はキャッシュしたデータを取得する等の検討をしてください。設定ファイル(service-config.xml)のチューニング
設定ファイルのデフォルト値をそのまま利用すると不適切な場合があります。適切な値に設定して利用してください。
以下、設定内容の検討が必要な箇所となります。HttpClientConfigのhttpコネクションのプールの最大数、ドメイン単位のhttpコネクションの最大数
※HttpClientConfigの設定は、複数個所に設定されているので、各箇所への設定の見直しをしてください。CacheServiceに設定されているauthBuiltin、metadataのキャッシュの有効期限
RdbQueueService WorkerConfigのキューを並列で処理するワーカーの数、キューに割り当てるワーカーの数
MailServiceのSendGridMailServiceImplの設定にて、checkBounce(バウンスリスト、ブロックリストチェック)
※上記、デフォルト:trueであるため、検討が必要。
例えば、バウンスチェックの処理は遅いため、短時間で大量にメール送信する事が見込まれる場合は、falseに設定し、
運用対処でチェックする。