Umbraco Application Lifetime Notifications

    Umbraco application lifetime notifications are published for the starting, started, stopping, and stopped events of the Umbraco runtime. These events implement the IUmbracoApplicationLifetimeNotification interface that contains a single IsRestarting property.

    A Umbraco application is restarted after an install or upgrade has been completed, so you can use this property to prevent running code twice (on initial boot and restart). To prevent running code when the application is in the install or upgrade state, inject an IRuntimeState instance in your notification and inspect the Level property instead.

    Usage

    Example usage of the UmbracoApplicationLifetime notifications:

    using Microsoft.Extensions.Logging;
    using Umbraco.Cms.Core.Composing;
    using Umbraco.Cms.Core.Events;
    using Umbraco.Cms.Core.DependencyInjection;
    using Umbraco.Cms.Core.Notifications;
    
    public class UmbracoApplicationNotificationComposer : IComposer
    {
        public void Compose(IUmbracoBuilder builder)
        {
            builder.AddNotificationHandler<UmbracoApplicationStartingNotification, UmbracoApplicationNotificationHandler>();
            builder.AddNotificationHandler<UmbracoApplicationStartedNotification, UmbracoApplicationNotificationHandler>();
            builder.AddNotificationHandler<UmbracoApplicationStoppingNotification, UmbracoApplicationNotificationHandler>();
            builder.AddNotificationHandler<UmbracoApplicationStoppedNotification, UmbracoApplicationNotificationHandler>();
        }
    }
    
    public class UmbracoApplicationNotificationHandler : INotificationHandler<UmbracoApplicationStartingNotification>, INotificationHandler<UmbracoApplicationStartedNotification>, INotificationHandler<UmbracoApplicationStoppingNotification>, INotificationHandler<UmbracoApplicationStoppedNotification>
    {
        private readonly ILogger _logger;
    
        public UmbracoApplicationNotificationHandler(ILogger<UmbracoApplicationNotificationHandler> logger) => _logger = logger;
    
        public void Handle(UmbracoApplicationStartingNotification notification) => Log(notification, notification.IsRestarting);
    
        public void Handle(UmbracoApplicationStartedNotification notification) => Log(notification, notification.IsRestarting);
    
        public void Handle(UmbracoApplicationStoppingNotification notification) => Log(notification, notification.IsRestarting);
    
        public void Handle(UmbracoApplicationStoppedNotification notification) => Log(notification, notification.IsRestarting);
    
        private void Log(INotification notification, bool isRestarting) => _logger.LogInformation("{Type} - {IsRestarting}", notification.GetType().Name, isRestarting);
    }
    

    Notifications

    Notification Members Description
    UmbracoApplicationStartingNotification
    • RuntimeLevel RuntimeLevel
    • bool IsRestarting
    Triggered when the application is starting after all IComponents are initialized but before any incoming requests are accepted.
    1. RuntimeLevel: Gets the runtime level.
    2. IsRestarting: Gets a value indicating whether Umbraco is restarting (e.g. after an install or upgrade).
    UmbracoApplicationStartedNotification
    • bool IsRestarting
    Triggered when the application has fully started and is accepting incoming requests.
    1. IsRestarting: Gets a value indicating whether Umbraco is restarting (e.g. after an install or upgrade).
    UmbracoApplicationStoppingNotification
    • bool IsRestarting
    Triggered when the application is performing a graceful shutdown after all IComponents are terminated.
    1. IsRestarting: Gets a value indicating whether Umbraco is restarting (e.g. after an install or upgrade).
    UmbracoApplicationStoppedNotification
    • bool IsRestarting
    Triggered when the application has performed a graceful shutdown.
    1. IsRestarting: Gets a value indicating whether Umbraco is restarting (e.g. after an install or upgrade).