{"id":91176,"date":"2019-03-29T18:39:51","date_gmt":"2019-03-29T18:39:51","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/aspnet\/?p=21689"},"modified":"2019-03-29T18:39:51","modified_gmt":"2019-03-29T18:39:51","slug":"net-core-workers-as-windows-services","status":"publish","type":"post","link":"https:\/\/sickgaming.net\/blog\/2019\/03\/29\/net-core-workers-as-windows-services\/","title":{"rendered":".NET Core Workers as Windows Services"},"content":{"rendered":"
\n
\n
\"Avatar\"<\/p>\n

Glenn<\/p>\n<\/div>\n<\/div>\n<\/div>\n

\n

March 29th, 2019<\/p>\n

<!–Posted on Glenn Condron [MSFT]<\/a><\/span><\/span>–> <\/div>\n

<\/p>\n

In .NET Core 3.0 we are introducing a new type of application template called Worker Service. This template is intended to give you a starting point for writing long running services in .NET Core. In this walkthrough we will create a worker and run it as a Windows Service.<\/p>\n

Create a worker<\/h2>\n

Preview Note: In our preview releases the worker template is in the same menu as the Web templates. This will change in a future release. We intend to place the Worker Server template directly inside the create new project wizard.<\/em><\/strong><\/p>\n

Create a Worker in Visual Studio<\/h3>\n

\"image\"<\/p>\n

\"image\"<\/p>\n

\"image\"<\/p>\n

Create a Worker on the command line<\/h3>\n

Run dotnet new worker<\/code><\/p>\n

\"image\"<\/p>\n

Run as a Windows Service<\/h2>\n

In order to run as a Windows Service we need our worker to listen for start and stop signals from ServiceBase<\/code> the .NET type that exposes the Windows Service systems to .NET applications. To do this we want to:<\/p>\n

Add the Microsoft.Extensions.Hosting.WindowsServices<\/code> NuGet package<\/p>\n

\"image\"<\/p>\n

Add the UseServiceBaseLifetime<\/code> call to the HostBuilder<\/code> in our Program.cs<\/p>\n

public class Program\n{ public static void Main(string[] args) { CreateHostBuilder(args).Build().Run(); } public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .UseServiceBaseLifetime() .ConfigureServices(services => { services.AddHostedService<Worker>(); });\n}\n<\/code><\/pre>\n
This method does a couple of things. First, it checks whether or not the application is actually running as a Windows Service, if it isn\u2019t then it noops which makes this method safe to be called when running locally or when running as a Windows Service. You don\u2019t need to add guard clauses to it and can just run the app normally when not installed as a Windows Service.<\/p>\n
Secondly, it configures your host to use a ServiceBaseLifetime<\/code>. ServiceBaseLifetime<\/code> works with ServiceBase<\/code> to help control the lifetime of your app when run as a Windows Service. This overrides the default ConsoleLifetime<\/code> that handles signals like CTL+C.<\/p>\n
Install the Worker<\/h3>\n
Once we have our worker using the ServiceBaseLifetime<\/code> we then need to install it:<\/p>\n
First, lets publish the application. We will install the Windows Service in-place, meaning the exe will be locked whenever the service is running. The publish step is a nice way to make sure all the files I need to run the service are in one place and ready to be installed.<\/p>\n
dotnet publish -o c:\\code\\workerpub\n<\/code><\/pre>\n
Then we can use the sc utility<\/a> in an admin command prompt<\/p>\n
sc create workertest binPath=c:\\code\\workerpub\\WorkerTest.exe\n<\/code><\/pre>\n
For example:<\/p>\n
\"image\"<\/p>\n
Security note:<\/strong> This command has the service run as local system, which isn\u2019t something you will generally want to do<\/strong>. Instead you should create a service account and run the windows service as that account. We will not talk about that here, but there is some documentation on the ASP.NET docs talking about it here: https:\/\/docs.microsoft.com\/en-us\/aspnet\/core\/host-and-deploy\/windows-service?view=aspnetcore-2.2<\/a><\/em><\/p>\n
Logging<\/h2>\n
The logging system has an Event Log provider that can send log message directly to the Windows Event Log. To log to the event log you can add the Microsoft.Extensions.Logging.EventLog<\/code> package and then modify your Program.cs<\/code>:<\/p>\n
public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args) .ConfigureLogging(loggerFactory => loggerFactory.AddEventLog()) .ConfigureServices(services => { services.AddHostedService<Worker>(); });\n<\/code><\/pre>\n
In upcoming previews we plan to improve the experience of using Workers with Windows Services by:<\/p>\n
    \n
  1. Rename UseWindowsServiceBaseLifetime to UseWindowsService<\/li>\n
  2. Add automatic and improved integration with the Event Log when running as a Windows Service.<\/li>\n<\/ol>\n
    We hope you try out this new template and want you to let us know how it goes, you can file any bugs or suggestions here: https:\/\/github.com\/aspnet\/AspNetCore\/issues\/new\/choose<\/a><\/p>\n
    \n
    \"Avatar\"<\/div>\n<\/p><\/div>\n","protected":false},"excerpt":{"rendered":"
    Glenn March 29th, 2019 <!–Posted on March 29, 2019 (March 29, 2019) by Glenn Condron [MSFT]–> In .NET Core 3.0 we are introducing a new type of application template called Worker Service. This template is intended to give you a starting point for writing long running services in .NET Core. In this walkthrough we will […]<\/p>\n","protected":false},"author":2,"featured_media":91177,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[66],"tags":[498,67],"class_list":["post-91176","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-microsoft-webdev","tag-net-core","tag-aspnetcore"],"_links":{"self":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/91176","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/comments?post=91176"}],"version-history":[{"count":0,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/posts\/91176\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/media\/91177"}],"wp:attachment":[{"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/media?parent=91176"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/categories?post=91176"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/sickgaming.net\/blog\/wp-json\/wp\/v2\/tags?post=91176"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}