Enable dim cap to Metrics API

PublicAPI/Microsoft.ApplicationInsights.dll/net45/PublicAPI.Unshipped.txt

@@ -5,4 +5,6 @@ Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointCon
 Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointContainer.Snapshot.get -> System.Uri
 Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ConnectionString.get -> string
 Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ConnectionString.set -> void
-Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EndpointContainer.get -> Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointContainer
+Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EndpointContainer.get -> Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointContainer
+Microsoft.ApplicationInsights.Metrics.MetricConfiguration.ApplyDimensionCapping.get -> bool
+Microsoft.ApplicationInsights.Metrics.MetricConfiguration.ApplyDimensionCapping.set -> void

PublicAPI/Microsoft.ApplicationInsights.dll/net46/PublicAPI.Unshipped.txt

@@ -5,4 +5,6 @@ Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointCon
 Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointContainer.Snapshot.get -> System.Uri
 Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ConnectionString.get -> string
 Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ConnectionString.set -> void
-Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EndpointContainer.get -> Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointContainer
+Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EndpointContainer.get -> Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointContainer
+Microsoft.ApplicationInsights.Metrics.MetricConfiguration.ApplyDimensionCapping.get -> bool
+Microsoft.ApplicationInsights.Metrics.MetricConfiguration.ApplyDimensionCapping.set -> void

PublicAPI/Microsoft.ApplicationInsights.dll/netstandard1.3/PublicAPI.Unshipped.txt

@@ -5,4 +5,6 @@ Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointCon
 Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointContainer.Snapshot.get -> System.Uri
 Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ConnectionString.get -> string
 Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ConnectionString.set -> void
-Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EndpointContainer.get -> Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointContainer
+Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EndpointContainer.get -> Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointContainer
+Microsoft.ApplicationInsights.Metrics.MetricConfiguration.ApplyDimensionCapping.get -> bool
+Microsoft.ApplicationInsights.Metrics.MetricConfiguration.ApplyDimensionCapping.set -> void

PublicAPI/Microsoft.ApplicationInsights.dll/netstandard2.0/PublicAPI.Unshipped.txt

@@ -5,4 +5,6 @@ Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointCon
 Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointContainer.Snapshot.get -> System.Uri
 Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ConnectionString.get -> string
 Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.ConnectionString.set -> void
-Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EndpointContainer.get -> Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointContainer
+Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration.EndpointContainer.get -> Microsoft.ApplicationInsights.Extensibility.Implementation.Endpoints.EndpointContainer
+Microsoft.ApplicationInsights.Metrics.MetricConfiguration.ApplyDimensionCapping.get -> bool
+Microsoft.ApplicationInsights.Metrics.MetricConfiguration.ApplyDimensionCapping.set -> void

src/Microsoft.ApplicationInsights/Metric.cs

@@ -61,6 +61,7 @@ internal Metric(MetricManager metricManager, MetricIdentifier metricIdentifier,
                 this.metricSeries = new MultidimensionalCube2<MetricSeries>(
                             totalPointsCountLimit: configuration.SeriesCountLimit - 1,
                             pointsFactory: this.CreateNewMetricSeries,
+                            useDimensionCap: configuration.ApplyDimensionCapping,
                             dimensionValuesCountLimits: dimensionValuesCountLimits);
 
                 this.zeroDimSeriesList = null;

src/Microsoft.ApplicationInsights/Metrics/Implementation/ConcurrentDatastructures/MultidimensionalCube2.cs

@@ -33,6 +33,7 @@ internal class MultidimensionalCube2<TPoint>
         private readonly Func<string[], TPoint> pointsFactory;
 
         private int totalPointsCount;
+        private bool useDimensionCap;
 
         public MultidimensionalCube2(Func<string[], TPoint> pointsFactory, params int[] dimensionValuesCountLimits)
             : this(Int32.MaxValue, pointsFactory, dimensionValuesCountLimits)
@@ -83,6 +84,19 @@ public MultidimensionalCube2(int totalPointsCountLimit, Func<string[], TPoint> p
             }
         }
 
+        public MultidimensionalCube2(int totalPointsCountLimit, Func<string[], TPoint> pointsFactory, bool useDimensionCap, params int[] dimensionValuesCountLimits)
+             : this(totalPointsCountLimit, pointsFactory, dimensionValuesCountLimits)
+        {
+            this.useDimensionCap = useDimensionCap;
+            if (this.useDimensionCap)
+            {
+                for (int d = 0; d < this.dimensionValuesCountLimits.Length; d++)
+                {
+                    this.dimensionValuesCountLimits[d] = this.dimensionValuesCountLimits[d] + 1;
+                }
+            }
+        }
+
         public int DimensionsCount
         {
             get { return this.dimensionValuesCountLimits.Length; }
@@ -150,17 +164,36 @@ public MultidimensionalPointResult<TPoint> TryGetOrCreatePoint(params string[] c
                 return result;
             }
 
-            this.pointCreationLock.Wait();
-            try
-            {
-                MultidimensionalPointResult<TPoint> result = this.TryCreatePoint(coordinates, pointMoniker);
-                return result;
-            }
-            finally
+            var res = this.LockAndCreatePoint(coordinates, pointMoniker);
+            if (this.useDimensionCap)
             {
-                this.pointCreationLock.Release();
+                while (res.ResultCode == MultidimensionalPointResultCodes.Failure_SubdimensionsCountLimitReached)
+                {
+                    int failedIndex = res.FailureCoordinateIndex;
+                    coordinates[failedIndex] = "DIMENSION_CAPPED";
+
+                    // retry
+                    pointMoniker = this.GetPointMoniker(coordinates);
+                    hasPoint = this.points.TryGetValue(pointMoniker, out point);
+                    if (hasPoint)
+                    {
+                        var result = new MultidimensionalPointResult<TPoint>(MultidimensionalPointResultCodes.Success_ExistingPointRetrieved, point);
+                        return result;
+                    }
+
+                    if (this.totalPointsCount >= this.totalPointsCountLimit)
+                    {
+                        var result = new MultidimensionalPointResult<TPoint>(MultidimensionalPointResultCodes.Failure_TotalPointsCountLimitReached, -1);
+                        return result;
+                    }
+
+                    // retry with Other
+                    res = this.LockAndCreatePoint(coordinates, pointMoniker, useReservedDimensionValue: true);
+                }
             }
-        }
+
+            return res;
+        }        
 
         public Task<MultidimensionalPointResult<TPoint>> TryGetOrCreatePointAsync(params string[] coordinates)
         {
@@ -258,7 +291,21 @@ private static string BuildPointMoniker(string[] coordinates)
             return builder.ToString();
         }
 
-        private MultidimensionalPointResult<TPoint> TryCreatePoint(string[] coordinates, string pointMoniker)
+        private MultidimensionalPointResult<TPoint> LockAndCreatePoint(string[] coordinates, string pointMoniker, bool useReservedDimensionValue = false)
+        {
+            this.pointCreationLock.Wait();
+            try
+            {
+                MultidimensionalPointResult<TPoint> result = this.TryCreatePoint(coordinates, pointMoniker, useReservedDimensionValue: useReservedDimensionValue);
+                return result;
+            }
+            finally
+            {
+                this.pointCreationLock.Release();
+            }
+        }
+
+        private MultidimensionalPointResult<TPoint> TryCreatePoint(string[] coordinates, string pointMoniker, bool useReservedDimensionValue = false)
         {
 #pragma warning disable SA1509 // Opening braces must not be preceded by blank line
 
@@ -293,7 +340,18 @@ private MultidimensionalPointResult<TPoint> TryCreatePoint(string[] coordinates,
                 HashSet<string> dimVals = this.dimensionValues[i];
                 string coordinateVal = coordinates[i];
 
-                if ((dimVals.Count >= this.dimensionValuesCountLimits[i]) && (false == dimVals.Contains(coordinateVal)))
+                int dimValueCap;
+                if (this.useDimensionCap)
+                {
+                    // We do DimensionCap. Do not use the reserved value unless asked to do.
+                    dimValueCap = useReservedDimensionValue ? this.dimensionValuesCountLimits[i] : this.dimensionValuesCountLimits[i] - 1;
+                }
+                else
+                {
+                    dimValueCap = this.dimensionValuesCountLimits[i];
+                }
+
+                if ((dimVals.Count >= dimValueCap) && (false == dimVals.Contains(coordinateVal)))
                 {
                     reachedValsLimitDim = i;
                     break;

src/Microsoft.ApplicationInsights/Metrics/MetricConfiguration.cs

@@ -115,6 +115,15 @@ public MetricConfiguration(
         /// that would normally result in new series will return <c>false</c>.</summary>
         public int SeriesCountLimit { get; }
 
+        /// <summary>Gets or sets a value indicating whether dimension capping should be applied, when any indiviual dimension
+        /// exceeds its limit. If this flag is set, calls to <c>TrackValue(..)</c>, <c>TryGetDataSeries(..)</c> and similar
+        /// that would normally return false when cap is hit will return true, and the actual value of dimension will be replaced
+        /// by a constant <c>DIMENSION_CAPPED</c>.
+        /// The metric will continue to track the value, however, users should be beware that any metric filtering or
+        /// splitting involving a dimension which has the value DIMENSION_CAPPED, should be ignored.
+        /// </summary>
+        public bool ApplyDimensionCapping { get; set; }
+
         /// <summary>Gets the configuration for how each series of this metric should be aggregated.</summary>
         public IMetricSeriesConfiguration SeriesConfig { get; }