Gaois.QueryLogger

A simple, configurable query logger for ASP.NET and ASP.NET Core applications. It is the query logger used by Gaois, Fiontar & Scoil na Gaeilge, DCU to log search statistics to SQL Server. Gaois.QueryLogger is a .NET Standard 2.0 library and it supports applications built with ASP.NET Framework 4.6.1 and ASP.NET Core 2.1 or higher.

Package status

Package NuGet Stable NuGet Prerelease Downloads
Gaois.QueryLogger N/A NuGet Pre Release NuGet
Gaois.QueryLogger.AspNetCore N/A NuGet Pre Release NuGet

Features

  • Log query terms and associated metadata to SQL Server.
  • Metadata includes a unique query ID, application name, query category, host server, client IP address, query execution success, query execution duration, result count and datetime information.
  • Queries can share a GUID, meaning you can group multiple associated queries.
  • Add custom metadata to your logs. We use this to store application-specific data in a multi-application log.
  • By default, the library partially anonymises user IP addresses by removing the last octet of IPv4 client IP addresses or the last 80 bits of an IPv6 address. This setting can be turned off.
  • Performance: logging adds no additional overhead to server response times.
  • Includes its own e-mail notification service that will alert you in the event of any logging errors.

Documentation

Installation and usage vary slightly according to the target framework. Follow the links below to see the relevant documentation.

  • Read the documentation for ASP.NET Framework 4.6.1+ here.
  • Read the documentation for ASP.NET Core 2.1+ here.

Further documentation regarding configuration options and custom log data is also available.

Who is using this?

Gaois.QueryLogger is in production use at www.tearma.ie, www.duchas.ie, www.gaois.ie, www.ainm.ie, www.logainm.ie and meitheal.logainm.ie.

Additional credits

The architecture of Gaois.QueryLogger is heavily inspired by the StackExchange.Exceptional library. Gaois.QueryLogger makes use of two other third-party open-source libraries: Dapper and AutoMapper.

Gaois

Our apologies

This website is not compatible with the Microsoft Internet Explorer web browser. Please use Chrome, Edge, Firefox, Opera, or another modern browser to access the website content.

Contact us at gaois@dcu.ie if you have any questions.