sqltoolsservice/src/Microsoft.SqlTools.Migration/Contracts/GetSkuRecommendationsRequest.cs

//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//

using Microsoft.SqlServer.Migration.SkuRecommendation.Contracts.Models;
using Microsoft.SqlServer.Migration.SkuRecommendation.Models.Sql;
using Microsoft.SqlTools.Hosting.Protocol.Contracts;
using System.Collections.Generic;

namespace Microsoft.SqlTools.Migration.Contracts
{
    public class GetSkuRecommendationsParams
    {
        /// <summary>
        /// Folder from which collected performance data will be read from
        /// </summary>
        public string DataFolder { get; set; }

        /// <summary>
        /// Interval at which collected performance data was originally queried at, in seconds
        /// </summary>
        public int PerfQueryIntervalInSec { get; set; }

        /// <summary>
        /// List of target platforms to consider when generating recommendations
        /// </summary>
        public List<string> TargetPlatforms { get; set; }

        /// <summary>
        /// Name of the SQL instance to generate recommendations for
        /// </summary>
        public string TargetSqlInstance { get; set; }

        /// <summary>
        /// Target percentile to use when performing perf data aggregation
        /// </summary>
        public int TargetPercentile { get; set; }

        /// <summary>
        /// Scaling ("comfort") factor when evalulating performance requirements
        /// </summary>
        public int ScalingFactor { get; set; }

        /// <summary>
        /// Start time of collected data points to consider 
        /// 
        /// TO-DO: do we really need this? it's pretty safe to assume that most users would want us to evaluate all the collected data and not just part of it
        /// </summary>
        public string StartTime { get; set; }

        /// <summary>
        /// End time of collected data points to consider
        /// 
        /// TO-DO: do we really need this? it's pretty safe to assume that most users would want us to evaluate all the collected data and not just part of it
        /// </summary>
        public string EndTime { get; set; }

        /// <summary>
        /// Whether or not to consider preview SKUs when generating SKU recommendations
        /// </summary>
        public bool IncludePreviewSkus { get; set; }

        /// <summary>
        /// List of databases to consider when generating recommendations
        /// </summary>
        public List<string> DatabaseAllowList { get; set; }
    }

    public class GetSkuRecommendationsResult
    {
        /// <summary>
        /// List of SQL DB recommendation results, if applicable
        /// </summary>
        public List<SkuRecommendationResult> SqlDbRecommendationResults { get; set; }

        /// <summary>
        /// How long the SQL DB recommendations took to generate, in milliseconds. Equal to -1 if SQL DB recommendations are not applicable.
        /// </summary>
        public long SqlDbRecommendationDurationInMs { get; set; }

        /// <summary>
        /// List of SQL MI recommendation results, if applicable
        /// </summary>
        public List<SkuRecommendationResult> SqlMiRecommendationResults { get; set; }

        /// <summary>
        /// How long the SQL MI recommendations took to generate, in milliseconds. Equal to -1 if SQL MI recommendations are not applicable.
        /// </summary>
        public long SqlMiRecommendationDurationInMs { get; set; }

        /// <summary>
        /// List of SQL VM recommendation results, if applicable
        /// </summary>
        public List<SkuRecommendationResult> SqlVmRecommendationResults { get; set; }

        /// <summary>
        /// How long the SQL VM recommendations took to generate, in milliseconds. Equal to -1 if SQL VM recommendations are not applicable.
        /// </summary>
        public long SqlVmRecommendationDurationInMs { get; set; }

        /// <summary>
        /// List of SQL DB recommendation results generated by the elastic model, if applicable
        /// </summary>
        public List<SkuRecommendationResult> ElasticSqlDbRecommendationResults { get; set; }

        /// <summary>
        /// How long the SQL DB recommendations took to generate using the elastic model, in milliseconds. Equal to -1 if SQL DB elastic recommendations are not applicable.
        /// </summary>
        public long ElasticSqlDbRecommendationDurationInMs { get; set; }

        /// <summary>
        /// List of SQL MI recommendation results generated by the elastic model, if applicable
        /// </summary>
        public List<SkuRecommendationResult> ElasticSqlMiRecommendationResults { get; set; }

        /// <summary>
        /// How long the SQL MI recommendations took to generate using the elastic model, in milliseconds. Equal to -1 if SQL MI elastic recommendations are not applicable.
        /// </summary>
        public long ElasticSqlMiRecommendationDurationInMs { get; set; }

        /// <summary>
        /// List of SQL VM recommendation results generated by the elastic model, if applicable
        /// </summary>
        public List<SkuRecommendationResult> ElasticSqlVmRecommendationResults { get; set; }

        /// <summary>
        /// How long the SQL VM recommendations took to generate using the elastic model, in milliseconds. Equal to -1 if SQL VM elastic recommendations are not applicable.
        /// </summary>
        public long ElasticSqlVmRecommendationDurationInMs { get; set; }

        /// <summary>
        /// SQL instance requirements, representing an aggregated view of the performance requirements of the source instance
        /// </summary>
        public SqlInstanceRequirements InstanceRequirements { get; set; }

        /// <summary>
        /// File paths where the recommendation reports were saved
        /// </summary>
        public List<string> SkuRecommendationReportPaths { get; set; }

        /// <summary>
        /// File paths where the recommendation reports generated by the elastic model were saved
        /// </summary>
        public List<string> ElasticSkuRecommendationReportPaths { get; set; }
    }

    // Helper class containing recommendation results, durations, and report paths, which is recommendation model-agnostic
    internal class RecommendationResultSet {
        internal List<SkuRecommendationResult> sqlDbResults;
        internal List<SkuRecommendationResult> sqlMiResults;
        internal List<SkuRecommendationResult> sqlVmResults;
        internal long sqlDbDurationInMs;
        internal long sqlMiDurationInMs;
        internal long sqlVmDurationInMs;
        internal string sqlDbReportPath;
        internal string sqlMiReportPath;
        internal string sqlVmReportPath;

        // Create a new empty RecommendationResultSet
        internal RecommendationResultSet()
        {
            this.sqlDbResults = new List<SkuRecommendationResult>();
            this.sqlMiResults = new List<SkuRecommendationResult>();
            this.sqlVmResults = new List<SkuRecommendationResult>();
            this.sqlDbDurationInMs = -1;
            this.sqlMiDurationInMs = -1;
            this.sqlVmDurationInMs = -1;
            this.sqlDbReportPath = "";
            this.sqlMiReportPath = "";
            this.sqlVmReportPath = "";
        }
    }

    public class GetSkuRecommendationsRequest
    {
        public static readonly
            RequestType<GetSkuRecommendationsParams, GetSkuRecommendationsResult> Type =
                RequestType<GetSkuRecommendationsParams, GetSkuRecommendationsResult>.Create("migration/getskurecommendations");
    }
}