環境変数、接続文字列、Psycopg2 接続パラメータ、PostgreSQL 設定ファイルで application_name を設定する方法

PostgreSQL/SQLAlchemy で application_name を設定する方法について解説します。

application_name は、PostgreSQL に接続しているアプリケーションの名前を識別するために使用される文字列です。これは、pg_stat_activity ビューや CSV ログエントリなどに表示されます。

設定方法

application_name を設定するには、以下の方法があります。

環境変数

以下の環境変数を設定することで、application_name を指定できます。

• PGAPPNAME

例:

export PGAPPNAME="myapp"

接続文字列に application_name を含めることで、設定できます。

engine = create_engine("postgresql://scott:tiger@localhost/test?application_name=myapp")

connect_args

create_engine() の connect_args 引数に application_name を含めることで、設定できます。

engine = create_engine("postgresql://scott:tiger@localhost/test", connect_args={"application_name": "myapp"})

Psycopg2 接続パラメータ

Psycopg2 を使用している場合は、connect() メソッドの application_name パラメータに設定できます。

import psycopg2

conn = psycopg2.connect(
    database="test",
    user="scott",
    password="tiger",
    host="localhost",
    application_name="myapp",
)

注意事項

• application_name は、最大 64 文字の ASCII 文字列でなければなりません。
• 使用できる文字は、英数字、ハイフン (-)、アンダースコア (_)、ピリオド (.)、およびドル記号 ($) です。
• その他の文字は、疑問符 (?) に置き換えられます。

import sqlalchemy as sa

# 環境変数で設定
engine = sa.create_engine("postgresql://localhost/test", connect_args={"application_name": "myapp"})

# 接続文字列で設定
engine = sa.create_engine("postgresql://scott:tiger@localhost/test?application_name=myapp")

# Psycopg2 接続パラメータで設定
import psycopg2

conn = psycopg2.connect(
    database="test",
    user="scott",
    password="tiger",
    host="localhost",
    application_name="myapp",
)

# 環境変数で設定
$ export PGAPPNAME="myapp"
$ python sample.py

# 接続文字列で設定
$ python sample.py

# Psycopg2 接続パラメータで設定
$ python sample.py

出力例

# pg_stat_activity

application_name | pid | ...
-----------------+------+...
myapp            | 1234 | ...

他の方法

PostgreSQL 設定ファイル (postgresql.conf) に application_name パラメータを設定することで、デフォルトのアプリケーション名を指定できます。

application_name = 'myapp'

• この方法は、すべての接続に影響を与えるため、注意が必要です。
• 個別の接続で異なる application_name を設定したい場合は、他の方法を使用する必要があります。

pg_hba.conf ファイルに application_name を含めることで、特定の接続に対して application_name を設定できます。

host    database    user    method    md5
localhost    test    all     md5     application_name = 'myapp'

• この方法は、PostgreSQL 9.6 以降でのみ使用できます。
• pg_hba.conf ファイルを変更する前に、バックアップを取ることを忘れないでください。

クライアントライブラリ

PostgreSQL クライアントライブラリによっては、application_name を設定するための独自の方法がある場合があります。

• libpq: PQconnectdbOptions() 関数の application_name フィールド