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    

POSTing Raw Events

Events can be sent directly to Seq via HTTP

In some situations it may be desirable to send events to Seq without using a logging library like Serilog. In that case, batches of events can be sent in JSON format directly to Seq's HTTP API.

Compact JSON format

Events are POSTed to the /api/events/raw endpoint:

POST https://localhost:5341/api/events/raw?clef

The /api/events/raw endpoint accepts payloads formatted using Serilog's compact JSON format.

Batches of events in this format are newline-separated JSON documents:

{"@t":"2016-06-07T03:44:57.8532799Z","@mt":"Hello, {User}","User":"alice"}
{"@t":"2016-06-07T04:10:00.3457981Z","@mt":"Hello, {User}","User":"bob"}

If an API key is required, it can be specified as ?apiKey= in the URL, or sent in the X-Seq-ApiKey HTTP header.

To identify the payload as compact log event format, either:

  • Include ?clef in the query string: /api/events/raw?clef as shown in the above example
  • Specify the value application/vnd.serilog.clef in the ContentType header

Classic format

Versions of Seq prior to 3.3 only accept the classic payload format, which takes the form of a single JSON document POSTed to /api/events/raw.

The body of the request contains one or more events in the format below:

{
  "Events": [{
    "Timestamp": "2015-05-09T22:09:08.12345+10:00",
    "Level": "Warning",
    "MessageTemplate": "Disk space is low on {Drive}",
    "Properties": {
      "Drive": "C:",
      "MachineName": "nblumhardt-rmbp"
    }
  }]
}

The Properties element can be omitted if an event does not carry any properties.

An Exception field can be specified at the top level (beside Properties, not under it) if required.

Sample Code using JSON.NET

The classes below can be used to serialize classic payloads using JSON.NET.

// This is the payload
class RawEvents
{
  public RawEvent[] Events { get; set; }
}

// Add these to RawEvents.Events
class RawEvent
{
  public DateTimeOffset Timestamp { get; set; }
  
  // Uses the Serilog level names
  public string Level { get; set; }
  
  public string MessageTemplate { get; set; }
  
  public Dictionary<string, object> Properties { get; set; }
  
  public string Exception { get; set; }
}

POSTing Raw Events


Events can be sent directly to Seq via HTTP

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.