VmStartupScript is a new feature for Azure PlayFab Multiplayer Servers (MPS) that allows you to customize each Virtual Machine that will host your game servers. Feature is currently in preview, you can see the docs here.
This repository aims to include script files and relevant instructions (recipes) about integration of various popular open source utilities and services with MPS. Repository is open to contributions!
A lot of these samples require an Azure subscription, click here to get started with the free offering.
| Link | Description |
|---|---|
| Linux New Script Template | You should use this script to get started with using the feature in Linux VMs. |
| Linux metrics and/or logs with Telegraf and PlayFab | This script installs and configures Telegraf to send VM performance metrics (CPU/memory/disk/network) and/or container logs to PlayFab. |
| Linux logs and/or metrics with Telegraf and Azure Data Explorer (Kusto) | This script installs and configures Telegraf to capture real-time logs and VM performance metrics from your game servers and send them to Azure Data Explorer (Kusto). |
| Linux metrics with Telegraf and Azure Monitor | This script installs and configures Telegraf to send VM performance metrics (CPU/memory/disk/network) to Azure Monitor. |
| Linux logs with Fluent Bit and Azure Data Explorer (Kusto) | This script installs and configures Fluent Bit to capture real-time logs from your game servers and send them to Azure Data Explorer (Kusto). |
| Linux logs with Fluent Bit and Azure Blob Storage | This script installs and configures Fluent Bit to capture real-time logs from your game servers and send them to Azure Blob Storage. |
| Linux custom game server metrics | This script shows you how to send metrics from your game server to Telegraf and then to the backend of your choice |
| Link | Description |
|---|---|
| Windows New Script Template | You should use this script to get started with using the feature in Windows VMs. |
| Windows metrics with Telegraf and Azure Monitor | This script installs and configures Telegraf to send VM performance metrics (CPU/memory/disk/network) to Azure Monitor. |
| Windows metrics with Telegraf and Application Insights | This script installs and configures Telegraf to send VM performance metrics (CPU/memory/disk/network) to Application Insights. |
| Windows logs with Telegraf and PlayFab | This script installs and configures Telegraf to grab game server logs and send them to PlayFab. |
| Windows enable optional diagnostics | This script enables sending diagnostic data notify Microsoft of application faults, kernel faults, unresponsive applications, and other application specific problems. |
| Windows custom game server metrics | This script shows you how to send metrics from your game server to Telegraf and then to the backend of your choice |
If you encounter challenges when running the scripts, you can see the instructions here on how to connect to Windows and Linux machines using RDP or SSH. The first thing you should take a look at are the files PF_StartupScriptStdOut.txt and PF_StartupScriptStdErr.txt that contain the script's standard output and standard error streams. These files are located either on D:\ drive on Windows or on /mnt folder on Linux.
Some useful commands if you are interacting with systemd services on Linux:
systemctl status <service>- check the status of a servicejournalctl -u <service>- check the logs of a service. Pressqto exit and space bar to see the next log entries.sudo systemctl stop <service>- stop a servicesudo systemctl start <service>- start a service
Contributions are welcome, we would be more than happy to accept your Pull Requests! Please see the contributing guide for more information.
Support for these scripts is community based via GitHub issues. MPS team does not directly support these scripts which are provided under no warranties of any kind. If you have questions or need help, please open an issue.