EasyElasticLogger.NETFramework 1.0.8

EasyElasticLogger.NETFramework

🚀🚀🚀 A simple and easy-to-use Elasticsearch logger designed for .NET Framework applications

<div align="center">

Simple to use | Feature-rich | Production-ready

</div>

✨✨ Features

🎯🎯 Applicable Scenarios

📢📢 Important Note: This plugin is only applicable to .NET Framework 4.7.2 and 4.8 version applications. The Elasticsearch version is compatible with Elasticsearch 7.x

📊📊 Systems that need to centralize logs to ELK for unified analysis

• Systems requiring real-time log monitoring and alerts
• Scenarios where you want to leverage Kibana for log visualization and analysis

🖥️🖥️ Applications based on .NET Framework 4.7.2/4.8

• WinForm desktop applications (.NET Framework 4.7.2/4.8)
• WPF desktop applications (.NET Framework 4.7.2/4.8)
• WebForm traditional web applications (.NET Framework 4.7.2/4.8)
• Windows services and background task programs (.NET Framework 4.7.2/4.8)
• Console applications logging needs (.NET Framework 4.7.2/4.8)

🔧🔧 Diagnostic and operational logging needs in special development environments

• AutoCAD secondary development plugin logging (based on .NET Framework)
• Revit and other BIM software plugin development (based on .NET Framework)
• Industrial software plugin diagnostics and operational monitoring
• Special environment deployments requiring custom configuration file paths

❌❌ Unsupported Scenarios

• .NET Core / .NET 5/6/7/8 applications
• .NET Standard class library projects
• .NET Framework versions below 4.7.2
• Cross-platform applications (Linux/macOS)

📦📦 Installation

Install via NuGet Package Manager:

Install-Package EasyElasticLogger.NETFramework
```xml

Or install via .NET CLI:

```bash
dotnet add package EasyElasticLogger.NETFramework
```xml

---

## 🚀🚀🚀 Quick Start

### 1. Basic Usage

```csharp
using EasyElasticLogger.NETFramework.ES.Logging;

// Initialize at application startup (e.g., in Program.cs or Startup.cs)
ElasticLogger.Initialize("Production");

// Use static methods anywhere you need to log
// Synchronous logging
ElasticLogger.Info("This is an info log");
ElasticLogger.Warn("This is a warning log");
ElasticLogger.Error("This is an error log", new Exception("Test exception"));

// Asynchronous logging
await ElasticLogger.InfoAsync("This is an async info log");
await ElasticLogger.ErrorAsync("This is an async error log", new Exception("Test exception"));
```xml

### 2. Environment Configuration

#### Using Environment Variables

```csharp
// Set environment variable
Environment.SetEnvironmentVariable("ASPNETCORE_ENVIRONMENT", "Development");

// Or set ENVIRONMENT environment variable
Environment.SetEnvironmentVariable("ENVIRONMENT", "Test");

// Initialize with environment-specific configuration
ElasticLogger.Initialize();
```xml

#### Using Initialization Method to Specify Environment

```csharp
// Directly specify the environment
ElasticLogger.Initialize("Production");
```xml

---

## ⚙⚙⚙️ Configuration Methods

Configuration loading priority: **Direct parameters > JSON configuration > .config configuration**

### 1. 📝📝 Direct Parameter Configuration

```csharp
var config = new LoggerConfiguration
{
    Enabled = true,
    IndexPrefix = "myapp-log",
    IndexStrategy = IndexStrategy.DailyRolling,
    ApplicationName = "MyApplication",
    BatchSize = 100,
    TimeoutMs = 10000,
    Cluster = new ClusterConfigurationElement
    {
        Nodes = new List<string> { "http://localhost:9200" },
        Username = "elastic",
        Password = "password",
        UseSsl = false,
        SkipSslVerification = false,
        ConnectionTimeoutMs = 5000,
        MaxRetries = 2
    }
};

ElasticLogger.Initialize(config);
```xml

### 2. 📄📄 JSON Configuration File (Supports Environment-Specific Configuration)

```csharp
// Automatically looks for logger-config.Production.json or logger-config.json
ElasticLogger.InitializeFromJson("logger-config.json", "Production");
```xml

#### JSON Configuration File Example

**Default Configuration (logger-config.json)**
```json
{
  "Enabled": true,
  "IndexPrefix": "myapp-log",
  "IndexStrategy": "DailyRolling",
  "ApplicationName": "MyApplication",
  "BatchSize": 100,
  "TimeoutMs": 10000,
  "Cluster": {
    "Nodes": ["http://localhost:9200"],
    "Username": "elastic",
    "Password": "password",
    "UseSsl": false,
    "SkipSslVerification": false,
    "ConnectionTimeoutMs": 5000,
    "MaxRetries": 2
  }
}
```xml

**Production Environment Configuration (logger-config.Production.json)**
```json
{
  "Enabled": true,
  "IndexPrefix": "myapp-log-prod",
  "IndexStrategy": "DailyRolling",
  "ApplicationName": "MyProductionApp",
  "BatchSize": 100,
  "TimeoutMs": 10000,
  "Cluster": {
    "Nodes": ["http://prod-es1:9200", "http://prod-es2:9200", "http://prod-es3:9200"],
    "Username": "elastic",
    "Password": "prod_password",
    "UseSsl": true,
    "SkipSslVerification": false,
    "ConnectionTimeoutMs": 10000,
    "MaxRetries": 3
  }
}
```xml

**Usage Example**
```csharp
// Use default JSON configuration file
ElasticLogger.InitializeFromJson("logger-config.json");

// Use specified environment JSON configuration file
ElasticLogger.InitializeFromJson("logger-config.json", "Production");
```xml

### 3. ⚙⚙⚙️ .config Configuration File (Supports Environment-Specific Configuration)

```xml
<configuration>
  <appSettings>
    <add key="Environment" value="Development" />
  </appSettings>
  
  <configSections>
    
    <section name="elasticLogger" type="EasyElasticLogger.NETFramework.ES.Configuration.LoggerConfiguration, EasyElasticLogger.NETFramework" />
    
    
    <section name="elasticLogger.Development" type="EasyElasticLogger.NETFramework.ES.Configuration.LoggerConfiguration, EasyElasticLogger.NETFramework" />
    <section name="elasticLogger.Test" type="EasyElasticLogger.NETFramework.ES.Configuration.LoggerConfiguration, EasyElasticLogger.NETFramework" />
    <section name="elasticLogger.Production" type="EasyElasticLogger.NETFramework.ES.Configuration.LoggerConfiguration, EasyElasticLogger.NETFramework" />
  </configSections>

  
  <elasticLogger enabled="true" indexPrefix="app-log" applicationName="MyApplication" batchSize="100" timeoutMs="10000" indexStrategy="DailyRolling">
    <cluster nodes="http://localhost:9200" username="" password="" useSsl="false" skipSslVerification="false" connectionTimeoutMs="5000" maxRetries="2" />
  </elasticLogger>

  
  <elasticLogger.Development enabled="true" indexPrefix="dev-app-log" applicationName="MyApplication-Dev" batchSize="50" timeoutMs="15000" indexStrategy="DailyRolling">
    <cluster nodes="http://localhost:9200" username="elastic" password="changeme" useSsl="false" skipSslVerification="true" connectionTimeoutMs="10000" maxRetries="3" />
  </elasticLogger.Development>

  
  <elasticLogger.Production enabled="true" indexPrefix="prod-app-log" applicationName="MyApplication-Prod" batchSize="200" timeoutMs="30000" indexStrategy="DailyRolling" fixedIndexName="my-fixed-index">
    <cluster nodes="https://es1.prod.com,https://es2.prod.com,https://es3.prod.com" username="prod-user" password="prod-password" useSsl="true" skipSslVerification="false" connectionTimeoutMs="15000" maxRetries="5" />
  </elasticLogger.Production>
</configuration>
```xml

### 4. 🖥🖥🖥️ Custom Configuration File Path (Compatible with AutoCAD Secondary Development)

```csharp
// Use custom configuration file path and environment for initialization
ElasticLogger.Initialize(@"C:\\MyApp\\config\\myapp.config", "Production");

📋📋 Logging Examples

Synchronous Logging

``csharp // Debug level log ElasticLogger.Debug("Debug information", "MyClass.Method");

// Info level log ElasticLogger.Info("General information", "MyClass.Method");

// Warn level log ElasticLogger.Warn("Warning information", "MyClass.Method");

// Error level log ElasticLogger.Error("Error information", new Exception("Exception details"), "MyClass.Method");

// Fatal level log ElasticLogger.Fatal("Critical error", new Exception("Exception details"), "MyClass.Method");

// Log with additional data var userData = new { UserId = 123, UserName = "Zhang San" }; ElasticLogger.Info("User login", "UserService.Login", userData);

### Asynchronous Logging

``csharp
// Asynchronously log different levels
await ElasticLogger.DebugAsync("Debug information", "MyClass.Method");
await ElasticLogger.InfoAsync("General information", "MyClass.Method");
await ElasticLogger.WarnAsync("Warning information", "MyClass.Method");
await ElasticLogger.ErrorAsync("Error information", new Exception("Exception details"), "MyClass.Method");
await ElasticLogger.FatalAsync("Critical error", new Exception("Exception details"), "MyClass.Method");

🔧🔧 Configuration Parameter Details

Logger Configuration Items

Cluster Configuration Items

📊📊 Index Strategy

🔄🔄 Environment Configuration Support

Supported Environments

• 🛠🛠🛠️ Development - Development environment
• 🧪🧪🧪 Test - Testing environment
• 🏭🏭🏭 Production - Production environment

Environment Recognition Priority

1. 🥇🥇🥇 Environment variable ASPNETCORE_ENVIRONMENT
2. 🥈🥈🥈 Environment variable ENVIRONMENT
3. 🥉🥉🥉 AppSettings configuration item Environment

📄📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

<div align="center">

Make logging simple and powerful ✨✨

</div>