Merge pull request #42 from Particular/update-interval-obsoletion

UpdateInterval proper obsoletion
Particular · Nov 7, 2017 · 3821d5f · 3821d5f
2 parents 9f0bb89 + 156fb91
commit 3821d5f
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/...Bus.Metrics.PerformanceCounters.Tests/NServiceBus.Metrics.PerformanceCounters.approved.cs b/...Bus.Metrics.PerformanceCounters.Tests/NServiceBus.Metrics.PerformanceCounters.approved.cs
@@ -23,5 +23,9 @@ public static NServiceBus.PerformanceCountersSettings EnableWindowsPerformanceCo
     public class PerformanceCountersSettings
     {
         public void EnableSLAPerformanceCounters(System.TimeSpan sla) { }
+        [System.ObsoleteAttribute("This interval is no longer used for reporting. Counters values are updated as soo" +
+            "n as they are reported. Will be treated as an error from version 2.0.0. Will be " +
+            "removed in version 3.0.0.", false)]
+        public void UpdateCounterEvery(System.TimeSpan updateInterval) { }
     }
 }
diff --git a/src/NServiceBus.Metrics.PerformanceCounters/FodyWeavers.xml b/src/NServiceBus.Metrics.PerformanceCounters/FodyWeavers.xml
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Weavers>
+  <Obsolete />
+</Weavers>
diff --git a/src/NServiceBus.Metrics.PerformanceCounters/NServiceBus.Metrics.PerformanceCounters.csproj b/src/NServiceBus.Metrics.PerformanceCounters/NServiceBus.Metrics.PerformanceCounters.csproj
@@ -14,6 +14,7 @@
   <ItemGroup>
     <PackageReference Include="GitVersionTask" Version="4.0.0-*" PrivateAssets="All" />
     <PackageReference Include="NServiceBus.Metrics" Version="[2.0.0, 3.0.0)" />
+    <PackageReference Include="Obsolete.Fody" Version="4.3.2" />
   </ItemGroup>
 
   <PropertyGroup>

diff --git a/src/NServiceBus.Metrics.PerformanceCounters/PerformanceCountersSettings.cs b/src/NServiceBus.Metrics.PerformanceCounters/PerformanceCountersSettings.cs
@@ -26,5 +26,14 @@ public void EnableSLAPerformanceCounters(TimeSpan sla)
             endpointConfiguration.GetSettings().Set(SLAMonitoringFeature.EndpointSLAKey, sla);
             endpointConfiguration.EnableFeature<SLAMonitoringFeature>();
         }
+
+        /// <summary>
+        /// Sets the update interval.
+        /// </summary>
+        /// <param name="updateInterval"></param>
+        [ObsoleteEx(Message = "This interval is no longer used for reporting. Counters values are updated as soon as they are reported", RemoveInVersion = "3.0")]
+        public void UpdateCounterEvery(TimeSpan updateInterval)
+        {
+        }
     }
 }