[Instrumentation.Runtime] Rename RuntimeInstrumentOptions to `Runti…

…meInstrumentationOptions` (open-telemetry#556) * Rename options object for Runtime Instrumentation
samimusallam · Aug 9, 2022 · 59dcecf · 59dcecf
1 parent 93e2acc
commit 59dcecf
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 15 deletions.
diff --git a/src/OpenTelemetry.Instrumentation.Runtime/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.Runtime/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+* Rename `RuntimeInstrumentOptions` to `RuntimeInstrumentationOptions`
+  ([#556](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/556))
+
 ## 1.0.0-rc.3
 
 Released 2022-Jul-25

diff --git a/src/OpenTelemetry.Instrumentation.Runtime/MeterProviderBuilderExtensions.cs b/src/OpenTelemetry.Instrumentation.Runtime/MeterProviderBuilderExtensions.cs
@@ -33,11 +33,11 @@ public static class MeterProviderBuilderExtensions
         /// <returns>The instance of <see cref="MeterProviderBuilder"/> to chain the calls.</returns>
         public static MeterProviderBuilder AddRuntimeInstrumentation(
             this MeterProviderBuilder builder,
-            Action<RuntimeInstrumentOptions> configure = null)
+            Action<RuntimeInstrumentationOptions> configure = null)
         {
             Guard.ThrowIfNull(builder);
 
-            var options = new RuntimeInstrumentOptions();
+            var options = new RuntimeInstrumentationOptions();
             configure?.Invoke(options);
 
             var instrumentation = new RuntimeMetrics(options);

diff --git a/...ation.Runtime/RuntimeInstrumentOptions.cs → ....Runtime/RuntimeInstrumentationOptions.cs b/...ation.Runtime/RuntimeInstrumentOptions.cs → ....Runtime/RuntimeInstrumentationOptions.cs
@@ -1,4 +1,4 @@
-// <copyright file="RuntimeInstrumentOptions.cs" company="OpenTelemetry Authors">
+// <copyright file="RuntimeInstrumentationOptions.cs" company="OpenTelemetry Authors">
 // Copyright The OpenTelemetry Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,7 +19,7 @@ namespace OpenTelemetry.Instrumentation.Runtime
     /// <summary>
     /// Options to define the runtime metrics.
     /// </summary>
-    public class RuntimeInstrumentOptions
+    public class RuntimeInstrumentationOptions
     {
         /*
                 /// <summary>

diff --git a/src/OpenTelemetry.Instrumentation.Runtime/RuntimeMetrics.cs b/src/OpenTelemetry.Instrumentation.Runtime/RuntimeMetrics.cs
@@ -219,7 +219,7 @@ static RuntimeMetrics()
         /// Initializes a new instance of the <see cref="RuntimeMetrics"/> class.
         /// </summary>
         /// <param name="options">The options to define the metrics.</param>
-        public RuntimeMetrics(RuntimeInstrumentOptions options)
+        public RuntimeMetrics(RuntimeInstrumentationOptions options)
         {
         }
 

diff --git a/...me.Tests/RuntimeInstrumentOptionsTests.cs → ...sts/RuntimeInstrumentationOptionsTests.cs b/...me.Tests/RuntimeInstrumentOptionsTests.cs → ...sts/RuntimeInstrumentationOptionsTests.cs
@@ -1,4 +1,4 @@
-// <copyright file="RuntimeInstrumentOptionsTests.cs" company="OpenTelemetry Authors">
+// <copyright file="RuntimeInstrumentationOptionsTests.cs" company="OpenTelemetry Authors">
 // Copyright The OpenTelemetry Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,17 +14,15 @@
 // limitations under the License.
 // </copyright>
 
-using Xunit;
-
 namespace OpenTelemetry.Instrumentation.Runtime.Tests
 {
-    public class RuntimeInstrumentOptionsTests
+    public class RuntimeInstrumentationOptionsTests
     {
         /*
                 [Fact]
                 public void Enable_All_If_Nothing_Was_Defined()
                 {
-                    var options = new RuntimeInstrumentOptions();
+                    var options = new RuntimeInstrumentationOptions();
 
                     Assert.True(options.IsGcEnabled);
         #if NET6_0_OR_GREATER
@@ -40,7 +38,7 @@ public void Enable_All_If_Nothing_Was_Defined()
                 [Fact]
                 public void Enable_Gc_Only()
                 {
-                    var options = new RuntimeInstrumentOptions { GcEnabled = true };
+                    var options = new RuntimeInstrumentationOptions { GcEnabled = true };
 
                     Assert.True(options.IsGcEnabled);
         #if NET6_0_OR_GREATER
@@ -57,7 +55,7 @@ public void Enable_Gc_Only()
                 [Fact]
                 public void Enable_Jit_Only()
                 {
-                    var options = new RuntimeInstrumentOptions { JitEnabled = true };
+                    var options = new RuntimeInstrumentationOptions { JitEnabled = true };
 
                     Assert.False(options.IsGcEnabled);
                     Assert.True(options.IsJitEnabled);
@@ -71,7 +69,7 @@ public void Enable_Jit_Only()
                 [Fact]
                 public void Enable_Threading_Only()
                 {
-                    var options = new RuntimeInstrumentOptions { ThreadingEnabled = true };
+                    var options = new RuntimeInstrumentationOptions { ThreadingEnabled = true };
 
                     Assert.False(options.IsGcEnabled);
         #if NET6_0_OR_GREATER
@@ -86,7 +84,7 @@ public void Enable_Threading_Only()
                 [Fact]
                 public void Enable_Assemblies_Only()
                 {
-                    var options = new RuntimeInstrumentOptions { AssembliesEnabled = true };
+                    var options = new RuntimeInstrumentationOptions { AssembliesEnabled = true };
 
                     Assert.False(options.IsGcEnabled);
         #if NET6_0_OR_GREATER
@@ -102,7 +100,7 @@ public void Enable_Assemblies_Only()
                 [Fact]
                 public void Enable_Multiple()
                 {
-                    var options = new RuntimeInstrumentOptions { GcEnabled = true, AssembliesEnabled = true };
+                    var options = new RuntimeInstrumentationOptions { GcEnabled = true, AssembliesEnabled = true };
 
                     Assert.True(options.IsGcEnabled);
         #if NET6_0_OR_GREATER