auto_explainの概要：遅いPostgresクエリプランを自動的にログに記録する方法

PostgreSQLクエリが遅い理由を知りたいですか？次に、EXPLAINANALYZEは素晴らしい出発点です。ただし、クエリプランは他のサーバーアクティビティに依存する可能性があり、実行に時間がかかる可能性があり、時間の経過とともに変化する可能性があるため、最も遅いクエリの実際の実行プランを確認する場合は、auto_explainが必要なツールです。この投稿では、その機能、構成方法、およびそれらのログを使用してクエリを高速化する方法について説明します。

auto_explainとは何ですか？

auto_explainはPostgreSQLの拡張機能であり、（構成可能な）しきい値よりも遅いクエリのクエリプランをログに記録できます。これは、遅いクエリ、特に問題が発生することがあるクエリのデバッグに非常に役立ちます。これはコントリビューションモジュールの1つであるため、通常のPostgreSQLに簡単にインストールおよび構成でき、非常に便利なので、ScaleGridでデフォルトでオンになっています。

auto_explain（commit、thread）の最初のバージョンの作成者である板垣隆宏氏、最初のパッチと提案に基づいたDean Rasheed氏、そして多くの人に感謝します。それ以来、寄稿者とレビューア。

どのauto_explainパラメータを使用する必要がありますか？

以下で最も重要なパラメータについて説明しますが、追跡できるすべての項目の詳細については、以下の表または公式ドキュメントを確認してください。

auto_explainの最も重要なパラメーターは、 log_min_durationです。 。デフォルトでは、これは -1に設定されています 、つまり何もログに記録されないため、ログが必要な場合は変更する必要があります。デフォルトの単位はmsであるため、 100の設定 100ミリ秒を超えるすべてのクエリのクエリプランをログに記録します。これはScaleGridでデフォルトとして選択したものですが、[管理]->[構成]で構成できます。何らかの理由で、すべてのクエリのクエリプランをログに記録する場合は、これを 0に設定できます。 –ただし、これはパフォーマンスに深刻な影響を与える可能性があることに注意してください。

クエリはすでにサーバーで実行されているため、 auto_explain.log_analyzeも有効にすることをお勧めします。 。これにより、出力は EXPLAIN ANALYZEの実行と同等になります。 。デフォルトでは、操作ごとのタイミングが追跡されることも意味します。これには追加のオーバーヘッドが伴いますが、 auto_explain.log_timingをオフにすることで最小限に抑えることができます （デフォルトでは log_analyzeでオンになります ）。ただし、当然ながら、操作ごとのタイミングは、遅いクエリをデバッグするときに非常に役立ちます。内部テストでは、これに対して許容できるオーバーヘッドが示されたため、ScaleGridではデフォルトでオンになっていますが、これまでどおりワークロードをテストして、オーバーヘッドが許容できるかどうかを確認してください。現在、このトピックに関して公開されている情報は限られていますが、pgMustardチームによる最近の投稿では、少なくとも小さなトランザクションワークロードでは、オーバーヘッドが2％まで低くなる可能性があることが示されています。彼らが指摘したように、これは auto_explain.sample_rateで減らすことができます クエリのサブセットのみを追跡するという犠牲を払って、パラメータ。

もう少し詳しく説明する最後のパラメータは、 auto_explain.log_formatです。 。デフォルトの出力はTEXTです。これは、 EXPLAINを使用することで最もよく知っているものと思われます。 。

これは、TEXT形式のauto_explain出力がどのように見えるかの簡単な例です。

2021-09-10 15:32:04.606 BST [22770] LOG:  duration: 3184.383 ms  plan:
	Query Text: select * from table1 order by column1;
	Sort  (cost=12875.92..13125.92 rows=100000 width=37) (actual time=2703.799..3055.401 rows=100000 loops=1)
	  Sort Key: column1
	  Sort Method: external merge  Disk: 4696kB
	  Buffers: shared hit=837, temp read=587 written=589
	  ->  Seq Scan on table  (cost=0.00..1834.01 rows=100000 width=37) (actual time=0.033..27.795 rows=100000 loops=1)
	        Buffers: shared hit=834

ここで、クエリプランの最初にクエリ期間が取得されていることがわかります。これは、通常、クエリプランの最後に表示されることに慣れている可能性があります。パラメータを含むクエリテキストも表示されます。

人気のある視覚化ツールexplain.depeszとexplain.daliboは、どちらもTEXT形式のクエリプランを受け入れますが、どちらもJSON形式をサポートしています。チームの一部が、JSON形式のみをサポートするPEVやpgMustardなどのツールを使用することを好む場合は、それを形式として設定することをお勧めします。 ScaleGridのお客様には、JSON形式を選択しました。これは、独自の低速クエリ分析機能のために、JSON形式をより簡単に解析したかったためです。

auto_explainパラメータとそのデフォルトの完全なリストは次のとおりです：

auto_explainのインストール

ScaleGridでは、auto_explainはデフォルトでオンになっており、しきい値は100ミリ秒です。これは、[管理]->[構成]で構成できます。

バニラPostgreSQLでは、auto_explainを session_preload_librariesの1つに追加するだけでインストールできます。 またはshared_preload_libraries 。前者には、a）再起動が不要（ただし、新しいセッションでのみロードされる）、b）一部のユーザーのみが有効にできる（ ALTER ROLE SET <でこのパラメーターを設定する）という利点があります。 / code> 。

session_preload_libraries = auto_explain
auto_explain.log_min_duration = 100
auto_explain.log_analyze = true
auto_explain.log_buffers = true
auto_explain.log_format = JSON

LOAD 'auto_explain';