ghhv/sejil

Capture, view and filter your ASP.net core log events right from your app

NOTE The master branch, including this readme, has switched to .netcore 3.0. For .netcore 1/2 based, please go here: release/1.0.1.

Sejil

Sejil is a library that enables you to capture, view and filter your ASP.net core app's log events right from your app. It supports structured logging, querying as well as saving log event queries.

Quick Links

• Getting started
• Features and Screenshots
• Building
• License

Getting started

1. Installing Sejil package

   dotnet add package Sejil --version 2.0.0-beta1

2. Adding code Add below code to Program.cs:

   public static IWebHost BuildWebHost(string[] args) =>
       Host.CreateDefaultBuilder(args)
           .ConfigureWebHostDefaults(webBuilder =>
           {
               webBuilder.AddSejil("/sejil", LogLevel.Debug);
               // ...
           });            

   Add below code to Startup.cs

   using Sejil;
   
   public class Startup
   {    
       public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
       {
           app.UseSejil();
           // ...
       }
   }

   (Optional) To require authentication for viewing logs:

       public void ConfigureServices(IServiceCollection services)
       {
           services.ConfigureSejil(options =>
           {
               options.AuthenticationScheme = /* Your authentication scheme */
           });
       }

   (Optional) To change the logs page title (Defaults to Sejil if not set):

       public void ConfigureServices(IServiceCollection services)
       {
           services.ConfigureSejil(options =>
           {
               options.Title = "My title";
           });
       }

3. Navigate to http://your-app-url/sejil to view your app's logs.

Features and Screenshots

• View your app's logs

  

• View properties specific to a certain log entry

  

• Query your logs

  

• Mix multiple filters with your query to further limit the results

  

• Save your queries for later use

  

• Load your saved queries

  

Building

To build the project, you just need to clone the repo then run the build command:

git clone https://github.com/alaatm/Sejil.git
cd ./Sejil
./build.ps1  # If running Windows
./build.sh   # If running Linux/OSX

You can run one of the sample apps afterwards:

cd ./sample/SampleBasic
dotnet run

License

Copyright © Alaa Masoud.

This project is provided as-is under the Apache 2.0 license. For more information see the LICENSE file.