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

Log Mesajları Yazma

C#'da logging başlatmak için, geliştiricilerin uygulamaları içinde log mesajları yazmaları gerekir. Bu, bir logging framework'ü veya API kullanarak yapılır. C#'da popüler bir seçim, Microsoft.Extensions.Logging isim alanında kullanılabilir olan Microsoft'un ILogger arabirimidir. Bu arabirim, çeşitli önem seviyelerinde veri loglamak için basit bir yol sağlar, bunlar log seviyeleri olarak bilinir. Bu seviyeler, Bilgilendirme, Hata Ayıklama ve Hata gibi, kaydedilen mesajların ciddiyetine göre log çıktısını kategorize etmeye ve filtrelemeye yardımcı olur.

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, logger adlı ILogger nesnesi, log mesajlarını konsola çıkış olarak ayarlamıştır. Bu kurulum basittir ancak log mesajlarının nasıl üretildiğini ve görüntülendiğini anlamanıza yardımcı olması açısından temel teşkil eder.

Log Dosyaları ve Sağlayıcılar

Gerçek dünyada bir uygulamada, log mesajlarını daha sonra incelemek üzere bir dosyada veya başka bir depolama sisteminde saklamanız gerekebilir. Bu, logging sağlayıcıların öne çıktığı yerdir. Sağlayıcılar, log verilerini dosyalar, veritabanları veya harici hizmetler gibi çeşitli hedeflere çıkış yapmak için logging framework'ünün bileşenleridir.

Örneğin, bir dosyayla log mesajlarını yazacak bir logger yapılandırmak için FileLoggerProvider gibi dosya tabanlı bir sağlayıcı kullanabilirsiniz. Bu, uygulamanın yapılandırma dosyasını (çoğunlukla .NET uygulamalarında appsettings.json olarak) log dosya yolu ve minimum log seviyesi gibi ayrıntılar belirtmek için değiştirmenizi 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 logging'in 'Information' seviyesinde olması gerektiğini belirler, ancak Microsoft'un kitaplıkları yalnızca uyarıları ve üzerindekileri kaydetmelidir. Ayrıca bir logs dizininde myapp.log adlı bir log dosyasına logging çıktısını yönlendirir.

İleri Logging Teknikleri

Temel log mesajlarının ötesinde, C# yapılandırılmış logging'i destekler. Bu, yalnızca metin yerine loglarınıza yapılandırılmış veri eklemenize izin verir. Yapılandırılmış logging, her bir bağlamsal bilgi parçası ayrı bir alan olarak depolandığı için log verilerini arama 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ış log örneğinde, OrderId ve Timestamp mesaj şablonu içerisindeki yer tutuculardır ve sırasıyla orderId ve DateTime.UtcNow değerleri ile doldurulacaktır. Bu, geleneksel loglamadan daha güçlüdür çünkü her log girişindeki spesifik alanlara göre log verilerinin sorgulanmasını ve işlenmesini kolaylaştırır.

Harici Sistemlerle Entegrasyon

C# logging, log verisinin yönetimini ve analizini geliştiren, SQL Server veya Windows Event Log gibi harici sistemlerle entegre edilebilir. Özel logging sağlayıcıları kullanarak, log mesajları bu sistemlere yönlendirilebilir, hata izleme ve yanıt için daha sağlam yetenekler sağlar.

// 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 snippet'i, log çıktısını "MyApplication" kaynak ismi altında Windows Olay Günlüğü'ne yönlendirir. Bu, özellikle Windows sunucularında çalışan ve Olay Günlüğü'nün yazılım ve sistem mesajlarını izlemek için merkezi bir araç olduğu uygulamalar için kullanış,

Kod Örneği

IronPDF'i C# logging yanında kullanmak için, PDF işlemleri içinde logging çağrıları dahil etmeniz gerekecek. İşte bu iki teknolojiyi bir .NET uygulamasında nasıl entegre edebileceğiniz üzerinde bir örnek. Bu örnek, Microsoft.Extensions.Logging içindeki ILogger arabirimi kullandığınızı varsaymaktadır.

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'ler üretilmesini kolaylaştırdığı gibi aynı zamanda bu işlemin loglar aracılığıyla iyi belgelenmesini sağlar, bu da bakım ve sorun gidermeyi destekler. IronPDF ile logging entegrasyonu, uygulamanızın PDF işleme yeteneklerinin güvenilirliğini ve izlenebilirliğini önemli ölçüde artırabilir.