Seq Documentation and Support

Seq Documentation and Support

Welcome to the Seq documentation hub. You'll find comprehensive guides and documentation to help you start working with Seq as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Getting Started with Seq

Seq is the easiest way for development teams to capture, search and visualize structured log events! This page will walk you through the very quick setup process.

Seq is a log server that runs on a central machine. Your applications send structured events through a framework like Serilog:

log.Error("Failed to log on user {ContactId}", contactId);

Structured logging preserves the individual property values, as well as the text, associated with each event.

These are sent across the network to Seq, which displays them and makes them searchable:

Getting started is easy and quick. You need to:

  1. Download and install the Seq server
  2. Add the appropriate NuGet package to your application

And that's it! Here we go step by step.

Installing the Seq Server

The Seq server is a Windows service that accepts incoming events and hosts the main web user interface over HTTP or HTTPS.

If you're just setting up on your own developer workstation, you machine almost certainly has everything required. If you're hosting Seq on a shared server for your team, check out the System Requirements and Azure Installation Guide.

Opening the installer MSI file will start the Setup Wizard:

Step through each page of the wizard. On a developer workstation the defaults are fine. Check out the Production Deployment Checklist if you're going "live".

After the wizard completes, browse the Seq UI at http://localhost:5341.

Collecting Log Events

Before you can benefit from Seq, your applications need to be configured to send log events through one of the supported logging libraries.

  • Using Serilog - Serilog is a modern logging library for the .NET platform with deep support for structured event data.
  • Using ASP.NET Core - the Microsoft.Extensions.Logging library included in ASP.NET Core works well with Seq.
  • Using Node.js - on Node.js, we support the Bunyan logging library

If you're unsure where to start, we recommend Serilog.

Seq integrates with a range of languages, libraries and frameworks, and has a simple HTTP API for receiving log data. For detailed options see the Inputs heading in the topic list on the left-hand side of this page.

What's Next?

Once your apps are happily sending events to Seq, you can:

Happy logging!