Tamkeen.Monitor.Core 1.0.1

مكتبة Tamkeen.Monitor.Core

حزمة Serilog عربية جاهزة للإنتاج مع دعم Seq وElasticsearch وملفات النظام وقواعد بيانات MSSQL.

✨ نبذة مختصرة

تساعدك المكتبة على توحيد تسجيل الأحداث (Logging) في خدمات .NET من خلال واجهة خيارات مبسطة (LibraryOptions) وتكامل جاهز مع أشهر الوسائط:

• سجلات الملفات الدورية (Rolling Files)
• خادم Seq للمتابعة اللحظية
• Elasticsearch لمراقبة السجلات وفهرستها
• قاعدة بيانات MSSQL كخيار احتياطي

متى أستخدمها؟

• عند بناء خدمات مصغّرة تحتاج سجلات موحدة مع بيانات سياقية غنية
• عند التحول من سجلات نصية متفرقة إلى منصة مركزية مثل Seq أو Kibana
• في بيئات DevOps التي تتطلب مراقبة الأداء والأخطاء بدقة

📦 التثبيت

dotnet add package Tamkeen.Monitor.Core --version 1.0.1

🚀 مثال سريع

using Microsoft.Extensions.DependencyInjection;
using Tamkeen.Monitor.Core.Configuration;
using Tamkeen.Monitor.Core.TmakeenLogsWithElastick;

var services = new ServiceCollection();

services.Configure<LibraryOptions>(options =>
{
    options.ProjectName = "CheckoutService";
    options.LayerName = "API";
    options.UseSerilog = true;
    options.SerilogFilePath = "/var/log/checkout/api.log";
    options.UseElasticsearch = true;
    options.ElasticsearchUrl = "https://elasticsearch.company.local";
    options.ElasticSearchApiKey = Environment.GetEnvironmentVariable("ES_API_KEY");
    options.UseConsole = true;
});

services.AddSingleton<TamkeenLogRegister>();

var provider = services.BuildServiceProvider();
var logger = provider.GetRequiredService<TamkeenLogRegister>();

logger.LogInfo(
    functionName: "CreateOrder",
    logRef: Guid.NewGuid().ToString(),
    projectName: "CheckoutService",
    layerName: "API",
    logInfo: new { OrderId = 1024, Amount = 120.5m },
    logType: 1);

⚙️ خيارات التهيئة (LibraryOptions)

💡 ملاحظة: وفر الإعدادات عبر متغيرات بيئية أو ملفات appsettings.json وتجنب كتابة القيم الحساسة داخل الكود.

🧪 الاختبارات

للتشغيل محلياً:

dotnet test -c Release

في هذا المستودع لا يتم تضمين أي مفاتيح أو عناوين بيئات حقيقية؛ جميع الأمثلة توضيحية.

📜 سجل التغييرات المختصر

• 1.0.1: تحسين بيانات NuGet، إضافة LibraryOptions، وإزالة العينات التي تحتوي على بيانات حساسة.
• 1.0.0: الإصدار الأولي داخل المؤسسة.

📐 سياسة الإصدارات

نتبع Semantic Versioning (صيغة MAJOR.MINOR.PATCH). التعديلات غير المتوافقة ستحمل زيادة في MAJOR مع توثيق واضح.

🆘 الدعم والإبلاغ عن المشاكل

• افتح تذكرة عبر GitHub Issues
• أو تواصل مع فريق منصة تمكين عبر البريد: support@tamkeen.com.ye

📄 الترخيص

المكتبة متاحة تحت رخصة MIT. يرجى مراجعة ملف THIRD_PARTY_NOTICES.md لمعرفة رخص التبعيات.