Telegraf output plugin for PlayFab

Description

This is an external Telegraf plugin that sends events to PlayFab. Events can be from anything Telegraf lists as an input plugin. You can easily view the events on PlayFab Game Manager Data Explorer with basic mode or advanced mode.

Telegraf agent uses the execd output plugin to launch and emit metrics to this plugin. The plugin itself uses the Write Telemetry Events API to send custom events to PlayFab.

This plugin uses the Go PlayFab SDK. You need to have a PlayFab account and a title to use this plugin.

Usage

This plugin is meant to be used with Telegraf agent, so you should grab the Telegraf binary for your platform and architecture from the Telegraf releases page. You should also download the plugin from this repo's releases page.

On the Telegraf configuration file telegraf.conf you should configure the execd output plugin like this:

[[outputs.execd]]
  command = ["/path/to/telegraftoplayfab", "--config", "/path/to/plugin.conf"]

The plugin.conf file should contain the following:

[[outputs.playfab]]
  titleId = "yourPlayFabTitleId"
  developerSecretKey = "yourDeveloperSecretKey" # https://learn.microsoft.com/en-us/gaming/playfab/gamemanager/secret-key-management
  debug = false # enable it only when debugging as it can be quite verbose

For full configuration instructions, check the sample configuration file.

Building

To build this plugin, run make build.