FASTPANELWIKI

Можливості Extended

Prometheus

На цій сторінці
інформація

FASTPANEL Extended доступна всім користувачам за замовчуванням. Активувати ліцензію не потрібно.

Інтеграція FASTPANEL з Prometheus для збору метрик

FASTPANEL® тепер підтримує інтеграцію з Prometheus для збору системних метрик. Цей посібник проведе вас через кроки, необхідні для додавання вашого екземпляра FASTPANEL® до Prometheus, що дозволить вам збирати та відстежувати системні метрики в реальному часі.

Створіть токен

Щоб дозволити Prometheus збирати метрики, вам потрібно створити спеціальний токен з обмеженим доступом:

  1. Підключіться до вашого сервера FASTPANEL® через SSH.

  2. Виконайте таку команду, щоб створити токен:

mogwai users tokens add -n metrics_test_token -s read_only -s metrics_only
  • metrics_test_token — це користувацька назва токена; ви можете вибрати будь-яку назву
  • Токену буде надано такі області доступу:
    • read_only — доступ лише для читання
    • metrics_only — доступ, обмежений метриками

Додайте job до Prometheus

Після створення токена вам потрібно налаштувати Prometheus, щоб він почав збирати метрики з вашого екземпляра FASTPANEL®.

Відкрийте файл конфігурації Prometheus і додайте новий job:

- job_name: "fastpanel2"
  scheme: https
  static_configs:
    - targets: ["$IP:8888"]
  metrics_path: /api/metrics
  tls_config:
    insecure_skip_verify: true
  bearer_token: I_AM_TOKEN
  scrape_interval: 60s
  • job_name — користувацька назва job
  • targets — IP-адреса та порт вашого сервера FASTPANEL®. Замініть $IP на IP-адресу вашого сервера
  • metrics_path — кінцева точка API, з якої отримуються метрики
  • bearer_token — замініть це на ваш згенерований токен (metrics_test_token)
  • scrape_interval — як часто Prometheus має збирати метрики (у цьому випадку встановлено 60 секунд)

Налаштуйте панель моніторингу

Після успішного додавання вашого екземпляра FASTPANEL® до Prometheus ви можете налаштувати свою першу панель для візуалізації зібраних метрик.

Щоб імпортувати панель, будь ласка, дотримуйтеся цього посібника.

Тепер Prometheus почне збирати метрики з вашого екземпляра FASTPANEL®, що дозволить вам відстежувати продуктивність системи в реальному часі.

Налаштування брендування

На цій сторінці

Розділ Branding у FASTPANEL® дозволяє налаштувати візуальний вигляд і стиль панелі керування. Це меню розташоване в "Settings" → "Main" → "Branding".

Кольорові схеми

Перейдіть на вкладку "Color schemes", щоб змінити основну кольорову тему панелі. Виберіть одну з різноманітних попередньо визначених кольорових палітр (наприклад, синю, помаранчеву, червону, зелену).

Налаштуйте Theme:

  • Light: Використовуйте світлу тему
  • Dark: Перемкніться на темний режим
  • Like on the device: Автоматично адаптується до налаштувань пристрою користувача

Налаштування логотипа

Вкладка "Logo" дає змогу завантажити власний логотип для різних областей панелі.

Login Screen
Для тем Light і Dark можна завантажити окремі логотипи.
Використовуйте кнопку Upload, щоб додати новий логотип, або Reset, щоб повернути значення за замовчуванням.

  • Підтримувані формати: jpeg, png, svg, webp
  • Максимальна роздільна здатність: 256x100 пікселів
  • Максимальний розмір файлу: 5 MB

Header Logo
Відображається в заголовку панелі керування.

  • Підтримувані формати: jpeg, png, svg, webp
  • Максимальна роздільна здатність: 200x22 пікселів
  • Максимальний розмір файлу: 5 MB

Налаштування favicon

Вкладка "Favicon" дає змогу завантажити favicon, який відображається на вкладках браузера та в результатах пошуку.
Використовуйте кнопку Upload, щоб додати favicon, або Reset, щоб повернути значення за замовчуванням.

  • Підтримуваний формат: ico
  • Максимальний розмір файлу: 1 MB

Налаштування посилань

Вкладка "Links" надає поля для налаштування посилань у бічному меню.

  • Knowledge base: URL для доступу до бази знань

Після зміни посилань натисніть Save, щоб застосувати зміни.

Node.js

На цій сторінці
інформація

FASTPANEL Extended доступна всім користувачам за замовчуванням. Активувати ліцензію не потрібно.

Вступ

Node.js — це серверна платформа, яка запускає застосунки, написані на JavaScript.

Спочатку потрібно встановити Node.js:

  • Перейдіть до "Налаштування" -> "Застосунки"
  • Натисніть кнопку "Встановити" для потрібної версії Node.js

Створіть вебсайт:

  • Виберіть шаблон для вебсайту Node.js
  • Укажіть домен і пов’язані параметри. На етапі налаштування ви можете змінити БД, користувача FTP і Backend
  • Завантажте файли застосунку до каталогу вебсайту
  • Щоб установити залежності, виконайте npm20.15.1 install у Terminal (потрібно встановити застосунок ttyd для FASTPANEL®)
  • Перезапустіть Node.js, перейшовши до картки сайту, а потім відкривши розділ "Сервіси".

Фреймворк Express

На прикладі фреймворку Express створімо простий вебсервер:

  • Підключіться до сервера через SSH як користувач, якому належить сайт (можна використовувати застосунок ttyd для FASTPANEL®)
  • Створіть файл app.js у каталозі вебсайту та додайте до нього такий код:
const express = require('express');
const app = express();
const PORT = process.env.SERVICE_PORT;

app.get('/', (req, res) => {
  res.send('Hello! This is my first server on Node.js + Express 🚀');
});

app.listen(PORT, () => {
  console.log(`Server is running at http://localhost:${PORT}`);
});
  • У каталозі вебсайту виконайте команду для встановлення express
npm20.15.1 install express
  • Перейдіть до картки сайту, потім до розділу Сервіси
  • Перезапустіть сервіс
  • Перевірте вебсайт

Docusaurus

На прикладі вебзастосунку Docusaurus налаштуймо параметри:

  • Підключіться до сервера через SSH як користувач, якому належить сайт (можна використовувати застосунок ttyd для FASTPANEL®)
  • У каталозі вебсайту запустіть встановлення Docusaurus
npx20.15.1 create-docusaurus -j ./docs
  • Коли буде запропоновано вибрати шаблон, вкажіть classic (recommended)

  • Після встановлення замініть один рядок у файлі docs/package.json

"start": "docusaurus start",
# replace with 
"start": "docusaurus start --port $SERVICE_PORT",

$SERVICE_PORT — це системна змінна, задана в FASTPANEL®

  • У панелі керування перейдіть до "налаштування сайту" -> "Backend"

  • Виберіть обробник Standalone або PM2.

  • Виберіть потрібну версію Node.js.

  • Укажіть робочу папку docs

  • У полі команди запуску введіть: npm run start

  • Збережіть. Дочекайтеся компіляції застосунку (інформація з’явиться в логах). Перевірте вебсайт

Next.js

Використовуючи Next.js з Node.js 20.19 як приклад, створімо простий вебсервер:

  • Підключіться до сервера через SSH як користувач, якому належить вебсайт (ви також можете використовувати застосунок ttyd у FASTPANEL®).
  • У каталозі вебсайту виконайте команду ініціалізації проєкту:
yarn20.19.4 init -y
yarn20.19.4 add next react react-dom
  • Додайте блок scripts до файлу package.json:
"scripts": {
  "dev": "next dev -p $SERVICE_PORT",
  "build": "next build",
  "start": "next start -p $SERVICE_PORT"
}
  • Створіть каталог pages і всередині нього додайте файл з назвою index.js:
mkdir pages
cat <<EOF > pages/index.js
export async function getServerSideProps() {
  return {
    props: {
      nodeVersion: process.version,
      port: process.env.SERVICE_PORT || 3000,
    },
  };
}

export default function Home({ nodeVersion, port }) {
  return (
    <div style={{
      fontFamily: 'sans-serif',
      textAlign: 'center',
      marginTop: '20vh'
    }}>
      <h1>✅ It works!</h1>
      <p>Next.js app running on Node.js {nodeVersion}</p>
      <p>Port: {port}</p>
    </div>
  );
}
EOF
  • Запустіть збірку проєкту.
yarn20.19.4 build
  • У панелі керування перейдіть до "налаштування сайту" -> "Backend"
  • Виберіть обробник Standalone або PM2.
  • Виберіть потрібну версію Node.js.
  • У полі команди запуску введіть: yarn run start.
  • Збережіть. Дочекайтеся компіляції застосунку (інформація з’явиться в логах). Перевірте вебсайт

Додаткова інформація

У режимі Standalone запускається процес Node.js для виконання ваших скриптів.

У режимі PM2 для керування процесами Node.js, логами та системним навантаженням використовується менеджер процесів PM2.
Цей режим також дає змогу вказати кількість воркерів — тобто кількість процесів Node.js, які обробляють вхідні запити до сервера.
Крім того, цей режим надає опцію Enable file watch — PM2 автоматично перезапускає ваш застосунок, коли файл змінюється в поточному каталозі або його підкаталогах. Зверніть увагу, що цей режим створює додаткове системне навантаження і не рекомендований для production-середовищ.

Аналогічно ви можете налаштувати застосунок, якщо йому потрібен YARN замість NPM

Ви можете встановити залежності вашого проєкту, перелічені в package.json, за допомогою YARN або NPM безпосередньо з FASTPANEL®. Для цього відкрийте картку вебсайту та перейдіть до розділу Сервіси:

Логи

Застосунок Node.js може генерувати логи. У FASTPANEL® вони розташовані в картці сайту, у розділі Логи, на вкладці "Backend log"

Консольні команди

Після встановлення Node.js у FASTPANEL® користувачі можуть працювати зі своїми проєктами за допомогою консольних команд, таких як:

  • pm2
  • yarn20.15.1
  • npx20.15.1
  • npm20.15.1
  • node20.15.1

Приклад:

$ npm20.15.1 list
node-socket-port-server@1.0.0 /var/www/node_user/data/www/node.site
└── express@4.21.2
$ pm2 ls
┌────┬─────────────┬─────────────┬─────────┬─────────┬──────────┬────────┬──────┬───────────┬──────────┬──────────┬──────────┬──────────┐
│ id │ name        │ namespace   │ version │ mode    │ pid      │ uptime │ ↺    │ status    │ cpu      │ mem      │ user     │ watching │
├────┼─────────────┼─────────────┼─────────┼─────────┼──────────┼────────┼──────┼───────────┼──────────┼──────────┼──────────┼──────────┤
│ 0  │ amazing_site│ default     │ 1.0.0   │ cluster │ 9355     │ 2m     │ 0    │ online    │ 0%       │ 62.4mb   │ user     │ disabled │
│ 1  │ amazing_site│ default     │ 1.0.0   │ cluster │ 9362     │ 2m     │ 0    │ online    │ 0%       │ 62.5mb   │ user     │ disabled │
└────┴─────────────┴─────────────┴─────────┴─────────┴──────────┴────────┴──────┴───────────┴──────────┴──────────┴──────────┴──────────┘

Назва кожної команди містить номер версії встановленого Node.js. У цьому прикладі доступна версія Node.js 20.15.1.

FASTPANEL Extended

Сповіщення сервера

На цій сторінці
інформація

FASTPANEL Extended доступна всім користувачам за замовчуванням. Активувати ліцензію не потрібно.

FASTPANEL® дозволяє відстежувати ключові метрики сервера: завантаження CPU, Load Average 5, використання диска і споживання RAM. Коли метрика перевищує свій поріг, сповіщення автоматично надсилаються до Telegram або Slack. Налаштування розташоване в розділі "Settings" → "Notifications".

У цій статті пояснюється, як налаштувати канали доставки і параметри сповіщень, зокрема пороги та тригери.

Налаштування каналу

Telegram

  1. Створіть нового бота за допомогою офіційного бота Telegram @BotFather. Перейдіть за посиланням і натисніть кнопку "Start"
  1. Введіть /newbot і натисніть Enter.
  2. Введіть бажане ім'я для вашого бота і натисніть Enter.
  3. Введіть бажане ім'я користувача для вашого бота. Воно має закінчуватися на bot, потім натисніть Enter.
  4. Ви отримаєте повідомлення, яке починається з:
    Done! Congratulations on your new bot.
  5. Натисніть синій рядок після Use this token to access the HTTP API: (розмитий на знімку екрана), щоб скопіювати API-токен вашого бота в буфер обміну. Зберігайте токен у безпеці, оскільки будь-хто, хто має його, може керувати вашим ботом
примітка

API-токен зберігається в @BotFather. Якщо ви його забудете, надішліть команду /mybots, виберіть свого бота і натисніть кнопку "API Token".

  1. Відкрийте FASTPANEL® і перейдіть до "Settings" → "Notifications".
  2. Натисніть кнопку "Create channel"
  1. Заповніть такі поля:
  • Name — введіть назву каналу, щоб візуально його розрізняти
  • Channel — виберіть "Telegram"
  • Bot token — вставте токен бота, скопійований на кроці 6
  • Problem period — задайте інтервал часу (у хвилинах), після якого буде надіслано сповіщення, якщо проблема зберігається. Мінімальне значення — 1 хвилина
  • Notification repeat interval — задайте інтервал між послідовними сповіщеннями про ту саму проблему
  • Notify about solved problems — увімкніть цю опцію, щоб отримувати сповіщення, коли проблему вирішено
  • Add basic triggers — увімкніть цю опцію, щоб автоматично створити тригери для всіх дисків, RAM і CPU
  1. Натисніть кнопку "Save".
  2. На наступному екрані натисніть кнопку "Invite", щоб запросити вашого бота до чату або групового чату
  1. Посилання відкриється в новій вкладці. Підтвердьте перенаправлення до застосунку Telegram Desktop
  1. Натисніть кнопку "Start", щоб активувати вашого бота
  1. Щоб перевірити правильність налаштування, поверніться на вкладку FASTPANEL® і натисніть кнопку з паперовим літачком
  1. Якщо все налаштовано правильно, тестове сповіщення буде надіслано до чату з вашим ботом
  1. Щоб пізніше змінити налаштування каналу, натисніть значок олівця поруч із каналом
  1. Нижче наведено приклад сповіщення, згенерованого під час активації тригера

Slack

  1. Увійдіть до свого облікового запису і створіть застосунок Slack на сторінці apps.
  2. Виберіть "From scratch".
  3. Введіть App Name, виберіть робочий простір, у якому буде створено застосунок, і натисніть “Create app”.
  4. У розділі “Features” відкрийте “Incoming Webhooks” і увімкніть цю функцію
  1. У нижній частині тієї ж сторінки натисніть “Add New Webhook”
  1. На наступному екрані виберіть канал, куди будуть надсилатися сповіщення. Рекомендується створити окремий канал для сповіщень. Потім натисніть “Allow”.
  2. Вас буде перенаправлено назад на сторінку вебхуків. Прокрутіть униз і натисніть “Copy”, щоб скопіювати URL вебхука
  1. Відкрийте FASTPANEL® і перейдіть до "Settings" → "Notifications".
  2. Натисніть кнопку "Create channel"
  1. Заповніть такі поля:
  • Name — введіть назву каналу, щоб візуально його розрізняти
  • Channel — виберіть "Slack"
  • Webhook url — вставте URL вебхука, скопійований на кроці 7
  • Problem period — задайте інтервал часу (у хвилинах), після якого буде надіслано сповіщення, якщо проблема зберігається. Мінімальне значення — 1 хвилина
  • Notification repeat interval — задайте інтервал між послідовними сповіщеннями про ту саму проблему
  • Notify about solved problems — увімкніть цю опцію, щоб отримувати сповіщення, коли проблему вирішено
  • Add basic triggers — увімкніть цю опцію, щоб автоматично створити тригери для всіх дисків, RAM і CPU
  1. Натисніть кнопку "Save".
  2. Щоб перевірити правильність налаштування, натисніть кнопку з паперовим літачком
  1. Якщо все налаштовано правильно, тестове сповіщення буде надіслано до каналу, вибраного на кроці 6
  1. Щоб пізніше змінити налаштування каналу, натисніть значок олівця поруч із каналом
  1. Нижче наведено приклад сповіщення, згенерованого під час активації тригера

Налаштування тригерів

Щоб налаштувати тригери, натисніть значок шестерні в рядку каналу, який ви хочете редагувати

У відкритому розділі ви можете:

  1. Вимкнути непотрібні тригери за допомогою перемикача ліворуч.
  2. Створити новий тригер одного з таких типів: CPU, Disk (для кожного диска окремо), Load Average 5 (середнє системне навантаження за останні 5 хвилин), RAM.
  3. Редагувати наявні тригери

Пороги для CPU, Disk і RAM задаються у відсотках. Поріг для Load Average 5 задається цілими значеннями.

примітка

Як правило, нормальне значення Load Average 5 приблизно дорівнює кількості ядер CPU на сервері або може бути до двох разів більшим за це число.

Статистика використання диска

інформація

FASTPANEL Extended доступна всім користувачам за замовчуванням. Активувати ліцензію не потрібно.

FASTPANEL® містить функцію Статистика використання диска, яка дає змогу швидко побачити, які файли та каталоги займають місце в користувацьких каталогах ваших вебсайтів.

Щоб скористатися цією функцією, відкрийте "Management" → "File Manager" і натисніть круглу піктограму у верхньому правому куті

На наступному екрані ви побачите детальну статистику використання диска, зокрема Каталоги, Найбільші файли та Статистику розширень.

  1. Натисніть піктограму папки у верхньому правому куті, щоб повернутися до файлового менеджера.
  2. Натисніть піктограму оновлення (кругові стрілки) у верхньому правому куті, щоб перезавантажити дані.
  3. Натисніть ім’я користувача у верхньому лівому куті, щоб перемикатися між домашніми каталогами різних користувачів; статистика оновлюватиметься відповідно.

Статистика пошти

На цій сторінці
інформація

FASTPANEL Extended доступна всім користувачам за замовчуванням. Активувати ліцензію не потрібно.

FASTPANEL® містить функцію Статистика пошти, яка дає змогу легко відстежувати активність вихідної електронної пошти для всього домену або окремих поштових скриньок. Ви можете швидко побачити, скільки повідомлень було надіслано, доставлено або повернуто, а також переглянути докладні коди помилок SMTP з рекомендаціями, що пояснюють, чому певні електронні листи було відхилено.

Налаштування автоматичного збору статистики

  1. Щоб увімкнути автоматичний збір статистики пошти, перейдіть до "Налаштування" → "Пошта" → "Статистика" та перемкніть параметр "Увімкнути збір статистики".

Якщо ви не хочете збирати дані автоматично, вимкніть цей параметр. Після цього вам потрібно буде вручну натискати кнопку "Оновити" у поданні статистики (див. наступний розділ), щоб оновити дані.

  1. Ви можете визначити, як часто статистика оновлюватиметься автоматично — від кожної 1 години до кожних 24 годин.

  2. Щоб зберегти свої налаштування, не забудьте натиснути кнопку "Зберегти".

Подання статистики

Щоб переглянути статистику, перейдіть до "Керування" → "Пошта" і натисніть значок графіка поруч із доменом, який ви хочете проаналізувати.

Подання статистики поділено на три основні розділи, які докладно описано нижче.

Графік статистики

Відображає загальну кількість надісланих, доставлених і повернутих повідомлень за вибраний період часу. Графік допомагає з першого погляду виявити тенденції та проблеми з доставкою.

Ви можете налаштувати відображувані дані, виконавши такі дії:

  1. Вибір поштового домену.

  2. Вибір статистики для всього домену або конкретної поштової скриньки.

  3. Вибір діапазону часу для звіту — від останніх 24 годин до останнього місяця.

  4. Натискання кнопки "Оновити" для ручного оновлення статистики та отримання найновіших даних.

Основні причини повернення

Містить перелік найчастіших причин збоїв доставки повідомлень разом із відповідними кодами помилок SMTP. Це дає змогу зрозуміти повторювані проблеми та усунути їх.

Події помилок вихідної пошти

Надає докладну інформацію про кожне відхилене або недоставлене повідомлення разом із рекомендованими діями для вирішення проблем.

Для кожного запису відображаються такі відомості:

  • Дата/час — точний час, коли сталася спроба доставки

  • Queue ID — унікальний ідентифікатор повідомлення в поштовій черзі

  • From / From domain / To — адреси відправника й одержувача, а також домен-джерело

  • SMTP code — код відповіді, повернутий поштовим сервером одержувача (наприклад, 550-5.7.26)

  • Advice — коротке пояснення проблеми та рекомендована дія (наприклад, “Повідомлення відхилено Gmail: відсутня або не проходить автентифікація SPF/DKIM”)

  • Detail — повний текст відповіді SMTP, який може містити посилання на зовнішню документацію від сервера одержувача (наприклад, сторінки підтримки Gmail)

  • Unknown code — указує, чи не вдалося класифікувати відповідь SMTP

  • Bytes — розмір електронного листа

  • Retry count — кількість спроб доставки, виконаних до остаточного відхилення повідомлення

  • Last try — часова позначка останньої спроби доставки

  • Spam score — результат оцінки на спам, якщо застосовно

Ці дані надають комплексний огляд проблем із вихідною доставкою, допомагаючи вам діагностувати проблеми автентифікації, репутації або конфігурації.