{"__v":8,"_id":"56b8264a7ced7f17003ab1d0","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"Seq is a log server that runs on a central machine. Your applications internally write structured events with a framework like [Serilog](http://serilog.net):\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"log.Error(\\\"Failed to log on user {ContactId}\\\", contactId);\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\nStructured logging preserves the individual property values, as well as the text, of each event.\n\nThese are sent across the network to Seq, which displays and makes them searchable:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/6d80777-DocsGettingStarted1.png\",\n        \"DocsGettingStarted1.png\",\n        1940,\n        1011,\n        \"#0765a7\"\n      ]\n    }\n  ]\n}\n[/block]\nGetting started is easy and quick. You need to:\n\n1. [Download](https://getseq.net/Download) and install the Seq server\n2. Add the appropriate NuGet package to your application\n\nAnd that's it! **:-)**\n\nHere we go step by step.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Installation\"\n}\n[/block]\nThe Seq server is a Windows service that accepts incoming events and hosts the main web user interface over HTTP or HTTPS.\n\nIf you're just setting up on your own developer workstation, you machine almost certainly have everything required. If you're hosting Seq on a shared server for your team, check out the [System Requirements](doc:system-requirements) and [Azure Installation Guide](doc:azure-installation).\n\n#### The Setup Wizard\n\nIf you haven't done so already, download the Seq installer now from the [https://getseq.net web site](https://getseq.net/Download).\n\nRunning the installer will show the Setup Wizard:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e1iaTfM1Qtig7BAWANR2_GettingStarted-2.png\",\n        \"GettingStarted-2.png\",\n        \"506\",\n        \"395\",\n        \"#1f89f9\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nStep through each page of the wizard. On a developer workstation the defaults are fine. Check out the [Production Deployment Checklist](doc:production-deployment) if you're going \"live\".\n\nAfter the wizard completes, browse the Seq UI at [http://localhost:5341](http://localhost:5341).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Collecting Log Events\"\n}\n[/block]\nBefore you can use Seq, your applications need to be configured to send log events through one of the supported logging libraries.\n\n * **[Using Serilog](doc:using-serilog)** - _Serilog_ is a modern logging library for the .NET platform with deep integration of structured event data.\n * **[Using ASP.NET Core](doc:using-aspnet-core)** - the _Microsoft.Extensions.Logging_ library included in ASP.NET Core works well with Seq.\n * **[Using Node.js](doc:using-nodejs)** - on Node.js, we support the Bunyan logging library\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you're unsure where to start, we recommend [starting with Serilog](doc:using-serilog).\"\n}\n[/block]\n 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.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What's Next?\"\n}\n[/block]\nOnce your apps are happily sending events to Seq, you can:\n\n* Learn about the flexible Seq [filter syntax](doc:query-syntax)\n* Create some [signals](doc:signals) to provide quick access to different filters\n* Set up some [retention policies](doc:retention-policies) to control disk usage\n\nHappy logging!","category":"56b826497ced7f17003ab1bf","createdAt":"2015-05-18T06:51:03.174Z","excerpt":"Seq is the easiest way for development teams to capture, search and integrate structured log events! This page will walk you through the very quick setup process.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"55598bd507b1710d0055f9c8","slug":"getting-started","sync_unique":"","title":"Getting Started with Seq","type":"basic","updates":["571f050ac10a771700e93cdb"],"user":"5559568d97777719007d5317","version":"56b826487ced7f17003ab1be","childrenPages":[]}

Getting Started with Seq

Seq is the easiest way for development teams to capture, search and integrate 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 internally write structured events with a framework like [Serilog](http://serilog.net): [block:code] { "codes": [ { "code": "log.Error(\"Failed to log on user {ContactId}\", contactId);", "language": "csharp" } ] } [/block] Structured logging preserves the individual property values, as well as the text, of each event. These are sent across the network to Seq, which displays and makes them searchable: [block:image] { "images": [ { "image": [ "https://files.readme.io/6d80777-DocsGettingStarted1.png", "DocsGettingStarted1.png", 1940, 1011, "#0765a7" ] } ] } [/block] Getting started is easy and quick. You need to: 1. [Download](https://getseq.net/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. [block:api-header] { "type": "basic", "title": "Installation" } [/block] 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 have everything required. If you're hosting Seq on a shared server for your team, check out the [System Requirements](doc:system-requirements) and [Azure Installation Guide](doc:azure-installation). #### The Setup Wizard If you haven't done so already, download the Seq installer now from the [https://getseq.net web site](https://getseq.net/Download). Running the installer will show the Setup Wizard: [block:image] { "images": [ { "image": [ "https://files.readme.io/e1iaTfM1Qtig7BAWANR2_GettingStarted-2.png", "GettingStarted-2.png", "506", "395", "#1f89f9", "" ] } ] } [/block] Step through each page of the wizard. On a developer workstation the defaults are fine. Check out the [Production Deployment Checklist](doc:production-deployment) if you're going "live". After the wizard completes, browse the Seq UI at [http://localhost:5341](http://localhost:5341). [block:api-header] { "type": "basic", "title": "Collecting Log Events" } [/block] Before you can use Seq, your applications need to be configured to send log events through one of the supported logging libraries. * **[Using Serilog](doc:using-serilog)** - _Serilog_ is a modern logging library for the .NET platform with deep integration of structured event data. * **[Using ASP.NET Core](doc:using-aspnet-core)** - the _Microsoft.Extensions.Logging_ library included in ASP.NET Core works well with Seq. * **[Using Node.js](doc:using-nodejs)** - on Node.js, we support the Bunyan logging library [block:callout] { "type": "info", "body": "If you're unsure where to start, we recommend [starting with Serilog](doc:using-serilog)." } [/block] 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. [block:api-header] { "type": "basic", "title": "What's Next?" } [/block] Once your apps are happily sending events to Seq, you can: * Learn about the flexible Seq [filter syntax](doc:query-syntax) * Create some [signals](doc:signals) to provide quick access to different filters * Set up some [retention policies](doc:retention-policies) to control disk usage Happy logging!