Configuring Postgres Workload Report
====================================

``pwr``
の実行時に必要なコマンドライン引数の数を減らすには、構成ファイルを使用して、常に同じ値を持ち、値がデフォルトとは異なるオプションを指定できます。

..  Note::
   `edb-lasso` が正常に動作するには、構成ファイルが存在する必要があります。正しく構成されていない場合、`pwr` は完了できません。構成方法の詳細については、 :ref:`Lasso documentation </lasso/latest/configuration/>` を参照してください。

構成ファイルの場所
------------------

Postgresワークロードレポートは、次の場所で構成ファイルを検索し、最初に見つかったものを使用します。

1. ``--config``
   コマンドラインオプションで名前付けたファイルが指定されている場合。

2. ``PWR_CONFIG_FILE``
   環境変数で名前付けられたファイル設定されている場合。

3. ``~/.pwr.conf``

4. ``/etc/pwr.conf``

インストールパッケージは、\ ``/etc/pwr.conf.templ``
に構成ファイルのテンプレートを作成します。このファイルをPostgresワークロードレポートがデフォルトで構成ファイルを検索する2つの場所\ ``~/.pwr.conf``
および\ ``/etc/pwr.conf``
のいずれかにコピーし、必要に応じてテンプレートのオプションを編集することをお勧めします。

..  Note::
   構成ファイルが見つからない場合、Postgresワークロードレポートはすべてのオプションのデフォルト値を想定していますが、対応するコマンドラインオプションを使用してオーバーライドできます。コマンドラインオプションの使用の詳細については、 :ref:`Using Postgres Workload Report <Using Postgres Workload Report>` を参照してください。

..  Note::
   構成ファイルの拡張子は`.conf` ですが、そのコンテンツは**valid** YAML形式である必要があります。

構成ファイルオプション
----------------------

input_dir
^^^^^^^^^

Lassoレポートの\ ``edb_wait_states``
部分が存在する既存のディレクトリ。このオプションは、主に\ ``pwr report``
実行に使用されます :ref:`Using Postgres Workload Report <Using Postgres Workload Report>` を参照してください。

Output_dir
^^^^^^^^^^

Postgres Workload Reportがレポートファイルを書き込むディレクトリの場所。
``pwr`` を実行すると、このディレクトリが存在しない場合は作成されます。

Report_name
^^^^^^^^^^^

生成されたレポートファイルの名前。通常、レポートごとに名前が異なるため、コマンドラインでこのオプションを指定します。

ファイル拡張子は含めないでください。コマンドラインで指定された出力形式に基づいて、適切な拡張子が追加されます。つまり、
``--pdf`` は\ ``.pdf`` を追加し、\ ``--html`` は\ ``.html``
を追加します。

log_file
^^^^^^^^

Postgresワークロードレポートが\ ``stdout`` および\ ``stderr``
ログを書き込むファイルへのフルパス。

log_level
^^^^^^^^^

Postgresワークロードレポートを実行するときに使用するログレベル。以下は有効な値であり、より冗長なものからより低いものまでリストされています。

-  ``DEBUG``

-  ``INFO`` 指定しない場合のデフォルト

-  ``WARNING``

-  ``ERROR``

-  ``CRITICAL``

ログレベルの詳細については、
 `the Python logging <https://docs.python.org/3/library/logging.html#logging-levels>`_ ドキュメントを参照してください。

log_format
^^^^^^^^^^

ログファイルに書き込まれるログメッセージの形式。ログのフォーマットの詳細については、
 `the Python logging <https://docs.python.org/3/library/logging.html#logrecord-attributes>`_ ドキュメントを参照してください。

attempts_dir
^^^^^^^^^^^^

HTML出力のフォーマットに使用されるJinjaテンプレートと、PDF出力に使用されるCSSが含まれるディレクトリ。デフォルト値は\ ``/usr/share/pwr/assets``
で、これには、 ``edb-pwr``
パッケージで提供されるアセットが含まれています。
