Serilog (.NET)

Serilog .NET के लिए सबसे लोकप्रिय स्ट्रक्चर्ड लॉगिंग लाइब्रेरी है। आधिकारिक Serilog.Sinks.OpenTelemetry सिंक के साथ, आपका एप्लिकेशन Serilog से जो भी इवेंट लॉग करता है, वह OpenTelemetry Protocol (OTLP) के ज़रिए Status200 को भेजा जाता है, और अपनी स्ट्रक्चर्ड प्रॉपर्टीज़, सीवियरिटी और ट्रेस से जुड़ाव के साथ उत्पाद → लॉग में खोजा जा सकता है।

Status200 के लिए अलग से कोई पैकेज इंस्टॉल नहीं करना होता — सिंक उसी OTLP एंडपॉइंट से बात करता है जिसे Status200 सभी OpenTelemetry डेटा के लिए देता है। यह कंसोल ऐप, वर्कर सर्विस, ASP.NET Core ऐप और .NET पर चलने वाली हर चीज़ के लिए काम करता है।

यह कैसे काम करता है#

सिंक लॉग इवेंट को बैच में इकट्ठा करता है और बैकग्राउंड में भेजता है। हर नाम वाली प्रॉपर्टी एक लॉग एट्रिब्यूट बन जाती है, और Serilog से लॉग किया गया अपवाद उन एट्रिब्यूट के साथ पहुंचता है जिनसे Status200 एक इश्यू बनाता है।

शुरू करने से पहले#

• एक Status200 प्रोजेक्ट। Status200 Cloud पर टेलीमेट्री का बिल प्रति GB इंजेस्ट किए गए डेटा पर बनता है — देखें मूल्य — और Free प्लान वाले प्रोजेक्ट को टेलीमेट्री भेजने से पहले भुगतान विधि जोड़नी होती है।
• एक .NET एप्लिकेशन जो Serilog इस्तेमाल करता है या कर सकता है।
• आपके लॉग प्रमाणित करने के लिए एक टेलीमेट्री इंजेशन कुंजी। अगर आपके पास नहीं है:

1. इंजेशन कुंजियाँ खोलें#

   उत्पाद → प्रोजेक्ट सेटिंग्स पर जाएं, साइड मेन्यू में टेलीमेट्री और APM खोलें और इंजेशन कुंजियाँ चुनें।

   

2. एक कुंजी बनाएं#

   इन्जेशन कुंजी बनाएँ पर क्लिक करें। डायलॉग में कुंजी का नाम पहले से भरा होता है और सर्वर चुना होता है — वह कुंजी प्रकार जिससे कोई एप्लिकेशन या collector डेटा भेजता है — इसलिए उसे बनाने के लिए इन्जेशन कुंजी बनाएँ पर क्लिक करें, या पहले उसका नाम बदलें।

3. सीक्रेट कॉपी करें#

   नई कुंजी अपने पेज पर खुलती है। उसकी सीक्रेट कुंजी कॉपी करें: यही नीचे के उदाहरणों में YOUR_TELEMETRY_INGESTION_TOKEN है।

   

आपको Status200 से क्या चाहिए#

प्रोटोकॉल HttpProtobuf पर सेट होने पर सिंक एंडपॉइंट के आगे /v1/logs पाथ जोड़ देता है, इसलिए वह जिस अंतिम URL पर भेजता है वह https://status200.ru/otlp/v1/logs है। आपको सिर्फ़ बेस /otlp एंडपॉइंट देना होता है।

सिंक सेट अप करें#

1. NuGet पैकेज इंस्टॉल करें#

   अपने प्रोजेक्ट में Serilog और OpenTelemetry सिंक जोड़ें:

   Bash

   dotnet add package Serilog
   dotnet add package Serilog.Sinks.OpenTelemetry

   अगर आप सिंक को appsettings.json से कॉन्फ़िगर कर रहे हैं, तो Serilog.Settings.Configuration भी जोड़ें। ASP.NET Core ऐप के लिए Serilog.AspNetCore जोड़ें, जो Serilog को होस्ट और रिक्वेस्ट पाइपलाइन से जोड़ता है:

   Bash

   dotnet add package Serilog.Settings.Configuration
   dotnet add package Serilog.AspNetCore

2. सिंक कॉन्फ़िगर करें#

   सिंक को अपने Status200 OTLP एंडपॉइंट की ओर करें, प्रोटोकॉल HttpProtobuf पर सेट करें, अपना इंजेशन टोकन हेडर के रूप में दें, और लॉग पर service.name लगाएं। इसे कोड में, appsettings.json में या ASP.NET Core होस्ट में कॉन्फ़िगर करें:

   कोड मेंappsettings.jsonASP.NET Core

   कोड में

   Program.csC#

   using Serilog;
   using Serilog.Sinks.OpenTelemetry;
   
   Log.Logger = new LoggerConfiguration()
       .MinimumLevel.Information()
       .Enrich.FromLogContext()
       .WriteTo.Console() // optional: keep local logs too
       .WriteTo.OpenTelemetry(options =>
       {
           // Base OTLP endpoint. The sink appends /v1/logs automatically.
           options.Endpoint = "https://status200.ru/otlp";
           options.Protocol = OtlpProtocol.HttpProtobuf;
   
           // Authenticate with your Status200 telemetry ingestion token.
           options.Headers = new Dictionary<string, string>
           {
               ["x-status200-token"] = "YOUR_TELEMETRY_INGESTION_TOKEN"
           };
   
           // Identify your service in Status200.
           options.ResourceAttributes = new Dictionary<string, object>
           {
               ["service.name"] = "my-service",
               ["deployment.environment"] = "production"
           };
       })
       .CreateLogger();
   
   try
   {
       Log.Information("Application starting up");
       // ... your application code ...
   }
   finally
   {
       // Flush any buffered logs before the process exits.
       Log.CloseAndFlush();
   }

   appsettings.json

   सिंक की सेटिंग्स appsettings.json में रखें:

   appsettings.jsonJSON

   {
     "Serilog": {
       "Using": ["Serilog.Sinks.OpenTelemetry"],
       "MinimumLevel": "Information",
       "WriteTo": [
         {
           "Name": "OpenTelemetry",
           "Args": {
             "endpoint": "https://status200.ru/otlp",
             "protocol": "HttpProtobuf",
             "headers": {
               "x-status200-token": "YOUR_TELEMETRY_INGESTION_TOKEN"
             },
             "resourceAttributes": {
               "service.name": "my-service",
               "deployment.environment": "production"
             }
           }
         }
       ]
     }
   }

   फिर कॉन्फ़िगरेशन से लॉगर बनाएं:

   Program.csC#

   using Serilog;
   using Microsoft.Extensions.Configuration;
   
   IConfiguration configuration = new ConfigurationBuilder()
       .AddJsonFile("appsettings.json")
       .Build();
   
   Log.Logger = new LoggerConfiguration()
       .ReadFrom.Configuration(configuration)
       .CreateLogger();

   ASP.NET Core

   ASP.NET Core (.NET 6+ मिनिमल होस्टिंग) के लिए Serilog.AspNetCore इस्तेमाल करें, ताकि Serilog डिफ़ॉल्ट लॉगर की जगह ले और फ़्रेमवर्क व रिक्वेस्ट लॉग भी कैप्चर करे:

   Program.csC#

   using Serilog;
   using Serilog.Sinks.OpenTelemetry;
   
   var builder = WebApplication.CreateBuilder(args);
   
   builder.Host.UseSerilog((context, services, configuration) =>
   {
       configuration
           .ReadFrom.Configuration(context.Configuration)
           .Enrich.FromLogContext()
           .WriteTo.OpenTelemetry(options =>
           {
               options.Endpoint = "https://status200.ru/otlp";
               options.Protocol = OtlpProtocol.HttpProtobuf;
               options.Headers = new Dictionary<string, string>
               {
                   ["x-status200-token"] = "YOUR_TELEMETRY_INGESTION_TOKEN"
               };
               options.ResourceAttributes = new Dictionary<string, object>
               {
                   ["service.name"] = "my-service"
               };
           });
   });
   
   var app = builder.Build();
   
   // Logs one summary event per HTTP request.
   app.UseSerilogRequestLogging();
   
   app.MapGet("/", () => "Hello World");
   app.Run();

   महत्वपूर्ण

   सिंक लॉग इवेंट को बैच करता है और उन्हें एसिंक्रोनस रूप से भेजता है। एप्लिकेशन बंद होने से पहले हमेशा Log.CloseAndFlush() कॉल करें (या लॉगर को डिस्पोज़ करें), वरना लॉग का आखिरी बैच खो सकता है। ASP.NET Core में, ग्रेसफ़ुल शटडाउन पर Serilog.AspNetCore यह आपके लिए कर देता है।

   सुझाव

   टोकन को सोर्स कंट्रोल से बाहर रखें। उसे किसी एनवायरनमेंट वेरिएबल या सीक्रेट्स स्टोर से पढ़ें और स्टार्टअप पर कॉन्फ़िगरेशन में डालें, न कि appsettings.json में कमिट करें।

3. लॉग लिखें#

   Serilog को हमेशा की तरह इस्तेमाल करें। स्ट्रक्चर्ड प्रॉपर्टीज़ बनी रहती हैं और Status200 में खोजने योग्य एट्रिब्यूट बन जाती हैं:

   C#

   Log.Information("Order {OrderId} placed by {CustomerId} for {Amount:C}",
       orderId, customerId, amount);
   
   Log.Warning("Payment gateway slow: {LatencyMs}ms", latencyMs);

   हर नाम वाली प्रॉपर्टी (OrderId, CustomerId, Amount, LatencyMs) लॉग एट्रिब्यूट के रूप में भेजी जाती है, ताकि आप उत्पाद → लॉग एक्सप्लोरर में उन पर फ़िल्टर और खोज कर सकें।

4. जांचें कि लॉग पहुंच रहे हैं#

   अपना एप्लिकेशन चलाएं और कुछ लॉग इवेंट लिखें। कुछ ही सेकंड में वे उत्पाद → लॉग में दिखते हैं, और उत्पाद → सेवाएं के तहत आपकी सेवा के पेज पर भी — सेवा का नाम आपके सेट किए service.name (my-service) पर होता है। उनकी स्ट्रक्चर्ड प्रॉपर्टीज़ फ़िल्टर के रूप में उपलब्ध होती हैं।

अपवाद#

जब आप Serilog से कोई अपवाद लॉग करते हैं, तो सिंक लॉग रिकॉर्ड पर OpenTelemetry के exception.type, exception.message और exception.stacktrace एट्रिब्यूट जोड़ देता है:

try
{
    ProcessPayment();
}
catch (Exception ex)
{
    Log.Error(ex, "Failed to process payment for order {OrderId}", orderId);
}

Status200 इन एट्रिब्यूट को पहचानता है और त्रुटि को फ़िंगरप्रिंट के अनुसार अपवाद में एक इश्यू में समूहित करता है, सही सेवा से जोड़कर। जो त्रुटि ट्रेस और लॉग दोनों से रिपोर्ट होती है, वह एक ही इश्यू में मिल जाती है। पहचान कैसे काम करती है, यह लॉग से अपवाद में देखें।

ट्रेस से जुड़ाव#

अगर आपका एप्लिकेशन ट्रेस के लिए OpenTelemetry .NET SDK से भी इंस्ट्रूमेंटेड है, तो किसी सक्रिय स्पैन के अंदर बने Serilog इवेंट पर अपने आप मौजूदा TraceId और SpanId लग जाते हैं (यह सिंक के डिफ़ॉल्ट IncludedData का हिस्सा है)। इससे Status200 किसी लॉग लाइन को सीधे उस ट्रेस से जोड़ पाता है जिसमें वह हुई, और आप लॉग से आसपास की रिक्वेस्ट पर जा सकते हैं और वापस आ सकते हैं।

ट्रेस और मेट्रिक्स भी भेजने के लिए, OpenTelemetry क्विकस्टार्ट में .NET सेटअप देखें।

समस्या निवारण#

अगर आपके कोई सवाल हैं या मदद चाहिए, तो हमें support@status200.ru पर लिखें।

अगले कदम#