Skip to content
Essentials
The plugins Docs Sign in

Essentials Insights

Open Essentials Insights Last changed November 9, 2026

Essentials Insights keeps a history of what every server on your Pelican panel uses: CPU, memory, disk and, where it can be counted, players. Pelican's console only shows what a server uses right now; this module takes a sample every five minutes, so questions like "was it slow last night" or "which servers have outgrown their plan" have an answer. Server owners get charts on a new Insights page inside each server, and administrators get one overview of every server's average and peak use.

At a glance

Plugin ID essentials-insights
Current version 0.0.3
Pelican Panel 1.0 (tested on 1.0.0-rc.2)
Needs The scheduler, for the samples every five minutes and the daily clean-up. No queue work of its own and no frontend build. Works on MySQL, MariaDB, PostgreSQL and SQLite.
Works with (optional) Essentials Core, Essentials Game Manager (player counts)
Adds Admin area, sidebar group Essentials Insights: page Server insights (/admin/essentials-insights). Inside every server: page Insights (/server/<id>/insights). One database table, essentials_insights_samples.
Permissions Role editor section Essentials Insights: view (open the overview) and update (change the settings). A server's Insights page follows Pelican's console permission on that server.

Before you install

  • The scheduler (a cron job that runs Pelican's timed tasks every minute). Pelican itself needs it, so it is usually there already. Without it no samples are taken at all. The entry for the web user is:

    * * * * * php /var/www/pelican/artisan schedule:run >> /dev/null 2>&1
    

    Add it with sudo crontab -e -u www-data. The examples on this page assume Pelican is in /var/www/pelican and the web server user is www-data (Debian/Ubuntu). On another setup, adapt the path and the user (for example nginx on some systems).

  • If you want player counts: Essentials Game Manager, set up to count players for the servers you care about. Without it everything else works and there is simply no player chart.

  • Pelican Panel 1.0. Pelican 1.0.0-rc.2 itself needs PHP 8.4 or 8.5.

  • The queue worker (Pelican's background worker, usually the systemd service pelican-queue) if you install from the admin area, because installs started there run in the background. Check it with systemctl status pelican-queue.

  • Not the legacy all-in-one "Essentials" plugin (plugin id essentials) on the same panel. The all-in-one never kept a history, so there is nothing to take over, but it must not run beside any essentials-* module. See "Things to watch out for".

  • Essentials Core is optional. With Core installed this module appears in Core's module list on the Essentials page, with its switches in the Parts window and its health notes. Without Core it works on its own.

Installing

Download the plugin from the Essentials website, https://essentialsplugins.nl: sign in, open the catalogue, pick Essentials Insights and a version, and download the zip. x.y.z is a stable release, x.y.z-beta a test release and x.y.z-dev a development build. Use stable on a live panel.

Then install it one of these ways. The first is the easiest.

  1. From the admin area. Go to Admin -> Plugins -> Import from File and choose the zip. The plugin appears in the list; press Install. Pelican says "Plugin install started in the background". Refresh after a minute until the plugin shows Enabled. (Pelican also has Import from URL.)

  2. From the Essentials website. Connect your panel on the website with a Pelican application key. You make that key on the panel under Admin -> API keys, with read and write on Plugins; it starts with papp_. Then press Install on the plugin's page on the website.

  3. With the Essentials Auto Updater. If that plugin is installed, its Plugin updates page offers Essentials modules that are not installed yet.

  4. From the command line (advanced).

    cd /var/www/pelican
    sudo unzip essentials-insights-x.y.z.zip -d plugins/
    sudo chown -R www-data:www-data plugins/essentials-insights
    sudo -u www-data php artisan p:plugin:install essentials-insights
    sudo -u www-data php artisan p:plugin:list
    

    The folder must be exactly plugins/essentials-insights. The list must show the plugin as enabled. Unzipping over an existing plugin folder resets it to "not installed" (its status is kept in its own plugin.json), so always run the install command again after unzipping.

The install runs one migration, which creates the table essentials_insights_samples. Both parts (Resource history and Player history) are switched on straight away, and the first sample is taken within five minutes, on the next run of the scheduler.

After every install:

  • The plugin clears Pelican's route and view caches and asks the queue worker to restart. If a new page answers 404 or an old version still shows, reload PHP-FPM (sudo systemctl reload php8.4-fpm, use your PHP version) and restart the worker (sudo systemctl restart pelican-queue).
  • Run artisan, yarn and file commands as the web user (sudo -u www-data ...), never as root. Files created by root cause errors and failed updates later.

First-time setup

  1. Give your staff roles the permissions: Admin -> Roles, open a role, section Essentials Insights. Tick view for people who may open the overview, update for people who may change the settings. Root Admins have both already.
  2. Open the Admin area, sidebar group Essentials Insights, page Server insights. The line above the table says how recording is going:
    • "No samples yet. The first is taken within five minutes of recording being switched on." right after installing.
    • "Sampling every five minutes. Last sample ..." once it works.
    • "No resource sample for ... minutes." if the scheduler has stopped (see Troubleshooting).
  3. Press Settings at the top of the page (only shown with update) and check:
    1. Resource history: takes the samples. On by default.
    2. Player history: also records the player count, for servers Essentials Game Manager can count. On by default; it does nothing without Game Manager.
    3. Keep samples for: 7, 14, 30, 60 or 90 days. 30 days by default. Older samples are removed once a day, at 04:20.
  4. Press Save in that window.
  5. After half an hour or so, open any server and choose Insights in the server's sidebar. Pick a Period (Last 24 hours, Last 7 days or Last 30 days) to see the charts CPU (%), Memory (MiB), Disk (GiB) and, where players have been recorded, Players.

What the overview shows: every server with Average CPU, Peak CPU, Average memory, Peak memory, Memory limit, Peak disk and Peak players over the last 7 days, sorted by average CPU so the busiest servers are at the top. A server without samples shows dashes. Charts on a row opens that server's Insights page.

What the charts show: each point is the average of a slot of 15 minutes (24 hours), one hour (7 days) or four hours (30 days). Disk is the newest figure in the slot and players the highest. A slot without samples is a gap in the line, not a line drawn across it. Times are shown in the reader's own timezone from their account.

Who sees a server's Insights page: everybody who may open that server's console, including subusers with console access, because the console already shows them the same figures live.

Things to watch out for

  • Uninstalling deletes the whole history. The table essentials_insights_samples is dropped when the plugin is uninstalled. Export it first if you want to keep it.
  • Lowering Keep samples for deletes data. At the next clean-up (04:20) every sample older than the new period is removed, and there is no undo.
  • Switching off Resource history stops new samples, not the history. The overview says "Recording is switched off. Nothing new is sampled; what was recorded before is still shown." A server's Insights page stays available while it has recorded samples (from 0.0.2 on; 0.0.1 closed every page); servers without any samples show no page.
  • CPU is a percentage of one core, as on Pelican's console. A server using two full cores shows 200 %.
  • Gaps are on purpose. Suspended, installing, restoring and transferring servers, servers on a node in maintenance and servers whose node did not answer are not recorded at all, rather than recorded as zero. When a node answers slowly with nothing, the rest of that node's servers are skipped until the next sample, so a node that is down shows as a gap for all its servers.
  • Player counts need Essentials Game Manager. Only running servers that Game Manager can count are recorded: Minecraft servers with its live query switched on, and the games whose eggs are ticked for player counts in Game Manager. Other servers never get a player chart.
  • The overview covers every server; the Charts button does not open servers you cannot reach. The Insights page is part of the server's own pages, so an administrator needs access to that server to open it.
  • The legacy all-in-one plugin. "Essentials" (plugin id essentials) is the older plugin that contains what the modules now do separately. Never run it on the same panel as any essentials-* module: installing a module switches the all-in-one off, installing the all-in-one on a panel with modules can switch modules off, and uninstalling the all-in-one deletes database tables the modules share (shop, tickets, API keys). Pick one: the all-in-one, or the modules.

Things to keep an eye on

  • The scheduler. If samples stop arriving for more than fifteen minutes, the overview says "No resource sample for ... minutes. Check that the panel's cron entry for php artisan schedule:run is running." With Essentials Core the same note appears under the module on the Essentials page.
  • Database growth. Every server adds one row every five minutes: 288 rows a day. At 47 servers that is about 13,500 rows a day, and 30 days is roughly 400,000 small rows. A longer Keep samples for or many more servers grows the table in proportion. Include it in your database backups if you care about the history.
  • Time the sampling takes. Each sample asks every server's node for its current figures, the same question the console asks (Pelican keeps the answer for fifteen seconds, so a console somebody has open shares it). On a panel with many servers or slow nodes this takes longer. The next sample never starts while one is still running.
  • Logs. Errors go to storage/logs/laravel-YYYY-MM-DD.log (or laravel.log). Pelican's log viewer reads the whole file, so very large logs (around 100 MB) make it fail; Essentials Core warns above 50 MB.

Updating

Download the new version and import it the same way you installed it (Pelican shows Update on the plugin when an update is known), or let the Essentials Auto Updater do it. The module switches itself back on after an update through the admin area. Your settings and the recorded samples are kept. Make a database backup before updating, since the history lives in a table.

Removing it

Uninstall it under Admin -> Plugins, or from the command line:

cd /var/www/pelican
sudo -u www-data php artisan p:plugin:uninstall essentials-insights --delete

--delete also removes the plugin's files. Uninstalling stops the sampling and drops the table essentials_insights_samples, which holds nothing but this history. The Insights page disappears from every server.

The settings stay behind in storage/app/private/essentials/insights/ (settings.json and a small file that remembers the sidebar order). Delete that folder by hand if you do not plan to reinstall:

sudo rm -r /var/www/pelican/storage/app/private/essentials/insights

Troubleshooting

Problem What to do
"No samples yet" stays for more than ten minutes Check the cron entry for schedule:run (sudo crontab -l -u www-data) and that Resource history is on. Errors are in the log.
"No resource sample for ... minutes" The scheduler stopped running. Check the cron entry and the log.
A server has no Insights page Resource history must be on, and the person needs Pelican's console permission on that server.
Charts on the overview is refused Your account has no access to that server, or Resource history is off and that server has no recorded samples. On 0.0.1, switching Resource history off closed every page: update to 0.0.2 or later.
Gaps in a chart The server was suspended, installing, restoring or being transferred, its node was in maintenance, or the node did not answer. Nothing was measured, so nothing is drawn.
No Players chart Install Essentials Game Manager, make sure it can count that server, and keep Player history on. The chart appears once at least one count has been recorded for the server.
CPU shows more than 100 % Normal: CPU is counted per core, as on the console.
Saving shows "Could not save the settings" The panel cannot write to its storage folder. Make sure storage/app belongs to the web user (sudo chown -R www-data:www-data /var/www/pelican/storage). The reason is in the log.
A new page answers 404 after installing or updating Reload PHP-FPM (sudo systemctl reload php8.4-fpm) and restart the queue worker.

Essentials is a community project by Legend Development. Not affiliated with or endorsed by the Pelican team.

Put Essentials on your home screen

Your browser can install it now. It opens in a window of its own, without the address bar, like any other app.