نصب پلاگین Arvancloud Logs برای Grafana

پلاگین Arvancloud Logs به شما امکان می‌دهد داده‌های لاگ ابری آروان‌کلاد را در Grafana جست‌وجو، فیلتر و تبدیل به نمودارها کنید.

قابلیت‌های پلاگین

لاگ ابری آروان‌کلاد لاگ‌های اپلیکیشن، سیستم و Audit را به‌شکل متمرکز در یک‌جا ذخیره می‌کند. به کمک این پلاگین می‌توانید Grafana را به لاگ ابری آروان‌کلاد متصل کنید تا:

• • لاگ‌ها را در «Explore» یا «Dashboard» ببینید.

• • با فیلتر متنی یا زبان «Arvancloud Query Language» جست‌وجو کنید.

• • بدون نوشتن کوئری، از «Filter Builder» تصویری استفاده کنید.

• • هیستوگرام تعداد لاگ‌ها را در بازه‌ی زمانی موردنظر ببینید.

• • هم‌زمان از چند Space کوئری بگیرید.

• • برای نام فیلدها از «Auto-complete» استفاده کنید.

• • با «Scan for older logs» لاگ‌های قدیمی‌تر را بارگذاری کنید.

پیش‌نیازها

پیش‌نیازهای نصب
مورد	توضیح
Grafana	نسخه‌ی 10.4.0 یا بالاتر
حساب آروان‌کلاد	دسترسی به CloudLogs
API Key	متعلق به یک Machine User با نقش Read Log

نصب پلاگین

برای نصب این پلاگین می‌توانید یکی از سه روش Grafana CLI، Docker یا نصب دستی را انتخاب کنید.

این پلاگین بدون امضا (unsigned) است. پیش از نصب، باید به Grafana اجازه‌ی بارگذاری این نوع پلاگین را بدهید.

گام ۱: اجازه‌ی بارگذاری پلاگین

در فایل grafana.ini این خط را اضافه کنید:

[plugins]
allow_loading_unsigned_plugins = arvancloud-logs-datasource

سپس Grafana را دوباره راه‌اندازی کنید.

روش ۱: نصب با Grafana CLI (پیشنهادی)

آخرین نسخه را از صفحه‌ی «Releases» دریافت کنید. سپس مقدار VERSION را با شماره‌ی نسخه (برای نمونه، 1.0.1) جایگزین کنید و دستور زیر را اجرا کنید:

grafana-cli --pluginUrl \
  https://git.arvancloud.ir/api/v4/projects/158/packages/generic/arvancloud-logs-datasource/VERSION/arvancloud-logs-datasource-VERSION.zip \
  plugins install arvancloud-logs-datasource

sudo systemctl restart grafana-server

روش ۲: Docker

فایل docker-compose.yaml را در مخزن پروژه باز کنید، مقدار VERSION را با شماره‌ی نسخه‌ی موردنظر جایگزین کنید و دستور زیر را اجرا کنید:

docker-compose up -d

Grafana روی http://localhost:3000 در دسترس است.

روش ۳: نصب دستی

۱. فایل ZIP را از «Releases» دانلود کنید. ۲. آن را در پوشه‌ی پلاگین‌های Grafana استخراج کنید:

Linux:   /var/lib/grafana/plugins/
macOS:   /usr/local/var/lib/grafana/plugins/
Windows: C:\Program Files\GrafanaLabs\grafana\data\plugins\

۳. Grafana را دوباره راه‌اندازی کنید.

تایید نصب

پس از نصب پلاگین با هر یک از روش‌های بالا، نصب را این‌گونه بررسی کنید: در Grafana، از بخش «Configuration» گزینه‌ی «Plugins» را انتخاب کنید و «Arvancloud Logs» را جست‌وجو کنید. اگر پلاگین را دیدید، یعنی نصب با موفقیت انجام شده است.

پیکربندی Data Source

برای اتصال Grafana به CloudLogs، باید یک API Key بسازید و آن را به‌عنوان Data Source در Grafana پیکربندی کنید.

گام ۱: ساخت API Key

۱. وارد پیشخان آروان‌کلاد شوید. ۲. از بخش «IAM» گزینه‌ی «Machine Users» را انتخاب کنید. ۳. یک Machine User جدید بسازید. ۴. یک Access Policy با نقش Read Log به آن اضافه کنید. ۵. API Key را کپی کنید و در جایی امن نگه دارید.

راهنمای Machine User به شما در این مسیر کمک می‌کند.

گام ۲: افزودن Data Source در Grafana

۱. از بخش «Configuration»، گزینه‌ی «Data Sources» و سپس «Add data source» را انتخاب کنید. ۲. «Arvancloud Logs» را انتخاب کنید. ۳. فیلدها را به‌شکل زیر پر کنید:

فیلدهای Data Source
فیلد	توضیح
Name	نامی دل‌خواه (برای نمونه، CloudLogs Production)
API Key	کلید Machine User
API URL	https://napi.arvancloud.ir/logging

سپس «Save & Test» را بزنید. پیام «Successfully connected to CloudLog API» یعنی اتصال برقرار شده است.

اولین کوئری

برای دیدن لاگ‌ها، این گام‌ها را دنبال کنید:۱. «Explore» را باز کنید یا یک «Dashboard» جدید بسازید. ۲. در بخش Data Source، گزینه‌ی «Arvancloud Logs» را انتخاب کنید. ۳. یک یا چند Space را انتخاب کنید. ۴. فیلتر را خالی بگذارید یا برای نمونه بنویسید: severity == “ERROR” ۵. «Run Query» را بزنید.لاگ‌ها در بخش «Logs» نمایش داده می‌شوند.

داشبورد Audit آماده

این پلاگین یک داشبورد Audit آماده دارد. پس از نصب:۱. از بخش «Dashboards» گزینه‌ی «Browse» را انتخاب کنید. ۲. داشبورد Audit را import یا باز کنید. ۳. Data Source را به instance خودتان اختصاص دهید.

عیب‌یابی

اگر در نصب یا استفاده از پلاگین با مشکل مواجه شدید، این راه‌حل‌ها را بررسی کنید.

پلاگین در فهرست «Plugins» نیست

• • مسیر Extract فایل‌ها را بررسی کنید.

• • تنظیم allow_loading_unsigned_plugins را در grafana.ini بررسی کنید.

• • Grafana را دوباره راه‌اندازی کنید.

«Save & Test» با خطا مواجه می‌شود

• • API Key را دوباره بررسی کنید.

• • Machine User باید نقش Read Log داشته باشد.

• • API URL را با مقدار پیش‌فرض تست کنید.

لاگی برنمی‌گردد

• • بازه‌ی زمانی Grafana (گوشه‌ی بالا و راست صفحه) را بزرگ‌تر کنید.

• • فیلتر را ساده‌تر کنید.

• • «Scan for older logs» را امتحان کنید.

حذف پلاگین

برای حذف پلاگین، بسته به روش نصب، یکی از راه‌های زیر را دنبال کنید.

# Linux
sudo rm -rf /var/lib/grafana/plugins/arvancloud-logs-datasource
sudo systemctl restart grafana-server

در Docker، کانتینر را بدون این پلاگین در GF_INSTALL_PLUGINS دوباره بسازید.