Metrics

1. Overview

This section displays the definitions of the metrics currently supported by PGOS PrometheusExporter.

2. Metrics

Category	Metric Name	Metric Type	Description	Labels	Label Description
Players	ccu	Gauge	Concurrent users	TitleRegionID	Title Region ID in PGOS
	dau	Gauge	Daily active users
	dnu	Gauge	Daily new users
	login_count	Counter	Login count in the last minute
	new_players_count	Counter	New players count in the last minute
DS Hosting	current_battlesession_count	Gauge	Current battle session count	TitleRegionID FleetID DC BuildID	DC - Data Center
	current_playerbattlesession_count	Gauge	Current player battle session count
	current_machine_count	Gauge	Current machine count
	current_occupied_machine_count	Gauge	Current occupied machine count
	ds_crash_count	Counter	Count of dedicated server crashes in the last minute
	battlesession_placed_time_distribution	Counter	Time cost distribution of battle session placement in the last minute	TitleRegionID FleetID DC BuildID Distribution	Distribution Values: "0_3": Range[0s, 3s) "3_10": Range[3s, 10s) "10_60": Range[10s, 60s) "60_120": Range[60s, 120s) "120_more": Range[120s, ∞)
	battlesession_actived_time_distribution	Counter	Time cost distribution of battle session activation in the last minute
	failed_battlesession_placement_count	Counter	Count of failed battle session placement in the last minute, including battle session statuses of “Failed” and “Timeout”	TitleRegionID FleetID
	machine_cpu_usage_distribution	Gauge	Machine CPU usage distribution	TitleRegionID FleetID DC Distribution	Distribution Values: "percentage_0_20": Usage Range[0%, 20%) "percentage_20_50": Usage Range[20%, 50%) "percentage_50_80": Usage Range[50%, 80%) "percentage_80_100": Usage Range[80%, 100%]
	machine_memory_usage_distribution	Gauge	Machine memory usage distribution
	machine_cpu_usage_avg	Gauge	Average machine CPU usage in the last minute(%)	TitleRegionID FleetID MachineID	Note: You can export these metrics in dev/test regions, but in production region, you can export these machine-related metrics only when the machine load status is overloaded.
	machine_cpu_usage_max	Gauge	Maximum machine CPU usage in the last minute(%)
	machine_cpu_usage_min	Gauge	Minimum machine CPU usage in the last minute(%)
	machine_memory_usage_avg	Gauge	Average machine memory usage in the last minute(%)
	machine_memory_usage_max	Gauge	Maximum machine memory usage in the last minute(%)
	machine_memory_usage_min	Gauge	Minimum machine memory usage in the last minute(%)
	machine_network_traffic_in	Gauge	Inbound network traffic to the machine in the last minute (bytes)
	machine_network_traffic_out	Gauge	Outbound network traffic from the machine in the last minute (bytes)
	machine_network_packet_in	Gauge	The amount of network packets inbound to the machine in the last minute
	machine_network_packet_out	Gauge	The amount of network packets outbound from the machine in the last minute
Matchmaking	matchmaking_request_count	Counter	Request count in the last minute	TitleRegionID Configuration	Configuration - Matchmaking Configuration Name
	matchmaking_result_code_distribution	Counter	Result code distribution of requests in the last minute	TitleRegionID Configuration ResultCode	ResultCode Values: "1": Completed "2": Multiplayer Team Request Canceled "3": Searching Stage Canceled "4": Backfilling Stage Canceled "6": Team Request Timeout "7": Searching Stage Timeout "8": Backfilling Stage Timeout "9": Accepting Stage Timeout "10": Matchmaking Result Rejected "11": Multiplayer Team Request Rejected "12": Title Region Closed "13": Auto Continue Failed "15": BattleSession Placement Failed "16": Matchmaking Engine Internal Failure
	matchmaking_time_cost_distribution	Counter	Time cost distribution of requests in the last minute	TitleRegionID Configuration Distribution	Distribution Values: "0_3": Range[0s, 3s) "3_5": Range[3s, 5s) "5_10": Range[5s, 10s) "10_15": Range[10s, 15s) "15_20": Range[15s, 20s) "20_25": Range[20s, 25s) "25_30": Range[25s, 30s) "30_35": Range[30s, 35s) "35_40": Range[35s, 40s) "40_45": Range[40s, 45s) "45_50": Range[45s, 50s) "50_55": Range[50s, 55s) "55_60": Range[55s, 60s) "60_more": Range[60s, ∞)
Virtual Server	vs_cpu_usage	Gauge	CPU vCores usage	TitleRegionID ServerName Category	Category Values: "avg": average
	vs_memory_usage	Gauge	Memory(MB) usage
	vs_instance_count	Gauge	Instance count		Category Values: "current"
	vs_avg_rtt	Gauge	Average time to process each request in milliseconds	TitleRegionID ServerName	ServerName - Virtual Server Name
	vs_qps	Gauge	Requests processed per second
	vs_ingress_traffic	Counter	Ingress network traffic in the last minute(Bytes)
	vs_egress_traffic	Counter	Egress network traffic in the last minute(Bytes)
	vs_crash_count	Counter	Count of virtual server crashes in the last minute
	vs_url_avg_rtt	Gauge	Average time to process each request in milliseconds	TitleRegionID ServerName URL	URL - URL path in request
	vs_url_qps	Gauge	Requests processed per second
	vs_url_ingress_traffic	Counter	Ingress network traffic in the last minute(Bytes)
	vs_url_egress_traffic	Counter	Egress network traffic in the last minute(Bytes)
	vs_rtt_distribution	Counter	Time cost distribution of requests in the last minute	TitleRegionID ServerName Distribution	Distribution Values: "0_50ms": Range[0ms, 50ms) "50_100ms": Range[50ms, 100ms) "100_200ms": Range[100ms, 200ms) "200_500ms": Range[200ms, 500ms) "500_1000ms": Range[500ms, 1000ms) "1000_3000ms": Range[1000ms, 3000ms) "3000_5000ms": Range[3000ms, 5000ms) "5000_ms": Range[5000ms, ∞)
	vs_status_code_distribution	Counter	Status code distribution of requests in the last minute		Distribution Values: "0xx" / "1xx" / "200" / "2xx" / "3xx" / "4xx" / "5xx"
	vs_url_rtt_distribution	Counter	Time cost distribution of requests in the last minute	TitleRegionID ServerName Distribution URL	URL - URL path in request Distribution values - Same to the metric "vs_rtt_distribution"
	vs_url_status_code_distribution	Counter	Status code distribution of requests in the last minute		Distribution values - Same to the metric "vs_status_code_distribution"
Title Files	title_files_traffic	Counter	Network traffic for each natural hour(Bytes)	TitleID	Title ID in PGOS
PGOS API	api_qps	Gauge	Quantity of invokes PGOS API per second	TitleRegionID Invoker Service	Invoker values: "client": request from game client "server": request from game server or virtual server Service values: "player_management", "social", "chatting", "battle_dshosting", "engagement_staticstics", "economy", "message_bus", "others"
	api_error_count	Counter	Error count of invokes PGOS API in the last minute