Merge pull request #129 from PrometheusClientNet/performance-tweaks

sanych-sun · web-flow · commit d3124162e256 · 2021-01-21T12:43:05.000-08:00
Performance tweaks
diff --git a/src/Prometheus.Client/Collectors/CollectorRegistry.cs b/src/Prometheus.Client/Collectors/CollectorRegistry.cs
@@ -200,7 +200,8 @@ private void AddInternal(ICollector collector)
 
             _collectors.Add(collector.Configuration.Name, collector);
             _usedMetricNames.UnionWith(collector.MetricNames);
-            _enumerableCollectors = new Lazy<IEnumerable<ICollector>>(GetImmutableValueCollection);
+            if (_enumerableCollectors.IsValueCreated)
+                _enumerableCollectors = new Lazy<IEnumerable<ICollector>>(GetImmutableValueCollection);
         }
 
         private IEnumerable<ICollector> GetImmutableValueCollection()
diff --git a/src/Prometheus.Client/LabelsHelper.cs b/src/Prometheus.Client/LabelsHelper.cs
@@ -79,10 +79,11 @@ public static int GetHashCode(IReadOnlyList<string> values)
             // do not use for-each here, it allocates which is easy to avoid by for loop
             for (var i = 0; i < values.Count; i++)
             {
-                if(values[i] == null)
+                var val = values[i];
+                if(string.IsNullOrEmpty(val))
                     throw new ArgumentException("Label value cannot be empty");
 
-                result = HashCode.Combine(result, values[i].GetHashCode());
+                result = HashCombine(result, val.GetHashCode());
             }
 
             return result;
@@ -202,6 +203,13 @@ private static void Fill<T>(this IList<T> target, T value, int offset, int size)
             }
         }
 
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        private static int HashCombine(int h1, int h2)
+        {
+            uint rol5 = ((uint)h1 << 5) | ((uint)h1 >> 27);
+            return ((int)rol5 + h1) ^ h2;
+        }
+
         private static bool Validate(Type tupleType)
         {
             if (tupleType == typeof(ValueTuple))
@@ -256,9 +264,9 @@ public static int GetTupleHashCode(TTuple values)
             {
                 return HashCodeReducer(values, 0, (item, _, aggregated) =>
                 {
-                    if(item == null)
+                    if(string.IsNullOrEmpty(item))
                         throw new ArgumentException("Label value cannot be empty");
-                    return HashCode.Combine(aggregated, item.GetHashCode());
+                    return HashCombine(aggregated, item.GetHashCode());
                 });
             }
 
diff --git a/src/Prometheus.Client/MetricFactory.cs b/src/Prometheus.Client/MetricFactory.cs
@@ -538,14 +538,8 @@ private static void ValidateLabelNames(IReadOnlyList<string> expectedNames, IRea
             expectedNames ??= Array.Empty<string>();
             actualNames ??= Array.Empty<string>();
 
-            if (expectedNames.Count != actualNames.Count)
+            if (LabelsHelper.GetHashCode(expectedNames) != LabelsHelper.GetHashCode(actualNames))
                 ThrowLabelsValidationException();
-
-            for (var i = 0; i < expectedNames.Count; i++)
-            {
-                if(expectedNames[i] != actualNames[i])
-                    ThrowLabelsValidationException();
-            }
         }
 
         private static void ThrowLabelsValidationException()
diff --git a/src/Prometheus.Client/MetricFamily.cs b/src/Prometheus.Client/MetricFamily.cs
@@ -72,7 +72,7 @@ TMetric IMetricFamily<TMetric>.WithLabels(params string[] labels)
                 return metric;
             }
 
-            metric = CreateLabelled(labels);
+            metric = _instanceFactory(_configuration, labels);
             return _labelledMetrics.GetOrAdd(key, metric);
         }
 
@@ -108,7 +108,7 @@ public TMetric WithLabels(TLabels labels)
                 return metric;
             }
 
-            metric = CreateLabelled(LabelsHelper.ToArray(labels));
+            metric = _instanceFactory(_configuration, LabelsHelper.ToArray(labels));
             return _labelledMetrics.GetOrAdd(key, metric);
         }
 
@@ -155,16 +155,5 @@ private IEnumerable<KeyValuePair<IReadOnlyList<string>, TMetric>> EnumerateLabel
             foreach (var labelled in _labelledMetrics)
                 yield return new KeyValuePair<IReadOnlyList<string>, TMetric>(labelled.Value.LabelValues, labelled.Value);
         }
-
-        private TImplementation CreateLabelled(IReadOnlyList<string> labels)
-        {
-            for (var i = 0; i < labels.Count; i++)
-            {
-                if(string.IsNullOrEmpty(labels[i]))
-                    throw new ArgumentException("Label cannot be empty.");
-            }
-
-            return _instanceFactory(_configuration, labels);
-        }
     }
 }
diff --git a/src/Prometheus.Client/Prometheus.Client.csproj b/src/Prometheus.Client/Prometheus.Client.csproj
@@ -38,7 +38,6 @@
   <ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
     <PackageReference Include="System.Memory" Version="4.5.4" />
     <PackageReference Include="System.Buffers" Version="4.5.1" />
-    <PackageReference Include="Microsoft.Bcl.HashCode" Version="1.1.1" />
   </ItemGroup>
   <PropertyGroup Condition=" '$(TargetFramework)' == 'netstandard2.1' OR '$(TargetFramework)' == 'netcoreapp2.2'">
     <DefineConstants>$(DefineConstants);HasITuple;HasNativeSpans;</DefineConstants>
diff --git a/tests/Prometheus.Client.Benchmarks.Comparison/Counter/CounterGeneralUseCaseBenchmarks.cs b/tests/Prometheus.Client.Benchmarks.Comparison/Counter/CounterGeneralUseCaseBenchmarks.cs
@@ -74,7 +74,7 @@ public void WithLabels_Array()
         {
             for (var i = 0; i < _metricsCount; i++)
             {
-                var counter = OurMetricFactory.CreateCounter(_metricNames[i], HelpText, "foo", "bar", "baz");
+                var counter = OurMetricFactory.CreateCounter(_metricNames[i], HelpText, false, "foo", "bar", "baz");
                 counter.Inc();
             }
         }
@@ -96,7 +96,7 @@ public void WithLabels_Int64Array()
         {
             for (var i = 0; i < _metricsCount; i++)
             {
-                var counter = OurMetricFactory.CreateCounterInt64(_metricNames[i], HelpText, "foo", "bar", "baz");
+                var counter = OurMetricFactory.CreateCounterInt64(_metricNames[i], HelpText, false, "foo", "bar", "baz");
                 counter.Inc();
             }
         }
@@ -130,7 +130,7 @@ public void WithLabelsAndSamples_Array()
         {
             for (var i = 0; i < _metricsCount; i++)
             {
-                var counter = OurMetricFactory.CreateCounter(_metricNames[i], HelpText, "foo", "bar", "baz");
+                var counter = OurMetricFactory.CreateCounter(_metricNames[i], HelpText, false, "foo", "bar", "baz");
                 for(var j = 0; j < _labelValues.Length; j++)
                     counter.WithLabels(_labelValues[j][0], _labelValues[j][1], _labelValues[j][2]).Inc();
             }
@@ -154,7 +154,7 @@ public void WithLabelsAndSamples_Int64Array()
         {
             for (var i = 0; i < _metricsCount; i++)
             {
-                var counter = OurMetricFactory.CreateCounterInt64(_metricNames[i], HelpText, "foo", "bar", "baz");
+                var counter = OurMetricFactory.CreateCounterInt64(_metricNames[i], HelpText, false, "foo", "bar", "baz");
                 for(var j = 0; j < _labelValues.Length; j++)
                     counter.WithLabels(_labelValues[j][0], _labelValues[j][1], _labelValues[j][2]).Inc();
             }
diff --git a/tests/Prometheus.Client.Benchmarks.Comparison/Gauge/GaugeGeneralUseCaseBenchmarks.cs b/tests/Prometheus.Client.Benchmarks.Comparison/Gauge/GaugeGeneralUseCaseBenchmarks.cs
@@ -74,7 +74,7 @@ public void WithLabels_Array()
         {
             for (var i = 0; i < _metricsCount; i++)
             {
-                var gauge = OurMetricFactory.CreateGauge(_metricNames[i], HelpText, "foo", "bar", "baz");
+                var gauge = OurMetricFactory.CreateGauge(_metricNames[i], HelpText, false, "foo", "bar", "baz");
                 gauge.Inc();
             }
         }
@@ -96,7 +96,7 @@ public void WithLabels_Int64Array()
         {
             for (var i = 0; i < _metricsCount; i++)
             {
-                var gauge = OurMetricFactory.CreateGaugeInt64(_metricNames[i], HelpText, "foo", "bar", "baz");
+                var gauge = OurMetricFactory.CreateGaugeInt64(_metricNames[i], HelpText, false, "foo", "bar", "baz");
                 gauge.Inc();
             }
         }
@@ -130,7 +130,7 @@ public void WithLabelsAndSamples_Array()
         {
             for (var i = 0; i < _metricsCount; i++)
             {
-                var gauge = OurMetricFactory.CreateGauge(_metricNames[i], HelpText, "foo", "bar", "baz");
+                var gauge = OurMetricFactory.CreateGauge(_metricNames[i], HelpText, false, "foo", "bar", "baz");
                 for(var j = 0; j < _samplesCount; j++)
                     gauge.WithLabels(_labelValues[j][0], _labelValues[j][1], _labelValues[j][2]).Inc();
             }
@@ -154,7 +154,7 @@ public void WithLabelsAndSamples_Int64Array()
         {
             for (var i = 0; i < _metricsCount; i++)
             {
-                var gauge = OurMetricFactory.CreateGaugeInt64(_metricNames[i], HelpText, "foo", "bar", "baz");
+                var gauge = OurMetricFactory.CreateGaugeInt64(_metricNames[i], HelpText, false, "foo", "bar", "baz");
                 for(var j = 0; j < _samplesCount; j++)
                     gauge.WithLabels(_labelValues[j][0], _labelValues[j][1], _labelValues[j][2]).Inc();
             }
diff --git a/tests/Prometheus.Client.Benchmarks.Comparison/Histogram/HistogramGeneralUseCaseBenchmarks.cs b/tests/Prometheus.Client.Benchmarks.Comparison/Histogram/HistogramGeneralUseCaseBenchmarks.cs
@@ -63,7 +63,7 @@ public void WithLabels_Array()
         {
             for (var i = 0; i < _metricsCount; i++)
             {
-                var histogram = OurMetricFactory.CreateHistogram(_metricNames[i], HelpText, "foo", "bar", "baz");
+                var histogram = OurMetricFactory.CreateHistogram(_metricNames[i], HelpText, false,"foo", "bar", "baz");
                 histogram.Observe(i / 100d);
             }
         }
@@ -97,7 +97,7 @@ public void WithLabelsAndSamples_Array()
         {
             for (var i = 0; i < _metricsCount; i++)
             {
-                var histogram = OurMetricFactory.CreateHistogram(_metricNames[i], HelpText, "foo", "bar", "baz");
+                var histogram = OurMetricFactory.CreateHistogram(_metricNames[i], HelpText, false,"foo", "bar", "baz");
                 for(var j = 0; j < _samplesCount; j++)
                     histogram.WithLabels(_labelValues[j][0], _labelValues[j][1], _labelValues[j][2]).Observe(i / 100d);
             }
diff --git a/tests/Prometheus.Client.Benchmarks.Comparison/Prometheus.Client.Benchmarks.Comparison.csproj b/tests/Prometheus.Client.Benchmarks.Comparison/Prometheus.Client.Benchmarks.Comparison.csproj
@@ -1,14 +1,14 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp3.0</TargetFramework>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
     <OutputType>Exe</OutputType>
     <NoWarn>SA1133</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="BenchmarkDotNet" Version="0.12.0" />
-    <PackageReference Include="prometheus-net" Version="3.6.0" />
+    <PackageReference Include="prometheus-net" Version="4.1.1" />
   </ItemGroup>
 
   <ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -200,7 +200,8 @@ private void AddInternal(ICollector collector)`
`200`	`200`
`201`	`201`	`_collectors.Add(collector.Configuration.Name, collector);`
`202`	`202`	`_usedMetricNames.UnionWith(collector.MetricNames);`
`203`		`- _enumerableCollectors = new Lazy<IEnumerable<ICollector>>(GetImmutableValueCollection);`
	`203`	`+ if (_enumerableCollectors.IsValueCreated)`
	`204`	`+ _enumerableCollectors = new Lazy<IEnumerable<ICollector>>(GetImmutableValueCollection);`
`204`	`205`	`}`
`205`	`206`
`206`	`207`	`private IEnumerable<ICollector> GetImmutableValueCollection()`
Original file line number	Diff line number	Diff line change
`@@ -79,10 +79,11 @@ public static int GetHashCode(IReadOnlyList<string> values)`
`79`	`79`	`// do not use for-each here, it allocates which is easy to avoid by for loop`
`80`	`80`	`for (var i = 0; i < values.Count; i++)`
`81`	`81`	`{`
`82`		`- if(values[i] == null)`
	`82`	`+ var val = values[i];`
	`83`	`+ if(string.IsNullOrEmpty(val))`
`83`	`84`	`throw new ArgumentException("Label value cannot be empty");`
`84`	`85`
`85`		`- result = HashCode.Combine(result, values[i].GetHashCode());`
	`86`	`+ result = HashCombine(result, val.GetHashCode());`
`86`	`87`	`}`
`87`	`88`
`88`	`89`	`return result;`
`@@ -202,6 +203,13 @@ private static void Fill<T>(this IList<T> target, T value, int offset, int size)`
`202`	`203`	`}`
`203`	`204`	`}`
`204`	`205`
	`206`	`+ [MethodImpl(MethodImplOptions.AggressiveInlining)]`
	`207`	`+ private static int HashCombine(int h1, int h2)`
	`208`	`+ {`
	`209`	`+ uint rol5 = ((uint)h1 << 5) \| ((uint)h1 >> 27);`
	`210`	`+ return ((int)rol5 + h1) ^ h2;`
	`211`	`+ }`
	`212`	`+`
`205`	`213`	`private static bool Validate(Type tupleType)`
`206`	`214`	`{`
`207`	`215`	`if (tupleType == typeof(ValueTuple))`
`@@ -256,9 +264,9 @@ public static int GetTupleHashCode(TTuple values)`
`256`	`264`	`{`
`257`	`265`	`return HashCodeReducer(values, 0, (item, _, aggregated) =>`
`258`	`266`	`{`
`259`		`- if(item == null)`
	`267`	`+ if(string.IsNullOrEmpty(item))`
`260`	`268`	`throw new ArgumentException("Label value cannot be empty");`
`261`		`- return HashCode.Combine(aggregated, item.GetHashCode());`
	`269`	`+ return HashCombine(aggregated, item.GetHashCode());`
`262`	`270`	`});`
`263`	`271`	`}`
`264`	`272`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ TMetric IMetricFamily<TMetric>.WithLabels(params string[] labels)`
`72`	`72`	`return metric;`
`73`	`73`	`}`
`74`	`74`
`75`		`- metric = CreateLabelled(labels);`
	`75`	`+ metric = _instanceFactory(_configuration, labels);`
`76`	`76`	`return _labelledMetrics.GetOrAdd(key, metric);`
`77`	`77`	`}`
`78`	`78`
`@@ -108,7 +108,7 @@ public TMetric WithLabels(TLabels labels)`
`108`	`108`	`return metric;`
`109`	`109`	`}`
`110`	`110`
`111`		`- metric = CreateLabelled(LabelsHelper.ToArray(labels));`
	`111`	`+ metric = _instanceFactory(_configuration, LabelsHelper.ToArray(labels));`
`112`	`112`	`return _labelledMetrics.GetOrAdd(key, metric);`
`113`	`113`	`}`
`114`	`114`
`@@ -155,16 +155,5 @@ private IEnumerable<KeyValuePair<IReadOnlyList<string>, TMetric>> EnumerateLabel`
`155`	`155`	`foreach (var labelled in _labelledMetrics)`
`156`	`156`	`yield return new KeyValuePair<IReadOnlyList<string>, TMetric>(labelled.Value.LabelValues, labelled.Value);`
`157`	`157`	`}`
`158`		`-`
`159`		`- private TImplementation CreateLabelled(IReadOnlyList<string> labels)`
`160`		`- {`
`161`		`- for (var i = 0; i < labels.Count; i++)`
`162`		`- {`
`163`		`- if(string.IsNullOrEmpty(labels[i]))`
`164`		`- throw new ArgumentException("Label cannot be empty.");`
`165`		`- }`
`166`		`-`
`167`		`- return _instanceFactory(_configuration, labels);`
`168`		`- }`
`169`	`158`	`}`
`170`	`159`	`}`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ public void WithLabels_Array()`
`74`	`74`	`{`
`75`	`75`	`for (var i = 0; i < _metricsCount; i++)`
`76`	`76`	`{`
`77`		`- var counter = OurMetricFactory.CreateCounter(_metricNames[i], HelpText, "foo", "bar", "baz");`
	`77`	`+ var counter = OurMetricFactory.CreateCounter(_metricNames[i], HelpText, false, "foo", "bar", "baz");`
`78`	`78`	`counter.Inc();`
`79`	`79`	`}`
`80`	`80`	`}`
`@@ -96,7 +96,7 @@ public void WithLabels_Int64Array()`
`96`	`96`	`{`
`97`	`97`	`for (var i = 0; i < _metricsCount; i++)`
`98`	`98`	`{`
`99`		`- var counter = OurMetricFactory.CreateCounterInt64(_metricNames[i], HelpText, "foo", "bar", "baz");`
	`99`	`+ var counter = OurMetricFactory.CreateCounterInt64(_metricNames[i], HelpText, false, "foo", "bar", "baz");`
`100`	`100`	`counter.Inc();`
`101`	`101`	`}`
`102`	`102`	`}`
`@@ -130,7 +130,7 @@ public void WithLabelsAndSamples_Array()`
`130`	`130`	`{`
`131`	`131`	`for (var i = 0; i < _metricsCount; i++)`
`132`	`132`	`{`
`133`		`- var counter = OurMetricFactory.CreateCounter(_metricNames[i], HelpText, "foo", "bar", "baz");`
	`133`	`+ var counter = OurMetricFactory.CreateCounter(_metricNames[i], HelpText, false, "foo", "bar", "baz");`
`134`	`134`	`for(var j = 0; j < _labelValues.Length; j++)`
`135`	`135`	`counter.WithLabels(_labelValues[j][0], _labelValues[j][1], _labelValues[j][2]).Inc();`
`136`	`136`	`}`
`@@ -154,7 +154,7 @@ public void WithLabelsAndSamples_Int64Array()`
`154`	`154`	`{`
`155`	`155`	`for (var i = 0; i < _metricsCount; i++)`
`156`	`156`	`{`
`157`		`- var counter = OurMetricFactory.CreateCounterInt64(_metricNames[i], HelpText, "foo", "bar", "baz");`
	`157`	`+ var counter = OurMetricFactory.CreateCounterInt64(_metricNames[i], HelpText, false, "foo", "bar", "baz");`
`158`	`158`	`for(var j = 0; j < _labelValues.Length; j++)`
`159`	`159`	`counter.WithLabels(_labelValues[j][0], _labelValues[j][1], _labelValues[j][2]).Inc();`
`160`	`160`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public void WithLabels_Array()`
`63`	`63`	`{`
`64`	`64`	`for (var i = 0; i < _metricsCount; i++)`
`65`	`65`	`{`
`66`		`- var histogram = OurMetricFactory.CreateHistogram(_metricNames[i], HelpText, "foo", "bar", "baz");`
	`66`	`+ var histogram = OurMetricFactory.CreateHistogram(_metricNames[i], HelpText, false,"foo", "bar", "baz");`
`67`	`67`	`histogram.Observe(i / 100d);`
`68`	`68`	`}`
`69`	`69`	`}`
`@@ -97,7 +97,7 @@ public void WithLabelsAndSamples_Array()`
`97`	`97`	`{`
`98`	`98`	`for (var i = 0; i < _metricsCount; i++)`
`99`	`99`	`{`
`100`		`- var histogram = OurMetricFactory.CreateHistogram(_metricNames[i], HelpText, "foo", "bar", "baz");`
	`100`	`+ var histogram = OurMetricFactory.CreateHistogram(_metricNames[i], HelpText, false,"foo", "bar", "baz");`
`101`	`101`	`for(var j = 0; j < _samplesCount; j++)`
`102`	`102`	`histogram.WithLabels(_labelValues[j][0], _labelValues[j][1], _labelValues[j][2]).Observe(i / 100d);`
`103`	`103`	`}`