Skip to main content

Lifecycle of Worker Roles (RoleEntryPoint)

In this post we will talk about 3 methods that are available in the RoleEntryPoint class for Web and Worker Roles (especially Worker Roles)

  • OnStart
  • Run
  • OnStop

This 3 methods are called in different moment of the lifecycle of a Worker Role. Each of them has a clear scope and output.

OnStart
This method is called automatically when the instance of Worker Role is initialized. It is used to initialized the context or prepare the instance before executing the task.
This method returns a bool value that it is used to tell the system if the initialization was made with success or not. On the happy case the return value should be true. If an error occurs or the initialization fails, that the false value should be returned. When OnStart methods returns false, the Run method will not be called and the instance will be 'restarted' - No other methods will be called.

Run
The Run method is used to execute the batch operation or the logic that is necessary to be executed by the Worker Role. We should 'block' the code to not exist from this method as long as we want to keep our instance alive.
This method is called only when OnStart methods returns true. When we exit from the Run method, the OnStop method will be called and worker role will be restarted.

OnStop
This method is used to make the cleanup sequence of our system. For example deallocate resources or commit some changes or logs.
This method is called only when the no exception is triggered by Run or OnStart method.

Below you can find the lifecycle flow.


Let's take a look on the following code:

    public class WorkerRole : RoleEntryPoint
    {
        private readonly CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
        private readonly ManualResetEvent runCompleteEvent = new ManualResetEvent(false);

        public override void Run()
        {
            Logger.Debug(LoggingAction.StartingWorkerRole, "Foo.Workers.SU is running");

            try
            {
                RunAsync(cancellationTokenSource.Token).Wait();
            }
            finally
            {
                runCompleteEvent.Set();
            }
        }

        public override bool OnStart()
        {
            bool reFoolt = base.OnStart();

            Logger.Debug(LoggingAction.StartingWorkerRole, "Foo.Workers.SU has been started");

            ObjectFactory.InitializeContainer(new DependencyInstaller());

            var rp = ObjectFactory.GetObject<IPRP>();            
            rp.StartListeningAsync().Wait();            

            return reFoolt;
        }

        public override void OnStop()
        {
            Logger.Debug(LoggingAction.StoppingWorkerRole, "Foo.Workers.SU is stopping");

            cancellationTokenSource.Cancel();
            runCompleteEvent.WaitOne();

            base.OnStop();

            Logger.Debug(LoggingAction.StoppingWorkerRole, "Foo.Workers.SU has stopped");
        }

        private async Task RunAsync(CancellationToken cancellationToken)
        {
            while (!cancellationToken.IsCancellationRequested)
            {                
                await Task.Delay(1000);
            }
        }
    }

Looking over the above code, we observe that no logic is done on Rum method. Not only we initialize the object factory but we also start listening to a queue in the OnStart method. Because of this the Run method is not used and our Worker Role will be in a 'transition' phase all the time.
What we should keep in OnStart method? The initialization of object factory can be keeped in this method. Also, if we would have some initialization on the logger side, that we should keep it in this place.
What we should not keep in OnStart method? We should move the start listening to our our queue from OnStart method to Run. That is a piece of code that is long running and should be in the Run.

    public class WorkerRole : RoleEntryPoint
    {
        private readonly CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
        private readonly ManualResetEvent runCompleteEvent = new ManualResetEvent(false);

        public override void Run()
        {
            Logger.Debug(LoggingAction.StartingWorkerRole, "Foo.Workers.SU is running");

            try
            {
                RunAsync(cancellationTokenSource.Token).Wait();
            }
            finally
            {
                runCompleteEvent.Set();
            }
        }

        public override bool OnStart()
        {
            bool reFoolt = base.OnStart();
      
            Logger.Debug(LoggingAction.StartingWorkerRole, "Foo.Workers.SU has been started");
      
      try
      {
        ObjectFactory.InitializeContainer(new DependencyInstaller());            
      }
      catch(Exception ex)
      {
        Logger.Exception(ex);
        reFoolt = false;
      }

            return reFoolt;
        }
    
    public void Run()
    {
      var rp = ObjectFactory.GetObject<IPRP>();            
            rp.StartListeningAsync().Wait();            
    }
    

        public override void OnStop()
        {
            Logger.Debug(LoggingAction.StoppingWorkerRole, "Foo.Workers.SU is stopping");

            cancellationTokenSource.Cancel();
            runCompleteEvent.WaitOne();

            base.OnStop();

            Logger.Debug(LoggingAction.StoppingWorkerRole, "Foo.Workers.SU has stopped");
        }

        private async Task RunAsync(CancellationToken cancellationToken)
        {
            while (!cancellationToken.IsCancellationRequested)
            {                
                await Task.Delay(1000);
            }
        }
    }

In conclusion, there are two important things that we should remember:

  • OnStart should only initialize and configure our system
  • Run method is used for processing and log running tasks

Comments

Popular posts from this blog

Windows Docker Containers can make WIN32 API calls, use COM and ASP.NET WebForms

After the last post , I received two interesting questions related to Docker and Windows. People were interested if we do Win32 API calls from a Docker container and if there is support for COM. WIN32 Support To test calls to WIN32 API, let’s try to populate SYSTEM_INFO class. [StructLayout(LayoutKind.Sequential)] public struct SYSTEM_INFO { public uint dwOemId; public uint dwPageSize; public uint lpMinimumApplicationAddress; public uint lpMaximumApplicationAddress; public uint dwActiveProcessorMask; public uint dwNumberOfProcessors; public uint dwProcessorType; public uint dwAllocationGranularity; public uint dwProcessorLevel; public uint dwProcessorRevision; } ... [DllImport("kernel32")] static extern void GetSystemInfo(ref SYSTEM_INFO pSI); ... SYSTEM_INFO pSI = new SYSTEM_INFO(

Azure AD and AWS Cognito side-by-side

In the last few weeks, I was involved in multiple opportunities on Microsoft Azure and Amazon, where we had to analyse AWS Cognito, Azure AD and other solutions that are available on the market. I decided to consolidate in one post all features and differences that I identified for both of them that we should need to take into account. Take into account that Azure AD is an identity and access management services well integrated with Microsoft stack. In comparison, AWS Cognito is just a user sign-up, sign-in and access control and nothing more. The focus is not on the main features, is more on small things that can make a difference when you want to decide where we want to store and manage our users.  This information might be useful in the future when we need to decide where we want to keep and manage our users.  Feature Azure AD (B2C, B2C) AWS Cognito Access token lifetime Default 1h – the value is configurable 1h – cannot be modified

What to do when you hit the throughput limits of Azure Storage (Blobs)

In this post we will talk about how we can detect when we hit a throughput limit of Azure Storage and what we can do in that moment. Context If we take a look on Scalability Targets of Azure Storage ( https://azure.microsoft.com/en-us/documentation/articles/storage-scalability-targets/ ) we will observe that the limits are prety high. But, based on our business logic we can end up at this limits. If you create a system that is hitted by a high number of device, you can hit easily the total number of requests rate that can be done on a Storage Account. This limits on Azure is 20.000 IOPS (entities or messages per second) where (and this is very important) the size of the request is 1KB. Normally, if you make a load tests where 20.000 clients will hit different blobs storages from the same Azure Storage Account, this limits can be reached. How we can detect this problem? From client, we can detect that this limits was reached based on the HTTP error code that is returned by HTTP