C# Logging (Geliştiriciler için Nasıl Çalışır)

Günlük Mesajları Yazma

C#'ta günlük kaydı başlatmak için, geliştiricilerin uygulamaları içinde günlük mesajları yazmaları gerekir. Bu, bir günlükleme çerçevesi veya API kullanılarak yapılır. C#'ta popüler bir seçim, Microsoft.Extensions.Logging ad alanında bulunan ILogger arayüzüdür. Bu arayüz, önem seviyelerine göre veri kaydetmenin basit bir yolunu sağlar, bu seviyeler günlük seviyeleri olarak bilinir. Bu seviyeler Bilgi, Hata Ayıklama ve Hata gibi kategorilere ayrılır ve kayıtların şiddetine göre günlük çıktısını filtreler.

using Microsoft.Extensions.Logging;

public class Program
{
    static void Main(string[] args)
    {
        // Create a logger instance with console output
        ILogger logger = LoggerFactory.Create(builder => 
        {
            builder.AddConsole(); // Add console as a logging target
        }).CreateLogger<Program>();

        // Log messages with different levels of severity
        logger.LogInformation("This is an information log message");
        logger.LogError("This is an error log message");
    }
}

using Microsoft.Extensions.Logging;

public class Program
{
    static void Main(string[] args)
    {
        // Create a logger instance with console output
        ILogger logger = LoggerFactory.Create(builder => 
        {
            builder.AddConsole(); // Add console as a logging target
        }).CreateLogger<Program>();

        // Log messages with different levels of severity
        logger.LogInformation("This is an information log message");
        logger.LogError("This is an error log message");
    }
}

Imports Microsoft.Extensions.Logging

Public Class Program
	Shared Sub Main(ByVal args() As String)
		' Create a logger instance with console output
		Dim logger As ILogger = LoggerFactory.Create(Sub(builder)
			builder.AddConsole() ' Add console as a logging target
		End Sub).CreateLogger<Program>()

		' Log messages with different levels of severity
		logger.LogInformation("This is an information log message")
		logger.LogError("This is an error log message")
	End Sub
End Class

Yukarıdaki örnekte, bir ILogger nesnesi olan logger, günlük mesajlarını konsola çıkacak şekilde yapılandırılmıştır. Bu kurulum basittir ancak günlük mesajlarının nasıl oluşturulup görüntülendiğini anlamanıza yardımcı olmada temel bir rol oynar.

Günlük Dosyaları ve Sağlayıcılar

Gerçek bir dünyada uygulamada, günlük mesajlarını bir dosyada veya daha sonra incelemek için başka bir depolama sisteminde saklamanız sıklıkla gereklidir. İşte bu noktada günlük sağlayıcılar devreye girer. Sağlayıcılar, günlük verilerini dosyalar, veritabanları veya harici hizmetler gibi çeşitli hedeflere yönlendiren günlük çerçevesinin bileşenleridir.

Örneğin, bir logger'ı mesajları bir dosyaya yazacak şekilde yapılandırmak için, FileLoggerProvider gibi dosya tabanlı bir sağlayıcıyı kullanabilirsiniz. Bu, genellikle .NET uygulamalarında appsettings.json dosyasında, günlük dosya yolu ve minimum günlük seviyesi gibi ayrıntıları belirtmek için uygulamanın yapılandırma dosyasını değişiklik gerektirir.

{
  "Logging": {
    "LogLevel": {
      "Default": "Information", // Log levels for the application
      "Microsoft": "Warning"   // Log levels for Microsoft libraries
    },
    "File": {
      "Path": "logs/myapp.log" // File path for the log file
    }
  }
}

Yapılandırma, tüm varsayılan günlüklemenin 'Bilgi' seviyesinde olması gerektiğini, ancak Microsoft'un kütüphanelerinin yalnızca uyarılar ve üzerinde kayıt yapmasını belirtir. Bu ayrıca çıkışı logs dizininde myapp.log adlı bir günlük dosyasına yönlendirir.

İleri Düzey Günlük Teknikleri

Temel günlük mesajlarının ötesinde, C# yapılandırılmış günlük kayıtlarını destekler ve sadece düz metin yerine yapılandırılmış veriler eklemeyi sağlar. Yapılandırılmış günlükleme, her bağlamsal bilginin ayrı bir alan olarak saklanmasıyla günlük verilerini aramayı ve analiz etmeyi kolaylaştırır.

// Log message with structured data
logger.LogDebug("Processing order {OrderId} at {Timestamp}", orderId, DateTime.UtcNow);

// Log message with structured data
logger.LogDebug("Processing order {OrderId} at {Timestamp}", orderId, DateTime.UtcNow);

' Log message with structured data
logger.LogDebug("Processing order {OrderId} at {Timestamp}", orderId, DateTime.UtcNow)

Bu yapılandırılmış günlük örneğinde, OrderId ve Timestamp, orderId ve DateTime.UtcNow değerleri ile doldurulacak mesaj şablonu içerisinde yer tutuculardır. Bu, günlük verilerini her kayıt içindeki belirli alanlara göre sorgulama ve manipüle etme konusunda daha güçlü bir enstrümandır.

Dış Sistemlerle Entegrasyon

C# günlüğü, günlük verisinin yönetimi ve analizi üzerinde daha sağlam yetenekler sağlayarak SQL Server veya Windows Event Log gibi dış sistemlerle entegre edilebilir. Özel günlük sağlayıcıları kullanılarak, günlük mesajları bu sistemlere yönlendirilebilir ve hata gözetimi ve tepki yönetimi için daha güçlü olanaklar sağlanabilir.

// Direct log output to the Windows Event Log under a specific source name
builder.AddEventLog(new EventLogSettings
{
    SourceName = "MyApplication"
});

// Direct log output to the Windows Event Log under a specific source name
builder.AddEventLog(new EventLogSettings
{
    SourceName = "MyApplication"
});

' Direct log output to the Windows Event Log under a specific source name
builder.AddEventLog(New EventLogSettings With {.SourceName = "MyApplication"})

Bu yapılandırma kod parçası, günlük çıkışını 'MyApplication' kaynak adı altında Windows Olay Günlüğüne yönlendirir. Bu özellikle Windows sunucularda çalışan ve Olay Günlüğünün bir merkezi yazılım ve sistem mesajları izleme aracı olduğu uygulamalar için faydalıdır.

Kod Örneği

IronPDF'yi C# günlüklemesi ile birlikte kullanmak için, PDF işlemleriniz içinde günlük çağrılarını entegre etmeniz gerekecektir. .NET uygulamanızda bu iki teknolojiyi nasıl entegre edebileceğinize dair bir örnek. Bu örnek, Microsoft.Extensions.Logging kütüphanesindeki ILogger arayüzünü kullandığınızı varsayar.

using IronPdf;
using Microsoft.Extensions.Logging;
using System;

public class PdfGenerator
{
    private readonly ILogger _logger;

    public PdfGenerator(ILogger<PdfGenerator> logger)
    {
        _logger = logger;
    }

    public void CreatePdfFromHtml(string htmlContent, string outputPath)
    {
        try
        {
            // Initialize PDF renderer
            var renderer = new ChromePdfRenderer();

            // Convert HTML content to PDF
            var pdf = renderer.RenderHtmlAsPdf(htmlContent);

            // Save the generated PDF to a file
            pdf.SaveAs(outputPath);

            // Log the success of PDF creation
            _logger.LogInformation("PDF created successfully at {OutputPath}", outputPath);
        }
        catch (Exception ex)
        {
            // Log any errors encountered during PDF creation
            _logger.LogError(ex, "Error creating PDF from HTML");
        }
    }
}

// Usage example
public class Program
{
    static void Main(string[] args)
    {
        // Set the license key for IronPDF, if applicable
        License.LicenseKey = "License-Key";

        // Create a logger factory to manage logging configurations
        ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
        {
            builder.AddConsole(); // Enable logging to the console
        });

        // Create a logger for the PdfGenerator class
        ILogger<PdfGenerator> logger = loggerFactory.CreateLogger<PdfGenerator>();

        // Instantiate the PDF generator
        PdfGenerator pdfGenerator = new PdfGenerator(logger);

        // Example HTML content and output path
        string htmlContent = "<h1>Hello, PDF!</h1><p>This is a simple PDF generated from HTML.</p>";
        string outputPath = "output.pdf";

        // Create a PDF from the provided HTML content
        pdfGenerator.CreatePdfFromHtml(htmlContent, outputPath);
    }
}

using IronPdf;
using Microsoft.Extensions.Logging;
using System;

public class PdfGenerator
{
    private readonly ILogger _logger;

    public PdfGenerator(ILogger<PdfGenerator> logger)
    {
        _logger = logger;
    }

    public void CreatePdfFromHtml(string htmlContent, string outputPath)
    {
        try
        {
            // Initialize PDF renderer
            var renderer = new ChromePdfRenderer();

            // Convert HTML content to PDF
            var pdf = renderer.RenderHtmlAsPdf(htmlContent);

            // Save the generated PDF to a file
            pdf.SaveAs(outputPath);

            // Log the success of PDF creation
            _logger.LogInformation("PDF created successfully at {OutputPath}", outputPath);
        }
        catch (Exception ex)
        {
            // Log any errors encountered during PDF creation
            _logger.LogError(ex, "Error creating PDF from HTML");
        }
    }
}

// Usage example
public class Program
{
    static void Main(string[] args)
    {
        // Set the license key for IronPDF, if applicable
        License.LicenseKey = "License-Key";

        // Create a logger factory to manage logging configurations
        ILoggerFactory loggerFactory = LoggerFactory.Create(builder =>
        {
            builder.AddConsole(); // Enable logging to the console
        });

        // Create a logger for the PdfGenerator class
        ILogger<PdfGenerator> logger = loggerFactory.CreateLogger<PdfGenerator>();

        // Instantiate the PDF generator
        PdfGenerator pdfGenerator = new PdfGenerator(logger);

        // Example HTML content and output path
        string htmlContent = "<h1>Hello, PDF!</h1><p>This is a simple PDF generated from HTML.</p>";
        string outputPath = "output.pdf";

        // Create a PDF from the provided HTML content
        pdfGenerator.CreatePdfFromHtml(htmlContent, outputPath);
    }
}

Imports IronPdf
Imports Microsoft.Extensions.Logging
Imports System

Public Class PdfGenerator
	Private ReadOnly _logger As ILogger

	Public Sub New(ByVal logger As ILogger(Of PdfGenerator))
		_logger = logger
	End Sub

	Public Sub CreatePdfFromHtml(ByVal htmlContent As String, ByVal outputPath As String)
		Try
			' Initialize PDF renderer
			Dim renderer = New ChromePdfRenderer()

			' Convert HTML content to PDF
			Dim pdf = renderer.RenderHtmlAsPdf(htmlContent)

			' Save the generated PDF to a file
			pdf.SaveAs(outputPath)

			' Log the success of PDF creation
			_logger.LogInformation("PDF created successfully at {OutputPath}", outputPath)
		Catch ex As Exception
			' Log any errors encountered during PDF creation
			_logger.LogError(ex, "Error creating PDF from HTML")
		End Try
	End Sub
End Class

' Usage example
Public Class Program
	Shared Sub Main(ByVal args() As String)
		' Set the license key for IronPDF, if applicable
		License.LicenseKey = "License-Key"

		' Create a logger factory to manage logging configurations
		Dim loggerFactory As ILoggerFactory = LoggerFactory.Create(Sub(builder)
			builder.AddConsole() ' Enable logging to the console
		End Sub)

		' Create a logger for the PdfGenerator class
		Dim logger As ILogger(Of PdfGenerator) = loggerFactory.CreateLogger(Of PdfGenerator)()

		' Instantiate the PDF generator
		Dim pdfGenerator As New PdfGenerator(logger)

		' Example HTML content and output path
		Dim htmlContent As String = "<h1>Hello, PDF!</h1><p>This is a simple PDF generated from HTML.</p>"
		Dim outputPath As String = "output.pdf"

		' Create a PDF from the provided HTML content
		pdfGenerator.CreatePdfFromHtml(htmlContent, outputPath)
	End Sub
End Class

Bu kurulum, HTML'den PDF oluşturulmasını kolaylaştırmakla kalmaz, aynı zamanda işlemin belgelenmesini sağlayarak bakım ve teşhis çalışmalarına yardımcı olur. IronPDF ile günlük kaydının entegre edilmesi, uygulamanızın PDF işlem yeteneklerinin güvenilirliğini ve izlenebilirliğini önemli ölçüde artırabilir.