TMK.MonitorAndPrefomrance.Core 1.0.7

مكتبة تمكين الأساسية للمراقبة والأداء

Tamkeen Monitor and Performance Core

نظرة عامة | Overview

مكتبة تمكين الأساسية للمراقبة والأداء هي مكتبة .NET مصممة لتسهيل المراقبة الشاملة وإدارة الأداء داخل تطبيقاتك. تدعم المكتبة التسجيل عبر Serilog مع عدة مخارج، بما في ذلك SQL Server وSeq وElasticsearch، وتوفر معالجة تفصيلية للاستثناءات باستخدام مكتبة StackExchange.Exceptional.

Tamkeen Monitor and Performance Core is a .NET library designed to facilitate comprehensive monitoring and performance management within your applications. The library supports logging via Serilog with various sinks, including SQL Server, Seq, and Elasticsearch, and offers detailed exception handling using the StackExchange.Exceptional library.

المزايا | Features

• ✅ تسجيل مفصل مع Serilog ودعم مخارج متعددة (SQL Server، Seq، Elasticsearch، ملفات)
• ✅ معالجة شاملة للاستثناءات مع StackExchange.Exceptional
• ✅ إعدادات قابلة للتكوين مع دعم متغيرات البيئة وملفات الإعدادات
• ✅ دعم .NET 7+ مع التوافق مع .NET Framework 4.7.2
• ✅ نظام إشعارات عبر البريد الإلكتروني
• ✅ واجهة برمجة تطبيقات عربية مع دعم كامل للغة العربية
• ✅ حقن التبعيات مع Microsoft.Extensions.DependencyInjection
• ✅ التحقق من صحة الإعدادات مع رسائل خطأ واضحة

المتطلبات المسبقة | Prerequisites

• .NET 7.0+ أو .NET Framework 4.7.2+
• SQL Server (اختياري للتسجيل في قاعدة البيانات)
• Seq (اختياري لخادم التسجيل)
• Elasticsearch (اختياري للبحث والتحليل)

التثبيت | Installation

لتضمين مكتبة تمكين الأساسية للمراقبة والأداء في مشروعك، قم بتشغيل الأمر التالي:

dotnet add package Tamkeen.MonitorAndPerformance.Core

أو عبر Package Manager Console:

Install-Package Tamkeen.MonitorAndPerformance.Core

الإعداد السريع | Quick Setup

1. إضافة الخدمات في Program.cs

using Tamkeen.MonitorAndPerformance.Core.Extensions;

var builder = WebApplication.CreateBuilder(args);

// إضافة خدمات تمكين للمراقبة والأداء
builder.Services.AddTamkeenMonitoring(builder.Configuration);

var app = builder.Build();

2. إعداد ملف appsettings.json

{
  "TamkeenMonitoring": {
    "ProjectName": "مشروع_تمكين_التجريبي",
    "LayerName": "طبقة_الويب",
    "EnvironmentType": 3,
    "Serilog": {
      "Enabled": true,
      "UseConsole": true,
      "FilePath": "./logs/tamkeen-{Date}.log",
      "MinimumLevel": "Information"
    },
    "Exceptions": {
      "Enabled": true,
      "ApplicationName": "تطبيق_تمكين"
    }
  }
}

3. استخدام متغيرات البيئة (موصى به للإنتاج)

export TamkeenMonitoring__ProjectName="مشروع_الإنتاج"
export TamkeenMonitoring__Serilog__DatabaseConnectionString="Server=prod-server;Database=Logs;..."
export TamkeenMonitoring__Elasticsearch__Url="https://elasticsearch.company.com"

جدول الإعدادات | Configuration Reference

أمثلة الاستخدام | Usage Examples

الاستخدام الأساسي مع Dependency Injection

public class WeatherController : ControllerBase
{
    private readonly ILogger<WeatherController> _logger;
    private readonly IOptions<TamkeenMonitoringOptions> _options;

    public WeatherController(
        ILogger<WeatherController> logger,
        IOptions<TamkeenMonitoringOptions> options)
    {
        _logger = logger;
        _options = options;
    }

    [HttpGet]
    public IActionResult GetWeather()
    {
        _logger.LogInformation("تم طلب بيانات الطقس من {ProjectName}",
            _options.Value.ProjectName);

        // منطق التطبيق هنا
        return Ok(new { Temperature = 25, City = "صنعاء" });
    }
}

الإعداد المخصص

builder.Services.AddTamkeenMonitoring(options =>
{
    options.ProjectName = "مشروع_تمكين_المخصص";
    options.LayerName = "طبقة_الخدمات";
    options.EnvironmentType = 1; // إنتاج

    options.Serilog.Enabled = true;
    options.Serilog.UseConsole = false;
    options.Serilog.FilePath = "/var/log/tamkeen/app.log";

    options.Elasticsearch.Enabled = true;
    options.Elasticsearch.Url = "https://elasticsearch.company.com";
});

سياسة الإصدارات | Versioning Policy

نتبع Semantic Versioning (SemVer):

• الإصدار الرئيسي (Major): تغييرات غير متوافقة مع الإصدارات السابقة
• الإصدار الفرعي (Minor): إضافة ميزات جديدة متوافقة
• إصدار الإصلاح (Patch): إصلاحات الأخطاء

خريطة التوافق

تشغيل الاختبارات | Running Tests

# تشغيل جميع الاختبارات
dotnet test

# تشغيل الاختبارات مع تقرير التغطية
dotnet test --collect:"XPlat Code Coverage"

# تشغيل اختبارات محددة
dotnet test --filter "Category=Integration"

المساهمة | Contributing

نرحب بالمساهمات في هذا المشروع. يرجى اتباع الخطوات التالية:

1. Fork المستودع
2. إنشاء فرع للميزة الجديدة (git checkout -b feature/amazing-feature)
3. تنفيذ التغييرات مع اختبارات شاملة
4. التأكد من نجاح جميع الاختبارات
5. إرسال Pull Request

الترخيص | License

هذا المشروع مرخص تحت رخصة MIT. راجع ملف LICENSE للتفاصيل.

الدعم | Support

للحصول على الدعم والاستفسارات:

• 📧 البريد الإلكتروني: support@tamkeen.com.ye
• 🐛 الإبلاغ عن الأخطاء: GitHub Issues
• 📖 التوثيق: Wiki

مطور بـ ❤️ في اليمن | Made with ❤️ in Yemen