{"id":16700940,"url":"https://github.com/armsnyder/a2s-exporter","last_synced_at":"2025-03-21T19:33:07.970Z","repository":{"id":57653054,"uuid":"391525953","full_name":"armsnyder/a2s-exporter","owner":"armsnyder","description":"A Prometheus exporter for Steam game servers","archived":false,"fork":false,"pushed_at":"2024-11-01T12:03:48.000Z","size":35,"stargazers_count":18,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-18T04:42:44.946Z","etag":null,"topics":["a2s","counter-strike","prometheus","prometheus-exporter","rust-game","rust-server","source-engine","source-server-query","steam","team-fortress-2","valheim","valheim-server","valve","valve-servers"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/armsnyder/a2s-exporter","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/armsnyder.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-01T04:34:28.000Z","updated_at":"2025-01-06T18:49:17.000Z","dependencies_parsed_at":"2024-10-28T11:42:34.777Z","dependency_job_id":null,"html_url":"https://github.com/armsnyder/a2s-exporter","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/armsnyder%2Fa2s-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/armsnyder%2Fa2s-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/armsnyder%2Fa2s-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/armsnyder%2Fa2s-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/armsnyder","download_url":"https://codeload.github.com/armsnyder/a2s-exporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244855705,"owners_count":20521688,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["a2s","counter-strike","prometheus","prometheus-exporter","rust-game","rust-server","source-engine","source-server-query","steam","team-fortress-2","valheim","valheim-server","valve","valve-servers"],"created_at":"2024-10-12T18:26:49.609Z","updated_at":"2025-03-21T19:33:07.615Z","avatar_url":"https://github.com/armsnyder.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![CI](https://github.com/armsnyder/a2s-exporter/actions/workflows/ci.yaml/badge.svg)](https://github.com/armsnyder/a2s-exporter/actions/workflows/ci.yaml)\n\n# [A2S Exporter](https://github.com/armsnyder/a2s-exporter)\n\nA Prometheus exporter for Steam game server info.\n\nSupports all Steam game servers which speak the UDP-based A2S query protocol, for example:\n\n* Counter-Strike\n* The Forest\n* Rust\n* Team Fortress 2\n* Valheim\n\n## Usage\n\nThe image is hosted on Docker Hub. ([Link](https://hub.docker.com/r/armsnyder/a2s-exporter))\n\n```\ndocker run --rm -p 9841:9841 armsnyder/a2s-exporter --address myserver.example.com:12345\n```\n\n### Arguments\n\nArguments may be provided using commandline flags or environment variables.\n\n#### Required\n\nFlag | Variable | Help\n--- | --- | ---\n--address | A2S_EXPORTER_QUERY_ADDRESS | Address of the A2S query server as host:port (This is a separate port from the main server port).\n\n#### Optional\n\nFlag | Variable | Default | Help\n--- | --- | --- | ---\n--port | A2S_EXPORTER_PORT | 9841 | Port for the metrics exporter.\n--path | A2S_EXPORTER_PATH | /metrics | Path for the metrics exporter.\n--namespace | A2S_EXPORTER_NAMESPACE | a2s | Namespace prefix for all exported a2s metrics.\n--exclude-player-metrics | A2S_EXPORTER_EXCLUDE_PLAYER_METRICS | false | If true, exclude all `player_*` metrics. This option may be necessary for some servers.\n--a2s-only-metrics | A2S_EXPORTER_A2S_ONLY_METRICS | false | If true, excludes Go runtime and promhttp metrics.\n--max-packet-size | A2S_EXPORTER_MAX_PACKET_SIZE | 1400 | Advanced option to set a non-standard max packet size of the A2S query server.\n\n#### Special\n\nFlag | Help\n--- | ---\n-h | Show help.\n--version | Show build version.\n\n## Exported Metrics\n\nMetrics names are prefixed with a namespace (default `a2s_`).\n\nName | Help | Labels\n--- | --- | ---\nplayer_count | Total number of connected players. | server_name\nplayer_duration | Time (in seconds) player has been connected to the server. | server_name player_name player_index\nplayer_info | Non-numerical player info, including player_name and player_index. The value is 1, and the info is in the labels. | server_name player_name player_index\nplayer_score | Player's score (usually \\\"frags\\\" or \\\"kills\\\"). | server_name player_name player_index\nplayer_the_ship_deaths | Player's deaths in a The Ship server. | server_name player_name player_index\nplayer_the_ship_money | Player's money in a The Ship server. | server_name player_name player_index\nplayer_up | Was the last player info query successful. |\nserver_bots | Number of bots on the server. | server_name\nserver_info | Non-numerical server info, including server_steam_id and version. The value is 1, and info is in the labels. | server_name map folder game server_type server_os version server_id keywords server_game_id server_steam_id the_ship_mode source_tv_name\nserver_max_players | Maximum number of players the server reports it can hold. | server_name\nserver_players | Number of players on the server. | server_name\nserver_port | The server's game port number. | server_name\nserver_protocol | Protocol version used by the server. | server_name\nserver_source_tv_port | Spectator port number for SourceTV. | server_name\nserver_the_ship_duration | Time (in seconds) before a player is arrested while being witnessed in a The Ship server. | server_name\nserver_the_ship_witnesses | The number of witnesses necessary to have a player arrested in a The Ship server. | server_name\nserver_up | Was the last server info query successful. |\nserver_vac | Specifies whether the server uses VAC (0 for unsecured, 1 for secured). | server_name\nserver_visibility | Indicates whether the server requires a password (0 for public, 1 for private). | server_name\n\n## Credits\n\nThis exporter depends on [rumblefrog/go-a2s](https://github.com/rumblefrog/go-a2s) (MIT). Big thanks to them!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farmsnyder%2Fa2s-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farmsnyder%2Fa2s-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farmsnyder%2Fa2s-exporter/lists"}