Metrics Collection


These docs were written for SpongeAPI 7 and are likely out of date. If you feel like you can help update them, please submit a PR!

Collection of metrics from servers that use your plugin can be an incredibly useful tool for knowing what direction to take your plugin in. However, the 鉱石プラグイン提出に関するガイドライン (under External Connections) state that plugins may only collect metrics if informed consent has been granted. Such consent must be opt-in, metrics collection must be off by default.

To simplify gathering consent, Sponge provides an API that allow plugins to check for this consent in a central way.

Metrics collection consent is on a per-plugin basis. Plugins must not assume that consent for one plugin means consent for all.