ErisPulse ErisPulse
インタラクティブ版で開く →
このページのセクション
静的ミラーです。内容はインタラクティブ版が正となります インタラクティブ版で開く →

高級トピック

このディレクトリには、ErisPulseフレームワークの高度なトピックが収録されています。権限管理、グレーディング、複数回の対話、ストレージバックエンドなど、深い機能をカバーし、それぞれの問題を解決します。

Note

本ディレクトリのすべては必要に応じて参照する専門的なドキュメントです。まず、ホームのL1コア5つの記事を読んだ後、対応するニーズが発生したときに参照してください。各記事の冒頭には「この記事を読むべきタイミング」が記載されています。

L2 必読4篇

生産レベルのモジュールを開発する際に避けて通れない4つの記事です。複雑なモジュールを開発する前に、すべてを読むことを推奨します(ドキュメントのホームページと同一の基準)。

  • 作用域(scope) - 3次元の作用域制御:モジュールの可用性 / イベントのアクセス制限 / 出力アクションの制限(メソッドレベルの細かいルールとバインディング継承 merge を含む)
  • 所有権(owner)システム - リソースの所有権と自動回収:ownerコンテキストメカニズム、所有リソースの全体像、アンロード時のクリーンアップシーケンス、ホットリロードの境界と設計境界
  • ライフサイクル管理 - ライフサイクルイベントシステム:モジュール / アダプタのロード、アンロード、リロード、無効化時の処理
  • 対話セッションシステム - wait_reply / セッションタイマー / 多重待ち / セッションの排他リース / 受信箱 / メッセージトランザクション / リンクトレース

シナリオ別のグループ分け

ドキュメントトップページの「原理を深く理解する」と同じグループ分け基準で、各グループの先頭の記事には「理解しないとどんな落とし穴にはまるか」を記載しています。

実行と起動 —— 起動チェーン(Finder / Loader / Manager / Router)を理解していないと、モジュールのロードに失敗した際、ログを前に途方に暮れるしかありません

  • 起動フローと手動制御 - 起動チェーンの分解(Finder/Loader/Manager/Router)と手動による完全起動
  • 遅延ロードシステム - 遅延ロードモジュールシステムの仕組み、設定とイベント駆動の遅延アクティベーション(activate_on)

通信と接続 —— サービス契約(meta.services)のホワイトリストを理解していないと、モジュール間の module.call が ServiceNotProvidedError で拒否されてもその理由が分かりません

  • モジュール間通信 - RPC プロトコル化(module.call)、サービス契約とカタログ、ターゲット指定イベント、コールドスタートリプレイ、イベントの冪等性による重複排除
  • 接続プールとブロードキャスト - 接続レジストリ:ブロードキャスト、グループ購読、モジュール間の受け渡しと再利用、接続プールの表示
  • ルーティングマネージャー - HTTP と WebSocket のルーティング管理(単一パラメータ登録、タプルレスポンス規約を含む)

データストレージ —— 接続失敗時のクールダウン期間のセマンティクスを理解していないと、データベースの不安定時に「フレームワークが落ちた」と誤判定します(実際はフェイルファストで、クールダウン後に自動再接続されます)

メッセージと対話 —— セッションの排他リースを理解していないと、2つのモジュールが同じユーザーの返信を同時に待つと互いに追い出し合います

グレーデリリースとシャドウ —— 5つの隔離ゲートを理解せずに早期に正式化すると、シャドウの送信メッセージが実際のユーザーへ漏れ出ます

パフォーマンスとオブザーバビリティ —— 問題が起きても再起動するだけでメトリクスを確認しないのは、盲目飛行と同じです

  • パフォーマンスベンチマークとチューニング - 実測ベンチマーク数値(NoneBot2 との比較を含む)、ベンチマークの自前実行とリグレッション比較の方法、チューニングのポイント、メモリ診断
  • runtime ツールベルト - ErisPulse.runtime 集約エクスポート層のクイックリファレンス:所有権、バックグラウンドタスク、イベントコンテキスト、メモリスナップショット、dict パース、トラブルシューティング診断

例外と規約リファレンス

Note

Dashboard ウィンドウ登録、Takumi 画像レンダリングなどの サードパーティ製エコシステムモジュール のドキュメントは、エコシステムモジュール ディレクトリに移行しました。

適用対象

以下の開発者向けです:

  • ErisPulseの基本機能に精通している開発者
  • フレームワークの内部メカニズムを深く理解したい開発者
  • パフォーマンスの最適化や複雑な機能の実装が必要な開発者

前提知識

本ディレクトリのドキュメントを読む前に、以下の内容を理解しておくことを推奨します: