設定ファイル

ユーザーは設定ファイルや環境変数を使ってEMQXを設定できます。本節では主にEMQXの設定ファイルについて紹介し、EMQXで最もよく使われる機能の基本的な設定方法を説明します。詳細かつ包括的な設定項目の説明については、EMQX Enterprise Configuration Manualをご参照ください。

設定ディレクトリ

EMQXをインストールすると、設定およびランタイムデータを管理するための一連のディレクトリが作成されます。これらのディレクトリは主に以下の2つのカテゴリに分かれています。

静的設定ディレクトリ（etc）：読み取り専用で、不変または静的な設定ファイルを格納します。
動的設定ディレクトリ（data/configs）：書き込み可能で、ランタイム中に生成または動的に更新される設定ファイルを格納します。

静的設定ディレクトリ（`etc`）

etcディレクトリにはEMQXの初期設定を定義する設定ファイルが格納されます。これらのファイルは通常、デプロイやアップグレード時に変更され、ランタイム中は安定性を確保するため読み取り専用となっています。etcディレクトリの場所はインストール方法によって異なります。

インストール方法	パス
RPMまたはDEBパッケージでインストール	`/etc/emqx`
Dockerコンテナで実行	`/opt/emqx/etc`
ポータブル圧縮パッケージから展開	`./etc`

動的設定ディレクトリ（`data/configs`）

ランタイム中、EMQXはダッシュボード、REST API、CLIを通じて動的な再設定を許可しています。これらのツールで行われた変更は、セッションをまたいで永続化されるようにdata/configsディレクトリに保存されます。このディレクトリの場所もインストール方法によって異なります。

インストール方法	パス
RPMまたはDEBパッケージでインストール	`/var/lib/emqx/configs`
Dockerコンテナで実行	`/opt/emqx/data/configs`
ポータブル圧縮パッケージから展開	`./data/configs`

TIP

node.data_dir設定や環境変数EMQX_NODE__DATA_DIRを変更することで、データディレクトリの場所を変更可能です。ただし、クラスターを構成する場合は、すべてのノードで同一のディレクトリパスを使用する必要があります。

設定ファイルの内容が重複することは推奨されませんが、重複した場合はあらかじめ定められた上書きルールに従って解決されます。詳細はConfig Override Rulesをご覧ください。

設定例

Schemaセクションでは詳細なリファレンスを提供していますが、設定例はEMQXの設定を理解し適用するうえで役立ちます。

RPMまたはDEBパッケージでEMQXをインストールした場合、設定例はetc/emqx/examplesディレクトリにあります。
DockerコンテナでEMQXを実行している場合、設定例はopt/emqx/etc/examplesディレクトリにあります。

ベース設定ファイル

EMQX 5.8.4以降、etcディレクトリにbase.hoconというベース設定ファイルが存在します。このファイルにはデフォルト設定が含まれており、ランタイム中により上位の設定ファイルで上書き可能です。

例えば、認証の基本設定でデプロイを開始し、後からダッシュボードUIでより複雑な設定に上書きすることが可能です。

nodeやclusterのような不変の設定については、デプロイ固有の値でランタイム中に変更しない場合、環境変数を利用することもできます。詳細はEnvironment VariablesおよびConfig Override Rulesをご参照ください。

TIP

base.hoconファイルはクラスター間で同期されず、そのノードにのみ適用されます。

設定書き換えファイル

data/configsディレクトリ内のcluster.hoconファイルはクラスター全体の設定項目を含みます。ダッシュボード、REST API、CLIからの設定変更はこのファイルに永続化されます。

クラスター内のノードが再起動されたり新しいノードが追加された場合、ノードは自動的に他のノードからcluster.hoconファイルをコピーして適用します。そのため、このファイルを手動で編集することは推奨されません。

このファイルの設定はbase.hoconの設定の上に適用されます。設定の上書き階層の詳細はConfig Override Rulesをご覧ください。

EMQX 5.1以降、クラスター設定の変更があるとcluster.hoconファイルのバックアップが上書き前に自動で作成されます。バックアップファイルはノードのローカル時間でタイムスタンプが付けられ、最大10個まで保持されます。

不変設定ファイル

後方互換性のため、重要なシステム設定（nodeやcluster設定を含む）にはemqx.confファイルも引き続き利用可能です。このファイルはbase.hoconやcluster.hoconより優先度が高いですが、環境変数よりは低い優先度です。意図的にこの優先度を利用し、パッケージアップグレードでこのファイルのデフォルトが更新される可能性を理解している場合を除き、変更は避けてください。

設定の上書きについてはConfig Override Rulesを参照してください。

設定パス

EMQXでは設定値をドット区切りのパスで参照できます。これはツリー構造に似ており、ルート（常にStruct）から始まり、各セグメントはフィールド名またはMapのキーを示します。配列要素の場合は1始まりのインデックスを使用します。

設定パスの例：

bash

node.name = "emqx.127.0.0.1"
zone.zone1.max_packet_size = "10M"
authentication.1.enable = true

HOCON設定フォーマット

EMQX v5.0以降、設定ファイルフォーマットとしてHuman-Optimized Config Object Notation (HOCON)を採用しています。

HOCONは人間に読みやすいデータフォーマットであり、JSONのスーパーセットです。継承や結合、クオートなどの機能により、設定作業をさらに簡素化します。

HOCON構文例：

HOCON値はJSONに似たオブジェクトとして表現できます。

bash

node {
  name = "emqx@127.0.0.1"
  cookie = "mysecret"
  cluster_call {
    retry_interval  =  1m
  }
}

またはフラット形式で：

bash

node.name = "127.0.0.1"
node.cookie = "mysecret"
node.cluster_call.retry_interval = "1m"

このフラット形式は以前のEMQXバージョンとの互換性を保ちつつ、使い方が異なります。

HOCONでは文字列の両端にクオートを付けることを推奨します。特殊文字がない文字列はクオートなしでも構いません（例：foo、foo_bar）。一方、フラット形式は=の右側の全てを値として扱います。

HOCON構文の詳細はHOCON Documentationをご参照ください。

環境変数

設定ファイルのほかに、環境変数を使ってEMQXを設定することも可能です。

例えば、環境変数EMQX_NODE__NAME=emqx2@127.0.0.1は以下の設定を上書きします。

bash

# emqx.conf
node {
  name = "emqx@127.0.0.1"
}

設定項目と環境変数の変換ルールは以下の通りです。

設定ファイルの.区切りは環境変数で使えないため、EMQXは代わりにダブルアンダースコア__を区切り文字として使います。
他の環境変数と区別するため、EMQXは環境変数の先頭にEMQX_プレフィックスを付けます。
環境変数の値はHOCON値として解析されるため、複雑なデータ型も渡せます。:、=、#などのHOCON特殊文字を含む値は、パーサーが文字列として扱うようにダブルクオート"で囲む必要があります。特に#はHOCONの行コメント開始文字なので、クオートなしだと#以降がコメントとして無視されます。

変換例：

bash

# 環境変数

## localhost:1883は構造体{"localhost": 1883}として解析されるため、ダブルクオートで囲む必要がある
export EMQX_LISTENERS__SSL__DEFAULT__BIND='"127.0.0.1:8883"'

## HOCON配列を文字列で直接渡す
export EMQX_LISTENERS__SSL__DEFAULT__SSL_OPTIONS__CIPHERS='["TLS_AES_256_GCM_SHA384"]'


# 設定ファイル
listeners.ssl.default {
    ...
    bind = "127.0.0.1:8883"
    ssl_options {
      ciphers = ["TLS_AES_256_GCM_SHA384"]
    }
  }
}

#、:、=を含む値について

パスワードなどに#を含む場合、#以降がHOCONのコメントとして扱われてしまうため注意が必要です。

bash

export EMQX_DASHBOARD__DEFAULT_PASSWORD="MQtt#123"

はパスワードがMQttとして解釈され、#123はコメントとして破棄されます。文字列として正しく渡すには、HOCONレベルのダブルクオート（シェルのクオートとは別）で囲み、パーサーに"MQtt#123"として認識させます。

bash

# 正しい例 — HOCONパーサーに渡される値は "MQtt#123"
export EMQX_DASHBOARD__DEFAULT_PASSWORD='"MQtt#123"'

# 同じ効果、シェル用に内側のクオートをエスケープ
export EMQX_DASHBOARD__DEFAULT_PASSWORD="\"MQtt#123\""

:や=を含む値も同様です。URLエンコード（例：%23）は動作しません。EMQXは環境変数の値をURLデコードしません。

なぜ一部のクオートなし値は通り、一部は通らないのか

内部的にEMQXは環境変数の値をfake_key=<値>としてHOCONパーサーに渡します。パース成功すれば解析結果を使い、失敗すれば生の文字列を使います。

そのため、EMQX_..._PASSWORD="abc#def"はabc（#defはコメント）となりますが、EMQX_..._PASSWORD=".abc#def"は無効なHOCON構文のため生文字列.abc#defが使われます。HOCONクオートで囲むと動作が確定的になります。

TIP

EMQXは未定義のルートパス（例：EMQX_UNKNOWN_ROOT__FOOBAR）を無視します。UNKNOWN_ROOTは事前定義されたルートパスではないためです。

既知のルートパスに未知のフィールド名を設定すると、起動時にwarningログが出力されます。例えば、enableを誤ってenabledと設定すると以下のように表示されます。

bash

[warning] unknown_env_vars: ["EMQX_AUTHENTICATION__ENABLED"]

設定上書きルール

EMQXでは設定値は階層的に適用され、以下の上書きルールがあります。

同一ファイル内では後に定義された値が前の値を上書きします。
上位の設定ファイルが下位の設定を置き換えます。

設定の優先順位は以下の通りです。

base.hocon < cluster.hocon < emqx.conf < 環境変数

つまり、base.hoconの設定は最も優先度が低く、より優先度の高いファイルで上書きされます。EMQX_で始まる環境変数が最も優先されます。

TIP

バージョン5.8.4以前はbase.hoconファイルが存在しませんでした。優先順位は同じですがbase.hoconは含まれません。

ダッシュボードUI、HTTP API、CLIからの変更はランタイム中にcluster.hoconに永続化され即時反映されます。ただし、同じ設定項目がemqx.confや環境変数で異なる値に設定されている場合、ノード再起動後に変更が元に戻ることがあります。

混乱を避けるため、emqx.confとcluster.hoconで設定を重複させないようにしてください。

TIP

古いEMQXバージョン（例：5.0.2/v5.0.22以前）では、cluster-override.confファイルが存在し、設定の優先順位はemqx.conf < ENV < HTTP API (cluster-override.conf)でした。
これらの古いバージョンから最新バージョンにアップグレードしても優先順位は変わらず、互換性維持のためcluster.hoconは作成されません。
cluster-override.conf機構はバージョン5.1で廃止されました。

上書き例

以下の設定では、最後の行で定義されたlevelのdebugが前のerrorを上書きしますが、enableフィールドは変更されません。

bash

log {
  console {
    enable = true
    level = error
  }
}

## コンソールログのレベルをdebugに設定し、他の設定は維持
log.console.level = debug

パケットサイズ制限は最初に1MBに設定され、その後10MBに上書きされています。

bash

zones {
  zone1 {
    mqtt.max_packet_size = 1M
  }
}
zones.zone1.mqtt.max_packet_size = 10M

リスト要素の上書き

EMQXの配列は以下の2つの表現方法があります。

リスト形式（例：[1, 2, 3]）
マップ形式（サブスクライブ用、例：{"1"=1, "2"=2, "3"=3}）

以下の3つの形式は同等です。

bash

authentication.1 = {...}
authentication = {"1": {...}}
authentication = [{...}]

この特徴を利用して、配列の要素の値を簡単に上書きできます。例えば：

bash

authentication  = [
  {
    enable = true,
    backend = "built_in_database",
    mechanism = "password_based"
  }
]

# 1番目の要素の`enable`フィールドを以下のように上書き可能
authentication.1.enable = false

TIP

リスト形式の配列は完全に上書きされ、元の値は保持されません。例えば：

bash

authentication = [
  {
    enable = true
    backend = "built_in_database"
    mechanism="password_based"
  }
]

## 以下のようにすると、1番目の要素の`enable`以外のフィールドはすべて失われる
authentication = [{ enable = true }]

ゾーンの上書き

EMQXのゾーンは設定をグループ化する概念です。リスナーにzoneフィールドでゾーン名を設定すると、そのゾーンに紐づくリスナーに接続したMQTTクライアントはゾーンの設定を継承し、グローバル設定を上書きすることがあります。

TIP

デフォルトではリスナーはdefaultという名前のゾーンに紐づいています。defaultゾーンは論理的なグループであり、設定ファイルには存在しません。

ゾーンレベルで上書き可能な設定項目は以下の通りです。

mqtt：MQTT接続やセッション設定。特定ゾーンでMQTTメッセージの最大パケットサイズを大きくするなど。
force_shutdown：強制シャットダウンのポリシー。
force_gc：Erlangプロセスのガベージコレクションの微調整。
flapping_detect：クライアントのフラッピング検知。
durable_sessions：セッション永続化設定。特定ゾーンでMQTTセッションの永続化を有効化など。

EMQXバージョン5のデフォルト設定ファイルにはゾーンは含まれていません。これはバージョン4のinternalとexternalの2つのデフォルトゾーンとは異なります。

ゾーンを作成するには、設定ファイルで以下のように定義します。

bash

zones {
  # 複数のゾーンを定義可能
  my_zone1 {
    # ゾーンはグローバル設定と同じスキーマを共有
    mqtt {
      # このゾーンの接続に対してより大きなパケットサイズを許可
      max_packet_size = 10M
    }
    force_shutdown {
      # このゾーン固有の設定
      ...
    }
    durable_sessions {
      # このゾーンでセッションの永続化を有効化
      enable = true
      ...
    }
  }
  my_zone2 {
    ...
  }
}

リスナーでzoneフィールドに作成済みのゾーン名を設定します。

bash

listeners.tcp.default {
    bind = 1883
    zone = my_zone1
    ...
}

設定コード管理のベストプラクティス

EMQXの設定をソース管理や自動化システムで管理する場合、以下のルールを推奨します。

設定コードはbase.hoconに置く。
cluster.hoconを手動で編集したり、自分のcluster.hoconをマウントしない。
emqx.confは優先度が高いこととアップグレード時の影響を理解していない限り変更しない。
ランタイム中にダッシュボードやAPI、CLIで変更しない単純な上書きは環境変数で行う。

設定コードの真実のソースはbase.hoconです。ノード起動時に静的設定ディレクトリから読み込まれ、パッケージングやイメージビルド、構成管理、GitOpsワークフローで管理できます。ダッシュボード、REST API、CLIからのランタイム変更はcluster.hoconに永続化され、base.hoconの上に重ねられます。

例えば、リスナー、ログ、認証、認可、データ統合のベースライン設定をbase.hoconに保持できます。

bash

# base.hocon
listeners.tcp.default {
  bind = "0.0.0.0:1883"
  max_connections = 1024000
}

log.console {
  enable = true
  level = warning
}

authentication = [
  {
    mechanism = password_based
    backend = built_in_database
    user_id_type = username
  }
]

cluster.hoconは設定コードの真実のソースとして使わないでください。ランタイム中にEMQXが管理し、ダッシュボード、REST API、CLIが書き換え、上書き前にバックアップを作成し、クラスター内でノード間コピーが行われます。手動編集やマウントはランタイム更新と競合し、上書きされる恐れがあります。

emqx.confは配布パッケージにベースライン設定ファイルとして同梱されています。変更せずにおくと、新しいEMQXバージョンで提供される保守的なデフォルト変更を取り込みやすくなります。emqx.confで設定した項目はbase.hoconとcluster.hoconより優先度が高いため、同じ項目のランタイム変更は動作しているように見えてもノード再起動後に元に戻ることがあります。意図的にその挙動が必要な場合のみ利用してください。

環境変数は最も優先されます。デプロイ固有の単純な値、特にランタイム中に変更しない値に適しています。

bash

export EMQX_NODE__NAME='emqx@node1.example.net'
export EMQX_NODE__COOKIE='mysecret'
export EMQX_CLUSTER__DISCOVERY_STRATEGY='static'
export EMQX_CLUSTER__STATIC__SEEDS='["emqx@node1.example.net", "emqx@node2.example.net"]'

環境変数はすべての設定ファイルを上書きするため、オペレーターが後からダッシュボードやAPI、CLIで調整することが想定される設定には使わないでください。

スキーマ

HOCONオブジェクトの型安全性を高めるため、EMQXはスキーマを導入しています。このスキーマはデータ型、フィールド名、メタデータを定義し、設定値の検証などに利用されます。

EMQX Enterprise Configuration Manualはこのスキーマから生成されています。

TIP

ゾーン設定のスキーマは各グループで共通のため、設定マニュアルには含まれていません。例えばzones.my_zone1.mqtt {...}はmqtt {...}と同じスキーマです。

プリミティブデータ型

設定マニュアルのプリミティブデータ型はほぼ自明で、簡潔な説明で十分です。以下は全てのプリミティブ型の一覧です。

Integer（整数）

整数値を表します。例：42、-3、0。

Integer(Min..Max)

指定された範囲内の整数。例：1..+infは1以上の正の整数を意味します。

Enum(symbol1, symbol2, ...)

列挙型で、定義されたシンボルのいずれかのみを取れます。例：Enum(debug,info,warning,error)はログレベルの指定に使います。

String（文字列）

文字列型は複数の形式をサポートし、多様な用途に対応します。

クオートなし：特殊文字を含まない単純な識別子や名前に適します（詳細は後述）。
クオート付き文字列：特殊文字や空白を含む場合はダブルクオート"で囲み、必要に応じてバックスラッシュ\でエスケープします。例："line1\nline2"。
トリプルクオート文字列："""で囲み、\以外のエスケープ不要で複雑な内容を簡単に記述可能です。トリプルクオートに隣接するクオートはエスケープが必要です。
インデント付きトリプルクオート文字列："""~と~"""で囲み、EMQX 5.6以降で導入。複数行や整形テキストのインデントを許容し、設定ファイルの可読性を向上させます。

クオートなし文字列の注意点：

禁止文字：$、"、{、}、[、]、:、=、,、+、#、`、^、?、!、*、&、\、および空白。
//で始めない（コメント開始と誤認されるため）。
true、false、nullで始めない（ブール値やnullと誤認されるため）。

トリプルクオート文字列のガイドライン：

トリプルクオートに隣接するクオートはエスケープするか~区切りを使う。
複数行文字列はスペース（タブ不可）によるインデントをサポート。インデントレベルは最小の先頭スペース数で決定。

例：

rule_xlu4 {
  sql = """~
    SELECT
      *
    FROM
      "t/#"
  ~"""
}

HOCONの文字列クオート規則の詳細はHOCON仕様を参照してください。

EMQX独自のインデント付きトリプルクオートの詳細はemqx/hocon.git READMEをご覧ください。

String("constant")

定数文字列値で、単一値の列挙型（Enum）として機能します。特定の固定値やモードを定義するのに使います。

Boolean（真偽値）

trueまたはfalse（大文字小文字区別あり）。

Float（浮動小数点数）

小数を含む数値。例：3.14、-0.001。

Duration（期間）

人間に読みやすい形式で時間の長さを表現します。フォーマットの詳細は別途説明。

Duration(s)

秒単位の精度を持つDuration型。詳細と例は別途。

Secret（シークレット）

パスワードやトークンなどの機密情報用の型。用途と重要性について説明。

複合データ型

EMQXのHOCON設定における複合データ型は、他の複合型やプリミティブ値を含むデータ構造を表現します。柔軟かつ階層的なデータ表現を可能にします。

Struct `Struct(name)`

波括弧{}で囲まれたフィールドを持つ構造体。nameは構造体のフィールドと型を指定するスキーマ名です。

Map `Map($name->Type)`

Structに似ていますが、フィールド名が事前定義されていないキー・バリューの集合です。

$nameは任意の文字列キー（.を含まない）を示し、エンティティや属性の名前を表します。Typeはマップ内のすべての値が同一の型であることを示します。

OneOf `OneOf(Type1, Type2, ...)`

複数の型のいずれかを取れるユニオン型。ある構造体のフィールドが複数の型のどれかであることを示します。例：String(infinity)かDurationのどちらか。

Array `Array(Type)`

指定されたTypeの要素からなる配列。

TIP

Mapのフィールド名が正の整数の場合、Arrayの別表現として解釈されます。例：

bash

myarray.1 = 74
myarray.2 = 75

はmyarray = [74, 75]と解釈され、配列要素の上書きに便利です。

Variform式

Variformは文字列操作やランタイム評価のための軽量で表現力豊かな言語です。完全なプログラミング言語ではなく、EMQXの設定内に埋め込んで文字列操作を動的に行うための専門ツールです。

TIP

Variform式は特定の設定項目でのみ使用可能です。指定がない限り使わないでください。

NULL値について

Variform式では、値のバインディング参照や部分式の評価が未定義値となる場合があり、これは空文字列（''）として表現されます。

JSONデコードされたフィールドがnullの場合、未定義値（''）として扱われ、文字列"null"とは異なります。

構文例

function_call(clientid, another_function_call(username))

この式はclientidとusernameを組み合わせて新しい文字列値を生成します。

Variformは以下のリテラルをサポートします。

Boolean：trueまたはfalse
Integer：例42
Float：例3.14
String：シングルクオート'またはダブルクオート"で囲まれたASCII文字列
Array：[と]で囲まれ、カンマ,で区切られた要素
変数：事前定義された値への参照（例：clientid）
関数：事前定義された関数（例：concat([...])）

Variformは以下をサポートしません。

算術演算
ループ
ユーザー定義変数
ユーザー定義関数
例外処理やエラー回復
文字列リテラル内のエスケープシーケンス（特殊文字のアンエスケープにはunescape関数を呼び出す）

以下はVariform式を埋め込んだ設定例です。

mqtt {
    client_attrs_init = [
        {
            # client IDの最初の`-`までのプレフィックスを抽出
            expression = "nth(1, tokens(clientid, '-'))"
            # client_attrs.groupとして設定
            set_as_attr = group
        }
    ]
}

TIP

式内でアンエスケープ関数を使う場合、HOCON設定でトリプルクオート"""文字列を使うと二重エスケープが不要で便利です。

例：

#### 複数行のclient IDの最初の行を取得
expression = """nth(1, tokens(clientid, unescape('\n')))"""

事前定義関数

EMQXはルールエンジンの文字列関数に似た豊富な文字列、配列、乱数、ハッシュ関数を提供しています。これらは抽出データの操作や整形に使えます。例えば、lower()、upper()、concat()は文字列のフォーマット調整に、hash()やhash_to_range()はハッシュ化や範囲マッピングに使います。

利用可能な関数の例：

文字列関数：
- 文字列操作関数
- 新関数any_to_string/1は任意の中間値を文字列に変換
配列関数：nth/2など
乱数関数：rand_str、rand_int
スキーマレスエンコード/デコード関数：
- bin2hexstr(Data)
- hexstr2bin(Data)
- base64_decode(Data)
- base64_decode(Data, 'no_padding')（6.0.2以降）
- base64_decode(Data, 'no_padding', 'urlsafe')（6.0.2以降）
- base64_encode(Data)
- base64_encode(Data, 'no_padding')（6.0.2以降）
- base64_encode(Data, 'no_padding', 'urlsafe')（6.0.2以降）
- int2hexstr(Integer)：整数を16進文字列にエンコード。例：15はF（大文字）。
ハッシュ関数：
- hash(Algorithm, Data)：Algorithmはmd4、md5、sha（sha1）、sha224、sha256、sha384、sha512、sha3_224、sha3_256、sha3_384、sha3_512、shake128、shake256、blake2b、blake2sから選択可能。
- hash_to_range(Input, Min, Max)：sha256でハッシュ化し、MinからMaxまでの整数にマッピング（Min <= X <= Max）。
- map_to_rage(Input, Min, Max)：入力をMinからMaxまでの整数にマッピング（Min <= X <= Max）。
比較関数：
- num_eq(A, B)：数値が同じならtrue、そうでなければfalse
- num_neq(A, B)：数値が異なればtrue、そうでなければfalse
- num_gt(A, B)：A > Bならtrue、そうでなければfalse
- num_gte(A, B)：A >= Bならtrue、そうでなければfalse
- num_lt(A, B)：A < Bならtrue、そうでなければfalse
- num_lte(A, B)：A <= Bならtrue、そうでなければfalse
- str_eq(A, B)：文字列が同じならtrue、そうでなければfalse
- str_neq(A, B)：文字列が異なればtrue、そうでなければfalse
- str_gt(A, B)：辞書順でAがBより後ならtrue、そうでなければfalse
- str_gte(A, B)：辞書順でAがBより前でないならtrue、そうでなければfalse
- str_lt(A, B)：辞書順でAがBより前ならtrue、そうでなければfalse
- str_lte(A, B)：辞書順でAがBより後でないならtrue、そうでなければfalse
- is_empty_var(V)：変数が空かどうかを判定。Variformの空は未定義値（undefined）、JSONのnull（文字列"null"は除く）、空文字列""を含む。
- not(Bool)：Boolがfalseならtrue、trueならfalseを返す。文字列も受け付け、入力が文字列なら出力も文字列。
システム関数：
- getenv(Name)：環境変数Nameの値を返す。ただしOS環境変数から読み取る際はEMQXVAR_プレフィックスが付加される。例：getenv('FOO_BAR')はEMQXVAR_FOO_BARを読み取る。読み込み後は値は不変。
データ抽出関数：
- json_value(Data, Path)：JSON文字列からドット区切りパスでネスト構造の値を抽出。例：usernameがJSONオブジェクトの場合、json_value(username, 'shop.floor')でフィールドにアクセス。
- jwt_value(Data, Path)：JWTトークンのペイロードをデコードし、ドット区切りパスでクレーム値を抽出。例：passwordがカスタムクレームを持つJWTの場合、jwt_value(password, 'client_attrs.unitid')でネスト値にアクセス。

条件式

Variform式は包括的な制御フローを持ちませんが、以下の関数で基本的な返却値の制御が可能です。

iif(Condition, ThenExpression, ElseExpression)：Conditionがtrueまたは空でない文字列ならThenExpressionを返し、そうでなければElseExpressionを返す。
coalesce(Arg1, Arg2, ...)：最初の空でない引数を返す。
coalesce([Element1, Element2, ...])：最初の空でない配列要素を返す。

エラー処理

Bashのスクリプト環境と同様に、Variform式は未バインド変数や実行時例外が発生した場合、空文字列（""）を返す設計です。

未バインド変数：定義されていない変数参照は空文字列となる。
実行時例外：関数の誤用や型不一致などの例外は空文字列を返す。例：配列のインデックス範囲外など。

式の例

nth(1, tokens(clientid, '.'))：ドット区切りのclient IDのプレフィックスを抽出。
strlen(username, 0, 5)：usernameの部分文字列を抽出。
coalesce(regex_extract(clientid,'[0-9]+'),'vin-1000')：正規表現でclient IDから数字を抽出。空文字列なら'000'を返す。
iif(true, "Value if true", "Value if false")：Value if trueを返す。
iif("", "Value if true", "Value if false")：Value if falseを返す。
iif("hello", "Value if true", "Value if false")：Value if trueを返す。
iif(regex_match(clientid,'^foo\.+*'),'foo','bar')：clientidがfoo.で始まればfoo、そうでなければbarを返す。

Kubernetes

EMQX Operator

EMQX クラスター管理

API リファレンス

パスワード認証

監視

アクセスコントロール

統合

管理

Prometheus との統合

OpenTelemetry との統合

エンドツーエンドトレース

プラグインカタログ

JT/T 808 ゲートウェイ

GB/T 32960 ゲートウェイ

Volcengine RTC

シナリオ

GPT-Realtime

設定ファイル ​

設定ディレクトリ ​

静的設定ディレクトリ（etc） ​

動的設定ディレクトリ（data/configs） ​

設定例 ​

ベース設定ファイル ​

設定書き換えファイル ​

不変設定ファイル ​

設定パス ​

HOCON設定フォーマット ​

環境変数 ​

設定上書きルール ​

上書き例 ​

リスト要素の上書き ​

ゾーンの上書き ​

設定コード管理のベストプラクティス ​

スキーマ ​

プリミティブデータ型 ​

Integer（整数） ​

Integer(Min..Max) ​

Enum(symbol1, symbol2, ...) ​

String（文字列） ​

String("constant") ​

Boolean（真偽値） ​

Float（浮動小数点数） ​

Duration（期間） ​

Duration(s) ​

Secret（シークレット） ​

複合データ型 ​

Struct Struct(name) ​

Map Map($name->Type) ​

OneOf OneOf(Type1, Type2, ...) ​

Array Array(Type) ​

Variform式 ​

構文例 ​

事前定義関数 ​

条件式 ​

エラー処理 ​

式の例 ​

設定ファイル

設定ディレクトリ

静的設定ディレクトリ（`etc`）

動的設定ディレクトリ（`data/configs`）

設定例

ベース設定ファイル

設定書き換えファイル

不変設定ファイル

設定パス

HOCON設定フォーマット

環境変数

設定上書きルール

上書き例

リスト要素の上書き

ゾーンの上書き

設定コード管理のベストプラクティス

スキーマ

プリミティブデータ型

Integer（整数）

Integer(Min..Max)

Enum(symbol1, symbol2, ...)

String（文字列）

String("constant")

Boolean（真偽値）

Float（浮動小数点数）

Duration（期間）

Duration(s)

Secret（シークレット）

複合データ型

Struct `Struct(name)`

Map `Map($name->Type)`

OneOf `OneOf(Type1, Type2, ...)`

Array `Array(Type)`

Variform式

構文例

事前定義関数

条件式

エラー処理

式の例