MonitoringPlugin ja JP
MonitoringPlugin は公式 ASF プラグイン であり、Prometheus 時系列データベースを介して ASF プロセスを監視できます。
表示
技術的な制約 により、このプラグインには ASF の generic バリアントが必要です。
ASFにはデフォルトでバンドルされているMonitoringPluginは付属していませんが、すべてのASFリリースでオプションの追加として含まれています。 あなたのASFバージョンに一致する公式**[release]（https://github.com/JustArchiNET/ArchiSteamFarm/releases/latest）\*\*からプラグインをダウンロードし、専用の\`plugins/ArchiSteamFarmを作成します。 プラグインの fficialPlugins.Monitoring` ディレクトリを作成し、最後にアーカイブを抽出します。
次回のASF起動時に、ログはプラグインが標準のASFロギングメカニズムを介して正常にロードされたことを示します。 IPCインターフェースで/Api/metrics URLに移動して確認することもできます。 IPCパスワードを使用している場合は、/Api/metricsのURLに?password=<YourIPCPassword>を追加するなど、適切な認証が必要です。 表示されるコンテンツは以下のようになります:
# TYPE asf_build_info gauge
# HELP asf_build_info Build information about ASF in form of label values
asf_build_info{variant="source",version="6.0.2.5"} 1 1713715703686
# TYPE asf_runtime_info gauge
# HELP asf_runtime_info Runtime information about ASF in form of label values
asf_runtime_info{framework=".NET 8.0.4",operating_system="Debian GNU/Linux trixie/sid",runtime="linux-x64"} 1 1713715703686
(...)
ASFとボットに関するメトリックには専用のプレフィックス「asf_」があります。 .NETランタイムやASFのHttpClientに関するその他のメトリックは、ユニバーサル.NETプロセスのルールに基づいて自動的に生成され、そのようなプレフィックスはありません。
プラグインが正しく動作していることを確認したら、以下のように Prometheus インスタンスにスクラップ設定を追加できます。
scrape_configs:
- job_name: ArchiSteamFarm
metric_name_escaping_scheme: underscores # Prometheus V2.x を使用している場合は削除 - 詳細は以下を参照
metrics_path: /Api/metrics
params:
password:
- YourIPCPassword
static_configs:
- targets:
- 127.0.0.1:1242もちろん、ホストされている**Prometheus**インスタンスがASFのIPCインターフェースに到達できるようにする必要があります。 あなたの使用に応じて、password と targets を適応させます。 IPCパスワードが設定されていない場合 (これは推奨されません)、params セクションの追加は省略できます。 異なるIPCパスワードを持つ複数のASFインスタンスを実行している場合は、追加のスクレイプ構成を追加できます。 クエリパラメータをターゲットごとに設定することはできません。 そうでなければ、同じパスワードを共有している場合は、複数の targets を宣言できます。
プロメテウスによってメトリックが収集されると、Grafana を視覚化することができます。 プラグインには /grafana-ダッシュボードが付属しています。 標準的なIPCメカニズムによって提供されるsonファイルなので、デフォルト設定でASFインスタンスを実行していると仮定します。 here をダウンロードできます。 あるいは、repository から JSON ファイルを取得することもできます。
ASFは、V6.3.8.4以降のさまざまなメトリックエスケープスキームをサポートし、**#3607**の一部として、V6.3.9.4から始まる完全なソリューションを備えています。
残念ながら、Grafana ダッシュボードに関しては問題が発生します。 プロメテウスが解析するように正確なメトリック名が必要だからです ソフトウェアはV2を使うかどうかに応じてデフォルトで2つの方法で動作します または V3.x バージョン。 詳細は UTF-8 Prometheus docs を参照してください。
Prometheus V3.xが広く採用されるのを待っている間(現在のガイドラインとしてdebian stable があります)、レガシーアプローチをお勧めします。
- Grafana ダッシュボードにはデフォルトでアンダースコア名が付いており、Prometheus
V2.xで認識されています。 - Prometheus
V3.xを使用する場合は、ASFスクレイプ設定の一部としてmetric_name_escaping_scheme: underscoresを使用してください
なぜなら、Prometheus V3.xは従来のアプローチを使うように簡単に設定できますが、Prometheus `V2。 ' は、新しいものを強制的に使用するジョブ固有のオプションがありません。
将来的には、Grafana ダッシュボードをリファクタリングして、新しい推奨されるデフォルトを使用するようにし、設定は不要になります。 今日、それを行うことは、保証されていない古いPrometheusユーザーにとって問題を引き起こすでしょう。
もちろん、ASF自体のプラグインは、すべての異なるフォーマットオプションをサポートしています。 好きなものをいつでも選んで、Grafanaダッシュボードを自分で調整することができます。シンプルなワンライン設定変更のおすすめで簡単になります。
