src/WebJobs.Script/Diagnostics/Extensions/LoggerExtension.cs

// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

using System;
using Microsoft.Extensions.Logging;
using static System.Environment;

namespace Microsoft.Azure.WebJobs.Script.Diagnostics.Extensions
{
    internal static class LoggerExtension
    {
        // EventId range is 300-399

        private static readonly Action<ILogger, Exception> _extensionsManagerRestoring =
            LoggerMessage.Define(LogLevel.Information,
                new EventId(300, nameof(ExtensionsManagerRestoring)),
                "Restoring extension packages");

        private static readonly Action<ILogger, Exception> _extensionsManagerRestoreSucceeded =
            LoggerMessage.Define(LogLevel.Information,
                new EventId(301, nameof(ExtensionsManagerRestoreSucceeded)),
                "Extensions packages restore succeeded.'");

        private static readonly Action<ILogger, Exception> _scriptStartUpErrorLoadingExtensionBundle =
            LoggerMessage.Define(LogLevel.Error,
                new EventId(302, nameof(ScriptStartUpErrorLoadingExtensionBundle)),
                "Unable to find or download extension bundle");

        private static readonly Action<ILogger, string, Exception> _scriptStartUpLoadingExtensionBundle =
           LoggerMessage.Define<string>(LogLevel.Information,
               new EventId(303, nameof(ScriptStartUpLoadingExtensionBundle)),
               "Loading extension bundle from {path}");

        private static readonly Action<ILogger, string, Exception> _scriptStartUpLoadingStartUpExtension =
            LoggerMessage.Define<string>(LogLevel.Information,
                new EventId(304, nameof(ScriptStartUpLoadingStartUpExtension)),
                "Loading startup extension '{startupExtensionName}'");

        private static readonly Action<ILogger, string, Exception> _scriptStartUpBelongExtension =
            LoggerMessage.Define<string>(LogLevel.Warning,
                new EventId(305, nameof(ScriptStartUpBelongExtension)),
                "The extension startup type '{typeName}' belongs to a builtin extension");

        private static readonly Action<ILogger, string, string, Exception> _scriptStartUpUnableToLoadExtension =
            LoggerMessage.Define<string, string>(LogLevel.Warning,
                new EventId(306, nameof(ScriptStartUpUnableToLoadExtension)),
                "Unable to load startup extension '{startupExtensionName}' (Type: '{typeName}'). The type does not exist. Please validate the type and assembly names.");

        private static readonly Action<ILogger, string, string, string, Exception> _scriptStartUpTypeIsNotValid =
            LoggerMessage.Define<string, string, string>(LogLevel.Warning,
                new EventId(307, nameof(ScriptStartUpTypeIsNotValid)),
                "Type '{typeName}' is not a valid startup extension. The type does not implement {startupClassName} or {startupConfigurationClassName}.");

        private static readonly Action<ILogger, string, Exception> _scriptStartUpUnableParseMetadataMissingProperty =
            LoggerMessage.Define<string>(LogLevel.Error,
                new EventId(308, nameof(ScriptStartUpUnableParseMetadataMissingProperty)),
                "Unable to parse extensions metadata file '{metadataFilePath}'. Missing 'extensions' property.");

        private static readonly Action<ILogger, string, Exception> _scriptStartUpUnableParseMetadata =
            LoggerMessage.Define<string>(LogLevel.Error,
                new EventId(309, nameof(ScriptStartUpUnableParseMetadata)),
                "Unable to parse extensions metadata file '{metadataFilePath}'");

        private static readonly Action<ILogger, Exception> _packageManagerStartingPackagesRestore =
            LoggerMessage.Define(LogLevel.Information,
                new EventId(310, nameof(PackageManagerStartingPackagesRestore)),
                "Starting packages restore");

        private static readonly Action<ILogger, string, Exception> _packageManagerRestoreFailed =
            LoggerMessage.Define<string>(LogLevel.Error,
                new EventId(311, nameof(PackageManagerRestoreFailed)),
                "{message}");

        private static readonly Action<ILogger, string, Exception> _packageManagerProcessDataReceived =
            LoggerMessage.Define<string>(LogLevel.Information,
                new EventId(312, nameof(PackageManagerProcessDataReceived)),
                "{message}");

        private static readonly Action<ILogger, Exception> _debugManagerUnableToUpdateSentinelFile =
            LoggerMessage.Define(LogLevel.Error,
                new EventId(313, nameof(DebugManagerUnableToUpdateSentinelFile)),
                "Unable to update the debug sentinel file.");

        private static readonly Action<ILogger, Exception> _functionMetadataManagerLoadingFunctionsMetadata =
            LoggerMessage.Define(LogLevel.Information,
                new EventId(314, nameof(FunctionMetadataManagerLoadingFunctionsMetadata)),
                "Loading functions metadata");

        private static readonly Action<ILogger, int, Exception> _functionMetadataManagerFunctionsLoaded =
            LoggerMessage.Define<int>(LogLevel.Information,
                new EventId(315, nameof(FunctionMetadataManagerFunctionsLoaded)),
                "{count} functions loaded");

        private static readonly Action<ILogger, string, string, Exception> _autoRecoveringFileSystemWatcherFailureDetected =
            LoggerMessage.Define<string, string>(LogLevel.Warning,
                new EventId(320, nameof(AutoRecoveringFileSystemWatcherFailureDetected)),
                "Failure detected '{errorMessage}'. Initiating recovery... (path: '{path}')");

        private static readonly Action<ILogger, string, Exception> _autoRecoveringFileSystemWatcherRecoveryAborted =
            LoggerMessage.Define<string>(LogLevel.Error,
                new EventId(321, nameof(AutoRecoveringFileSystemWatcherRecoveryAborted)),
                "Recovery process aborted. (path: '{path}')");

        private static readonly Action<ILogger, string, Exception> _autoRecoveringFileSystemWatcherRecovered =
            LoggerMessage.Define<string>(LogLevel.Information,
                new EventId(322, nameof(AutoRecoveringFileSystemWatcherRecovered)),
                "File watcher recovered. (path: '{path}')");

        private static readonly Action<ILogger, string, Exception> _autoRecoveringFileSystemWatcherAttemptingToRecover =
            LoggerMessage.Define<string>(LogLevel.Warning,
                new EventId(323, nameof(AutoRecoveringFileSystemWatcherAttemptingToRecover)),
                "Attempting to recover... (path: '{path}')");

        private static readonly Action<ILogger, string, Exception> _autoRecoveringFileSystemWatcherUnableToRecover =
            LoggerMessage.Define<string>(LogLevel.Error,
                new EventId(324, nameof(AutoRecoveringFileSystemWatcherUnableToRecover)),
                "Unable to recover (path: '{path}')");

        private static readonly Action<ILogger, string, string, Exception> _scriptStartUpLoadedExtension =
            LoggerMessage.Define<string, string>(LogLevel.Information,
                new EventId(325, nameof(ScriptStartUpLoadedExtension)),
                "Loaded extension '{startupExtensionName}' ({startupExtensionVersion})");

        private static readonly Action<ILogger, string, Exception> _readingFunctionMetadataFromProvider =
            LoggerMessage.Define<string>(LogLevel.Information,
                new EventId(326, nameof(ReadingFunctionMetadataFromProvider)),
                "Reading functions metadata ({provider})");

        private static readonly Action<ILogger, int, string, Exception> _functionsReturnedByProvider =
            LoggerMessage.Define<int, string>(LogLevel.Information,
                new EventId(327, nameof(FunctionsReturnedByProvider)),
                "{count} functions found ({provider})");

        private static readonly Action<ILogger, string, Guid, Exception> _customHandlerForwardingHttpTriggerInvocation =
            LoggerMessage.Define<string, Guid>(LogLevel.Debug,
                new EventId(328, nameof(CustomHandlerForwardingHttpTriggerInvocation)),
                "Forwarding httpTrigger invocation for function: '{functionName}' invocationId: '{invocationId}'");

        private static readonly Action<ILogger, string, Guid, Exception> _customHandlerSendingInvocation =
           LoggerMessage.Define<string, Guid>(LogLevel.Debug,
               new EventId(329, nameof(CustomHandlerSendingInvocation)),
               "Sending invocation for function: '{functionName}' invocationId: '{invocationId}'");

        private static readonly Action<ILogger, string, Guid, Exception> _customHandlerReceivedInvocationResponse =
           LoggerMessage.Define<string, Guid>(LogLevel.Debug,
               new EventId(330, nameof(CustomHandlerReceivedInvocationResponse)),
               "Received invocation response for function: '{functionName}' invocationId: '{invocationId}'");

        private static readonly Action<ILogger, Exception> _jobHostFunctionTimeoutNotSet =
            LoggerMessage.Define(LogLevel.Information,
                new EventId(331, nameof(JobHostFunctionTimeoutNotSet)),
                "FunctionTimeout is not set.");

        private static readonly Action<ILogger, string, Exception> _autorestGeneratedFunctionApplication =
            LoggerMessage.Define<string>(LogLevel.Information,
                new EventId(332, nameof(AutorestGeneratedFunctionApplication)),
                "autorest_generated.json file found generated by Autorest (https://aka.ms/stencil) | file content:\n{sanitizedAutorestJson}");

        private static readonly Action<ILogger, string, Exception> _incorrectAutorestGeneratedJSONFile =
            LoggerMessage.Define<string>(LogLevel.Warning,
                new EventId(333, nameof(IncorrectAutorestGeneratedJsonFile)),
                "autorest_generated.json file found is incorrect (https://aka.ms/stencil) | exception:\n{contents}");

        private static readonly Action<ILogger, string, bool, bool, bool, bool, bool, Exception> _scriptStartUpNotLoadingExtensionBundle =
            LoggerMessage.Define<string, bool, bool, bool, bool, bool>(LogLevel.Information,
                new EventId(334, nameof(ScriptStartNotLoadingExtensionBundle)),
                "Extension Bundle not loaded. Loading extensions from {path}. BundleConfigured: {bundleConfigured}, PrecompiledFunctionApp: {isPrecompiledFunctionApp}, LegacyBundle: {isLegacyExtensionBundle}, DotnetIsolatedApp: {isDotnetIsolatedApp}, isLogicApp: {isLogicApp}");

        private static readonly Action<ILogger, string, Exception> _scriptStartupResettingLoadContextWithBasePath =
            LoggerMessage.Define<string>(LogLevel.Information,
                new EventId(335, nameof(ScriptStartupResettingLoadContextWithBasePath)),
                "Script Startup resetting load context with base path: '{path}'.");

        private static readonly Action<ILogger, string, string, Version, string, string, Exception> _minimumExtensionVersionNotSatisfied =
            LoggerMessage.Define<string, string, Version, string, string>(
            LogLevel.Error,
            new EventId(336, nameof(MinimumExtensionVersionNotSatisfied)),
            "ExtensionStartupType {extensionTypeName} from assembly '{extensionTypeAssemblyFullName}' does not meet the required minimum version of {minimumAssemblyVersion}. Update your NuGet package reference for {requirementPackageName} to {requirementMinimumPackageVersion} or later.");

        private static readonly Action<ILogger, string, string, string, string, Exception> _minimumBundleVersionNotSatisfied =
            LoggerMessage.Define<string, string, string, string>(
            LogLevel.Error,
            new EventId(337, nameof(MinimumBundleVersionNotSatisfied)),
            "Referenced bundle {bundleId} of version {bundleVersion} does not meet the required minimum version of {minimumVersion}. Update your extension bundle reference in host.json to reference {minimumVersion2} or later.");

        private static readonly Action<ILogger, string, Exception> _hostJsonZipDeploymentIssue =
    LoggerMessage.Define<string>(LogLevel.Error,
        new EventId(338, nameof(HostJsonZipDeploymentIssue)),
        "No functions were found. A valid host.json file wasn't found in the package root. However, one was located at: {hostJsonFilesPath}. This state indicates that your deployment package was created incorrectly. For deployment package requirements, see https://aka.ms/deployment-zip-push.");

        private static readonly Action<ILogger, Exception> _noHostJsonFile =
    LoggerMessage.Define(LogLevel.Information,
        new EventId(339, nameof(NoHostJsonFile)),
        "No functions were found. This can occur before you deploy code to your function app or when the host.json file is missing from the most recent deployment. Make sure that your deployment package includes the host.json file in the root of the package. For deployment package requirements, see https://aka.ms/functions-deployment-technologies.");

        private static readonly Action<ILogger, string, Exception> _publishingMetrics =
            LoggerMessage.Define<string>(LogLevel.Debug, new EventId(338, nameof(PublishingMetrics)), "{metrics}");

        public static void PublishingMetrics(this ILogger logger, string metrics)
        {
            _publishingMetrics(logger, metrics, null);
        }

        public static void ExtensionsManagerRestoring(this ILogger logger)
        {
            _extensionsManagerRestoring(logger, null);
        }

        public static void ExtensionsManagerRestoreSucceeded(this ILogger logger)
        {
            _extensionsManagerRestoreSucceeded(logger, null);
        }

        public static void ScriptStartUpErrorLoadingExtensionBundle(this ILogger logger)
        {
            _scriptStartUpErrorLoadingExtensionBundle(logger, null);
        }

        public static void ScriptStartUpLoadingExtensionBundle(this ILogger logger, string path)
        {
            _scriptStartUpLoadingExtensionBundle(logger, path, null);
        }

        public static void ScriptStartupResettingLoadContextWithBasePath(this ILogger logger, string path)
        {
            _scriptStartupResettingLoadContextWithBasePath(logger, path, null);
        }

        public static void ScriptStartNotLoadingExtensionBundle(this ILogger logger, string path, bool bundleConfigured, bool isPrecompiledFunctionApp, bool isLegacyExtensionBundle, bool isDotnetIsolatedApp, bool isLogicApp)
        {
            _scriptStartUpNotLoadingExtensionBundle(logger, path, bundleConfigured, isPrecompiledFunctionApp, isLegacyExtensionBundle, isDotnetIsolatedApp, isLogicApp, null);
        }

        public static void ScriptStartUpLoadingStartUpExtension(this ILogger logger, string startupExtensionName)
        {
            _scriptStartUpLoadingStartUpExtension(logger, startupExtensionName, null);
        }

        public static void ScriptStartUpLoadedExtension(this ILogger logger, string startupExtensionName, string startupExtensionVersion)
        {
            _scriptStartUpLoadedExtension(logger, startupExtensionName, startupExtensionVersion, null);
        }

        public static void ScriptStartUpBelongExtension(this ILogger logger, string typeName)
        {
            _scriptStartUpBelongExtension(logger, typeName, null);
        }

        public static void ScriptStartUpUnableToLoadExtension(this ILogger logger, string startupExtensionName, string typeName)
        {
            _scriptStartUpUnableToLoadExtension(logger, startupExtensionName, typeName, null);
        }

        public static void ScriptStartUpTypeIsNotValid(this ILogger logger, string typeName, string startupClassName, string startupConfigurationClassName)
        {
            _scriptStartUpTypeIsNotValid(logger, typeName, startupClassName, startupConfigurationClassName, null);
        }

        public static void ScriptStartUpUnableParseMetadataMissingProperty(this ILogger logger, string metadataFilePath)
        {
            _scriptStartUpUnableParseMetadataMissingProperty(logger, metadataFilePath, null);
        }

        public static void ScriptStartUpUnableParseMetadata(this ILogger logger, Exception ex, string metadataFilePath)
        {
            _scriptStartUpUnableParseMetadata(logger, metadataFilePath, null);
        }

        public static void PackageManagerStartingPackagesRestore(this ILogger logger)
        {
            _packageManagerStartingPackagesRestore(logger, null);
        }

        public static void PackageManagerRestoreFailed(this ILogger logger, Exception ex, string functionDirectory, string projectPath, string nugetHome, string nugetFilePath, string currentLockFileHash)
        {
            string message = $@"Package restore failed with message: '{ex.Message}'
Function directory: {functionDirectory}
Project path: {projectPath}
Packages path: {nugetHome}
Nuget client path: {nugetFilePath}
Lock file hash: {currentLockFileHash}";

            _packageManagerRestoreFailed(logger, message, null);
        }

        public static void PackageManagerProcessDataReceived(this ILogger logger, string message)
        {
            _packageManagerProcessDataReceived(logger, message, null);
        }

        public static void DebugManagerUnableToUpdateSentinelFile(this ILogger logger, Exception ex)
        {
            _debugManagerUnableToUpdateSentinelFile(logger, ex);
        }

        public static void FunctionMetadataManagerLoadingFunctionsMetadata(this ILogger logger)
        {
            _functionMetadataManagerLoadingFunctionsMetadata(logger, null);
        }

        public static void ReadingFunctionMetadataFromProvider(this ILogger logger, string provider)
        {
            _readingFunctionMetadataFromProvider(logger, provider, null);
        }

        public static void FunctionMetadataManagerFunctionsLoaded(this ILogger logger, int count)
        {
            _functionMetadataManagerFunctionsLoaded(logger, count, null);
        }

        public static void FunctionsReturnedByProvider(this ILogger logger, int count, string provider)
        {
            _functionsReturnedByProvider(logger, count, provider, null);
        }

        public static void AutoRecoveringFileSystemWatcherFailureDetected(this ILogger logger, string errorMessage, string path)
        {
            _autoRecoveringFileSystemWatcherFailureDetected(logger, errorMessage, path, null);
        }

        public static void AutoRecoveringFileSystemWatcherRecoveryAborted(this ILogger logger, string path)
        {
            _autoRecoveringFileSystemWatcherRecoveryAborted(logger, path, null);
        }

        public static void AutoRecoveringFileSystemWatcherRecovered(this ILogger logger, string path)
        {
            _autoRecoveringFileSystemWatcherRecovered(logger, path, null);
        }

        public static void AutoRecoveringFileSystemWatcherAttemptingToRecover(this ILogger logger, string path)
        {
            _autoRecoveringFileSystemWatcherAttemptingToRecover(logger, path, null);
        }

        public static void AutoRecoveringFileSystemWatcherUnableToRecover(this ILogger logger, Exception ex, string path)
        {
            _autoRecoveringFileSystemWatcherUnableToRecover(logger, path, ex);
        }

        public static void CustomHandlerForwardingHttpTriggerInvocation(this ILogger logger, string functionName, Guid invocationId)
        {
            _customHandlerForwardingHttpTriggerInvocation(logger, functionName, invocationId, null);
        }

        public static void CustomHandlerSendingInvocation(this ILogger logger, string functionName, Guid invocationId)
        {
            _customHandlerSendingInvocation(logger, functionName, invocationId, null);
        }

        public static void CustomHandlerReceivedInvocationResponse(this ILogger logger, string functionName, Guid invocationId)
        {
            _customHandlerReceivedInvocationResponse(logger, functionName, invocationId, null);
        }

        public static void JobHostFunctionTimeoutNotSet(this ILogger logger)
        {
            _jobHostFunctionTimeoutNotSet(logger, null);
        }

        public static void AutorestGeneratedFunctionApplication(this ILogger logger, string sanitizedAutorestJson)
        {
            _autorestGeneratedFunctionApplication(logger, sanitizedAutorestJson, null);
        }

        public static void IncorrectAutorestGeneratedJsonFile(this ILogger logger, string contents)
        {
            _incorrectAutorestGeneratedJSONFile(logger, contents, null);
        }

        public static void MinimumExtensionVersionNotSatisfied(this ILogger logger, string extensionTypeName, string extensionTypeAssemblyFullName, Version minimumAssemblyVersion, string requirementPackageName, string requirementMinimumPackageVersion)
        {
            _minimumExtensionVersionNotSatisfied(logger, extensionTypeName, extensionTypeAssemblyFullName, minimumAssemblyVersion, requirementPackageName, requirementMinimumPackageVersion, null);
        }

        public static void MinimumBundleVersionNotSatisfied(this ILogger logger, string bundleId, string bundleVersion, string minimumVersion)
        {
            _minimumBundleVersionNotSatisfied(logger, bundleId, bundleVersion, minimumVersion, minimumVersion, null);
        }

        public static void HostJsonZipDeploymentIssue(this ILogger logger, string path)
        {
            _hostJsonZipDeploymentIssue(logger, path, null);
        }

        public static void NoHostJsonFile(this ILogger logger)
        {
            _noHostJsonFile(logger, null);
        }
    }
}