Content generated with AI — it may contain mistakes.

ExyliaAnalytics/Getting startedUpdated in v1.2.0

Introduction

What ExyliaAnalytics is: the server-side agent of Exylia Analytics, one jar for Paper, Spigot, Folia and Velocity that reports to the dashboard at analytics.exylia.net.

Page 1 of 284 min read

ExyliaAnalytics is the agent of Exylia Analytics, a web dashboard that answers one question about a Minecraft server or network: is it growing or decaying, and why? The agent runs inside your servers and your proxy, watches players joining and leaving, idling, lag, bans, votes, ranks and money moving, and sends it as batches of events to analytics-ingest.exylia.net. The dashboard turns them into charts, cohorts, player profiles and an economy report.

In about ten minutes you can have one server installed, linked and drawing its first charts. The agent has no web server, opens no port and needs no other plugin: everything leaves over HTTPS, and nothing ever connects back in.

Before you start#

You needDetail
Java21, which the loader is built for.
ServerPaper or Spigot 1.17 or newer. Folia is supported with the limits in the FAQ.
ProxyVelocity 3. BungeeCord and Waterfall are not supported as proxies.
NetworkOutgoing HTTPS to analytics-ingest.exylia.net. No incoming port.
AccountA Discord account to sign in to the dashboard.

Plugins such as LuckPerms, LiteBans, Vault or PlaceholderAPI are optional: each is used when present and ignored when not. See Connect other plugins.

Steps#

Install the jar

Put Exylia-Analytics-Loader.jar in plugins/ of the proxy and of every server. Bought on BuiltByBit, the licence is inside the jar: there is no key to enter. See Installation.

Link each server

An unlinked agent prints a code in the console. Type it at analytics.exylia.net/link and approve it into your workspace. The agent collects a token and starts sending. See Connect your server.

Read the dashboard

Charts fill in within a minute. What is collected, how often, and whether a server collects at all is decided from the dashboard, without a restart.

Check that it works#

Your server shows in the dashboard under Servers and its Overview starts to fill. /analytics status (or /analyticsv status on Velocity) in the console tells you the same from the server side. If not, see Common problems.

Going further#

Two halves#

Where it runsWhat it does
The agentYour proxy and your servers, as a pluginCollects events, keeps them on disk until they are delivered, and takes its settings from the dashboard.
The dashboardhttps://analytics.exylia.net, in the browserSigns you in with Discord, holds your workspace (one network), links servers to it and draws every chart.

One jar, three roles#

The same loader jar goes on a Velocity proxy and on a Paper or Spigot server. Each install is one server in the dashboard, and each plays one of three roles:

RoleWhat it isWhat it reports
proxyA Velocity proxy.The network session: who connected, from which address and hostname, with which client, and which backend they moved to. Heartbeats, proxy CPU and memory, the proxy's server list.
backendA Paper/Spigot server behind a proxy.Presence: who was on this server, for how long, how much of it AFK, and what they did there. TPS, MSPT, entities and chunks. Economy and PlaceholderAPI values.
standaloneA Paper/Spigot server players join directly.Both of the above: it owns the network session and the presence.

The role is detected on start and can be forced in config.yml; see Installation.

What it reports, and from where
AreaSource
Sessions, hostnames, client brand, language, protocol versionThe server itself; ViaVersion for the client version on a standalone Paper server.
Java or BedrockFloodgate, or the shape of the player's UUID.
AFK time and activity counters (chat, commands, deaths, player kills, advancements)The server itself. Counts only, never content.
TPS, MSPT, CPU, memory, entities, chunks, uptime, restarts, crashesThe server itself.
PunishmentsLiteBans, LibertyBans or AdvancedBan.
VotesNuVotifier (or classic Votifier on Paper).
Rank changes and the primary groupLuckPerms.
Any value a placeholder showsPlaceholderAPI, for the placeholders you list.
Money created, destroyed and heldExyliaLib, Vault, VaultUnlocked, PlayerPoints, ExcellentEconomy and any plugin calling the API.
Earlier play dates and lifetime playtimeThe server's own player files, read once after linking.
Anticheat flagsVulcan, Grim, Matrix, Spartan, Intave or LightAntiCheat.
Linked Discord accountsDiscordSRV or EssentialsX Discord Link.
Market trades and listingsMarket plugins, through ExyliaAnalytics.trade(...).
Your own eventsOther plugins, through ExyliaAnalytics.track(...).

The full list, event by event, is in Collected data; what never leaves the server is in Privacy.

Something missing on this page? Tell us on Discord