Metrics API

Metrics API

Diarkis では、 metrics を取得するためのエンドポイントをデフォルトで用意してあります。

Prometheus に値を入れ、Grafana で可視化したり、JSON 形式で取得して、手元で軽く現在の指標を確認する用途を想定しています。

2秒に1度更新されます。

デフォルトで定義してあるメトリクスの他に、カスタムのメトリクスを追加定義して出力することも可能です。

Endpoint

• $HTTP_ENDPOINT/metrics/prometheus/v/3: Prometheus(https://prometheus.io/) の scraping endpoint を提供しています。

  • curl $HTTP_ENDPOINT/metrics/prometheus/v/3

• $HTTP_ENDPOINT/metrics/json: 同一内容で json 形式のものを返します。

  • curl $HTTP_ENDPOINT/metrics/json

Diarkis でデフォルトで定義されているメトリクス

指標名	説明
Users_UDP_node	UDP サーバーに接続しているユーザー数
Users_TCP_node	TCP サーバーに接続しているユーザー数
UDP_Packets_In_UDP_node	UDP サーバーの受信した UDP パケット数
TCP_Packets_In_TCP_node	TCP サーバーの受信した TCP パケット数
TCP_Packets_Out_TCP_node	TCP サーバーの送信した TCP パケット数
UDP_Packets_Out_UDP_node	UDP サーバーの送信した UDP パケット数
UDP_Packets_In_UDP_node	UDP サーバーの受信した UDP パケット数
Commands_In_UDP_node	UDP サーバーの受信したコマンドの数（一つのパケットに複数コマンドが含まれる可能性があります。)
Commands_In_TCP_node	TCP サーバーの受信したコマンドの数（一つのパケットに複数コマンドが含まれる可能性があります。)
Commands_Out_UDP_node	UDP サーバーがクライアントに向けて、送ったコマンドの数
(一つのパケットに複数コマンドが含まれる可能性があります。)
Commands_Out_TCP_node	TCP サーバー がクライアントに向けて、送ったコマンドの数
(一つのパケットに複数コマンドが含まれる可能性があります。)
RUDP_Retries_UDP_node	UDP サーバーでの RUDP リトライの数
RUDP_Split_In_UDP_node	UDP サーバーで MTU を超えたパケットの受信数
RUDP_Split_Out_UDP_node	UDP サーバーで MTU を超えたパケットの送信数
Mesh_Packets_In_HTTP_node	HTTP サーバーの内部ネットワークでのパケット受信数
Mesh_Packets_In_UDP_node	UDP サーバーの内部ネットワークでのパケット受信数
Mesh_Packets_In_TCP_node	TCP サーバーの内部ネットワークでのパケット受信数
Mesh_Packets_Out_HTTP_node	HTTP サーバーが内部ネットワークで送ったパケット数
Mesh_Packets_Out_UDP_node	UDP サーバーが内部ネットワークで送ったパケット数
Mesh_Packets_Out_TCP_node	TCP サーバーが内部ネットワークで送ったパケット数
Mesh_Retry_UDP_node	UDP サーバーが内部ネットワークでリトライを行った数
Mesh_Retry_TCP_node	TCP サーバーが内部ネットワークでリトライを行った数
Rooms_UDP_node	UDP サーバーにある room の数
Rooms_TCP_node	TCP サーバーにある room の数
Groups_UDP_node	UDP サーバーにある group の数
Groups_TCP_node	TCP サーバーにある group の数
MatchMaker_Search_HTTP_node	HTTP サーバーで行った MatchMaker search の数
MatchMaker_Empty_HTTP_node	HTTP サーバーで行った空 MatchMaker search の数
MatchMaker_Ticket_UDP_node	UDP サーバーにある MatchMaker ticket の数
MatchMaker_Ticket_TCP_node	TCP サーバーにある MatchMaker ticket の数
MatchMaker_Ticket_Search_UDP_node	UDP サーバーで発行した MatchMaker search の数
MatchMaker_Ticket_Search_TCP_node	TCP サーバーで発行したMatchMaker search の数
MatchMaker_Ticket_Add_UDP_node	UDP サーバーで発行した MatchMaker ticket 由来の search の数
MatchMaker_Ticket_Add_TCP_node	TCP サーバーで発行した MatchMaker ticket 由来の search の数
MatchMaker_Complete_UDP_node	UDP サーバーで完了した MatchMaker ticket の数
MatchMaker_Complete_TCP_node	UDP サーバーで完了した MatchMaker ticket の数
MatchMaker_Ticket_Complete_Time_Avg_UDP_node	UDP サーバーで MatchMaker ticket 完了までかかった平均時間
MatchMaker_Ticket_Complete_Time_Avg_TCP_node	TCP サーバーで MatchMaker 完了までかかった平均時間
MatchMaker_Ticket_Complete_Time_Min_UDP_node	UDP サーバーで MatchMaker ticket 完了までかかった最小時間
MatchMaker_Ticket_Complete_Time_Min_TCP_node	TCP サーバーで MatchMaker ticket 完了までかかった最小時間
MatchMaker_Ticket_Complete_Time_Max_UDP_node	UDP サーバーで MatchMaker ticket 完了までかかった最大時間
MatchMaker_Ticket_Complete_Time_Max_TCP_node	TCP サーバーで MatchMaker ticket 完了までかかった最大時間
P2P_Success_UDP_node	P2P が成功した回数
P2P_Attempt_UDP_node	P2P を試みた回数
Field_Grids_UDP_node	UDP サーバーで持っているField grid 数
Field_Grids_TCP_node	TCP サーバーで持っている Field grid 数

Prometheus 設定方法

#TODO

Custom Metrics 設定方法