LogoLogo
English
English
  • Diarkis Help Center
  • Overview of Diarkis
  • Getting Started
    • Diarkis Server Template
    • Diarkis Client SDK
    • Tutorials
      • 1. Launch Diarkis Server in Local Environment
      • 2. Perform Connectivity Check with Test Client
      • 3. Implement Custom Command
      • Connect to Server from Diarkis Client
    • Samples
  • Diarkis Modules
    • Room Module
      • Set Up Room Module on Server
      • Room Sample
        • room_broadcast
      • Utilizing Room Module from Client
      • Additional Features of Room
    • MatchMaker Module
      • Set Up MatchMaker Module on Server
    • Field Module
      • Set Up Field Module on Server
    • P2P Module
      • Set Up P2P Module on Server
      • P2P Sample
    • DM (Direct Message) Module
      • Set Up DM Module on Server
    • Notifier Module
      • Set Up Notifier Module on Server
    • Session Module
      • Set Up Session Module on Server
    • Group Module
      • Set Up Group Module on Server
  • Diarkis Server
    • Launch Diarkis Server in Cloud Environment
      • AWS
    • Launch Diarkis Server on Windows Environment
    • MARS Server
    • UDP Server
    • TCP Server
    • HTTP Server
    • Metrics API
    • Inter-server Communication - Mesh
  • Diarkis Client
    • Runtime Library
      • Diarkis RUDP
    • Diarkis Module
      • Initialization and Termination of Diarkis Module
      • Customization of Diarkis Module
      • Logging System of Diarkis Module
      • Migration
      • Threads of Diarkis
    • Samples
      • C++
        • room_broadcast
        • directmessage_simple
        • group_sample
        • matching_and_turn
        • matchmaker_ticket
        • p2p_rudp_sample
        • session_simple
      • Unreal Engine Plugin
        • FieldWalker
      • Unity Plugin
        • FieldWalker
          • HowToReplicatePosition.md
  • Diarkis Tools
    • Diarkis CLI
      • Procedures to Switch to Diarkis CLI v3
  • References
    • API Reference
    • Release Notes
      • v1.0
      • v1.0.1
      • v1.0.2
      • v1.0.3
      • v1.0.4
      • v1.0.5
      • v1.0.6
  • Support
    • License and Billing
Powered by GitBook
On this page
  • Metrics API
  • Endpoint
  • Metrics Defined by Default in Diarkis
  • Prometheus Setup Instructions
  • Custom Metrics Setup Instructions

Was this helpful?

  1. Diarkis Server

Metrics API

PreviousHTTP ServerNextInter-server Communication - Mesh

Last updated 1 month ago

Was this helpful?

Metrics API

Diarkis provides a default endpoint to obtain metrics.

It is designed to feed values into Prometheus for visualization with Grafana, or to obtain JSON format data for a quick check of current indicators locally.

The metrics are updated every 2 seconds.

In addition to the default metrics, you can also define and output custom metrics.

Endpoint

  • $HTTP_ENDPOINT/metrics/prometheus/v/3: Provides a scraping endpoint for Prometheus ().

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

  • $HTTP_ENDPOINT/metrics/json: Returns the same content in JSON format.

    • curl $HTTP_ENDPOINT/metrics/json

Metrics Defined by Default in Diarkis

Indicator Name
Description

Users_UDP_node

Number of users connected to the UDP server

Users_TCP_node

Number of users connected to the TCP server

UDP_Packets_In_UDP_node

Number of UDP packets received by the UDP server

TCP_Packets_In_TCP_node

Number of TCP packets received by the TCP server

TCP_Packets_Out_TCP_node

Number of TCP packets sent by the TCP server

UDP_Packets_Out_UDP_node

Number of UDP packets sent by the UDP server

UDP_Packets_In_UDP_node

Number of UDP packets received by the UDP server

Commands_In_UDP_node

Number of commands received by the UDP server (A single packet can contain multiple commands.)

Commands_In_TCP_node

Number of commands received by the TCP server (A single packet can contain multiple commands.)

Commands_Out_UDP_node

Number of commands sent by the UDP server to clients (A single packet can contain multiple commands.)

Commands_Out_TCP_node

Number of commands sent by the TCP server to clients (A single packet can contain multiple commands.)

RUDP_Retries_UDP_node

Number of RUDP retries on the UDP server

RUDP_Split_In_UDP_node

Number of packets received by the UDP server that exceed MTU

RUDP_Split_Out_UDP_node

Number of packets sent by the UDP server that exceed MTU

Mesh_Packets_In_HTTP_node

Number of packets received in the internal network by the HTTP server

Mesh_Packets_In_UDP_node

Number of packets received in the internal network by the UDP server

Mesh_Packets_In_TCP_node

Number of packets received in the internal network by the TCP server

Mesh_Packets_Out_HTTP_node

Number of packets sent in the internal network by the HTTP server

Mesh_Packets_Out_UDP_node

Number of packets sent in the internal network by the UDP server

Mesh_Packets_Out_TCP_node

Number of packets sent in the internal network by the TCP server

Mesh_Retry_UDP_node

Number of retries in the internal network by the UDP server

Mesh_Retry_TCP_node

Number of retries in the internal network by the TCP server

Rooms_UDP_node

Number of rooms in the UDP server

Rooms_TCP_node

Number of rooms in the TCP server

Groups_UDP_node

Number of groups in the UDP server

Groups_TCP_node

Number of groups in the TCP server

MatchMaker_Search_HTTP_node

Number of MatchMaker searches performed by the HTTP server

MatchMaker_Empty_HTTP_node

Number of empty MatchMaker searches performed by the HTTP server

MatchMaker_Ticket_UDP_node

Number of MatchMaker tickets in the UDP server

MatchMaker_Ticket_TCP_node

Number of MatchMaker tickets in the TCP server

MatchMaker_Ticket_Search_UDP_node

Number of MatchMaker searches issued by the UDP server

MatchMaker_Ticket_Search_TCP_node

Number of MatchMaker searches issued by the TCP server

MatchMaker_Ticket_Add_UDP_node

Number of searches originating from MatchMaker tickets issued by the UDP server

MatchMaker_Ticket_Add_TCP_node

Number of searches originating from MatchMaker tickets issued by the TCP server

MatchMaker_Complete_UDP_node

Number of MatchMaker tickets completed by the UDP server

MatchMaker_Complete_TCP_node

Number of MatchMaker tickets completed by the TCP server

MatchMaker_Ticket_Complete_Time_Avg_UDP_node

Average time taken to complete MatchMaker tickets in the UDP server

MatchMaker_Ticket_Complete_Time_Avg_TCP_node

Average time taken to complete MatchMaker in the TCP server

MatchMaker_Ticket_Complete_Time_Min_UDP_node

Minimum time taken to complete MatchMaker tickets in the UDP server

MatchMaker_Ticket_Complete_Time_Min_TCP_node

Minimum time taken to complete MatchMaker tickets in the TCP server

MatchMaker_Ticket_Complete_Time_Max_UDP_node

Maximum time taken to complete MatchMaker tickets in the UDP server

MatchMaker_Ticket_Complete_Time_Max_TCP_node

Maximum time taken to complete MatchMaker tickets in the TCP server

P2P_Success_UDP_node

Number of successful P2P attempts

P2P_Attempt_UDP_node

Number of P2P attempts

Field_Grids_UDP_node

Number of Field grids held by the UDP server

Field_Grids_TCP_node

Number of Field grids held by the TCP server

Prometheus Setup Instructions

#TODO

Custom Metrics Setup Instructions

https://prometheus.io/