Remove metrics command (#266)

This was removed in Octopus 2020.5.0. See OctopusDeploy/OctopusDeploy#5996.
OctopusDeploy · Dec 21, 2020 · f8f5a6e · f8f5a6e
1 parent 025bbe1
commit f8f5a6e
Show file tree

Hide file tree

Showing 13 changed files with 5 additions and 31 deletions.
diff --git a/OctopusDSC/DSCResources/cOctopusServer/cOctopusServer.psm1 b/OctopusDSC/DSCResources/cOctopusServer/cOctopusServer.psm1
@@ -334,7 +334,7 @@ function Test-OctopusVersionRequiresDatabaseBeforeConfigure {
 }
 
 function Test-OctopusVersionSupportsTaskMetricsLogging {
-    return Test-OctopusVersionNewerThan (New-Object System.Version 2018, 2, 7)
+    return (Test-OctopusVersionNewerThan (New-Object System.Version 2018, 2, 7)) -and (-not (Test-OctopusVersionNewerThan (New-Object System.Version 2020, 5, 0)))
 }
 
 function Test-OctopusVersionSupportsTaskCap {
@@ -686,7 +686,7 @@ function Set-OctopusDeployConfiguration {
     }
 
     if ((-not (Test-OctopusVersionSupportsTaskMetricsLogging)) -and $logTaskMetrics) {
-        throw "LogTaskMetrics = 'true' is only supported from Octopus 2018.2.7"
+        throw "LogTaskMetrics = 'true' is only supported from Octopus 2018.2.7, and was removed in 2020.5.0"
     }
 
     if (

diff --git a/OctopusDSC/Tests/OctopusServerExeInvocationFiles/ChangeWebListenPrefix/CurrentState.ps1 b/OctopusDSC/Tests/OctopusServerExeInvocationFiles/ChangeWebListenPrefix/CurrentState.ps1
@@ -20,6 +20,4 @@ return @{
   ArtifactsDirectory = "C:\Octopus\Artifacts";
   AutoLoginEnabled = $true
   LicenseKey = "PExpY2Vuc2UgU2lnbmF0dXJlPSJoUE5sNFJvYWx2T2wveXNUdC9Rak4xcC9PeVVQc0l6b0FJS282bk9VM1kzMUg4OHlqaUI2cDZGeFVDWEV4dEttdWhWV3hVSTR4S3dJcU9vMTMyVE1FUT09Ij4gICA8TGljZW5zZWRUbz5PY3RvVGVzdCBDb21wYW55PC9MaWNlbnNlZFRvPiAgIDxMaWNlbnNlS2V5PjI0NDE0LTQ4ODUyLTE1NDI3LTQxMDgyPC9MaWNlbnNlS2V5PiAgIDxWZXJzaW9uPjIuMDwhLS0gTGljZW5zZSBTY2hlbWEgVmVyc2lvbiAtLT48L1ZlcnNpb24+ICAgPFZhbGlkRnJvbT4yMDE3LTEyLTA4PC9WYWxpZEZyb20+ICAgPE1haW50ZW5hbmNlRXhwaXJlcz4yMDIzLTAxLTAxPC9NYWludGVuYW5jZUV4cGlyZXM+ICAgPFByb2plY3RMaW1pdD5VbmxpbWl0ZWQ8L1Byb2plY3RMaW1pdD4gICA8TWFjaGluZUxpbWl0PjE8L01hY2hpbmVMaW1pdD4gICA8VXNlckxpbWl0PlVubGltaXRlZDwvVXNlckxpbWl0PiA8L0xpY2Vuc2U+"
-  LogTaskMetrics=$true;
-  LogRequestMetrics=$true;
 }
diff --git a/OctopusDSC/Tests/OctopusServerExeInvocationFiles/ChangeWebListenPrefix/RequestedState.ps1 b/OctopusDSC/Tests/OctopusServerExeInvocationFiles/ChangeWebListenPrefix/RequestedState.ps1
@@ -16,6 +16,4 @@ return @{
     HomeDirectory = "C:\Octopus";
     AutoLoginEnabled = $true
     LicenseKey = "PExpY2Vuc2UgU2lnbmF0dXJlPSJoUE5sNFJvYWx2T2wveXNUdC9Rak4xcC9PeVVQc0l6b0FJS282bk9VM1kzMUg4OHlqaUI2cDZGeFVDWEV4dEttdWhWV3hVSTR4S3dJcU9vMTMyVE1FUT09Ij4gICA8TGljZW5zZWRUbz5PY3RvVGVzdCBDb21wYW55PC9MaWNlbnNlZFRvPiAgIDxMaWNlbnNlS2V5PjI0NDE0LTQ4ODUyLTE1NDI3LTQxMDgyPC9MaWNlbnNlS2V5PiAgIDxWZXJzaW9uPjIuMDwhLS0gTGljZW5zZSBTY2hlbWEgVmVyc2lvbiAtLT48L1ZlcnNpb24+ICAgPFZhbGlkRnJvbT4yMDE3LTEyLTA4PC9WYWxpZEZyb20+ICAgPE1haW50ZW5hbmNlRXhwaXJlcz4yMDIzLTAxLTAxPC9NYWludGVuYW5jZUV4cGlyZXM+ICAgPFByb2plY3RMaW1pdD5VbmxpbWl0ZWQ8L1Byb2plY3RMaW1pdD4gICA8TWFjaGluZUxpbWl0PjE8L01hY2hpbmVMaW1pdD4gICA8VXNlckxpbWl0PlVubGltaXRlZDwvVXNlckxpbWl0PiA8L0xpY2Vuc2U+"
-    LogTaskMetrics=$true;
-    LogRequestMetrics=$true;
 }
diff --git a/OctopusDSC/Tests/OctopusServerExeInvocationFiles/NewInstanceWithMetrics/ExpectedResult.ps1 b/OctopusDSC/Tests/OctopusServerExeInvocationFiles/NewInstanceWithMetrics/ExpectedResult.ps1
@@ -6,7 +6,6 @@ return @(
   "admin --console --instance OctopusServer --username Admin --password S3cur3P4ssphraseHere!",
   "license --console --instance OctopusServer --free",
   "path --console --instance OctopusServer --nugetRepository C:\Octopus\Packages --artifacts C:\Octopus\Artifacts --taskLogs C:\Octopus\TaskLogs",
-  "metrics --console --instance OctopusServer --tasks True --webapi True"
   "service --console --instance OctopusServer --install --reconfigure --stop",
   "service --start --console --instance OctopusServer"
 )
diff --git a/OctopusDSC/Tests/OctopusServerExeInvocationFiles/NewInstanceWithMetrics/RequestedState.ps1 b/OctopusDSC/Tests/OctopusServerExeInvocationFiles/NewInstanceWithMetrics/RequestedState.ps1
@@ -14,6 +14,4 @@ return @{
     ListenPort = 10935;
     AllowCollectionOfUsageStatistics = $false;
     HomeDirectory = "C:\Octopus";
-    LogRequestMetrics = $true
-    LogTaskMetrics = $true
 }
diff --git a/OctopusDSC/Tests/OctopusServerExeInvocationFiles/UpgradeExistingInstance/CurrentState.ps1 b/OctopusDSC/Tests/OctopusServerExeInvocationFiles/UpgradeExistingInstance/CurrentState.ps1
@@ -23,7 +23,5 @@ return @{
   ArtifactsDirectory = "C:\Octopus\Artifacts";
   AutoLoginEnabled = $true
   LicenseKey = "PExpY2Vuc2UgU2lnbmF0dXJlPSJoUE5sNFJvYWx2T2wveXNUdC9Rak4xcC9PeVVQc0l6b0FJS282bk9VM1kzMUg4OHlqaUI2cDZGeFVDWEV4dEttdWhWV3hVSTR4S3dJcU9vMTMyVE1FUT09Ij4gICA8TGljZW5zZWRUbz5PY3RvVGVzdCBDb21wYW55PC9MaWNlbnNlZFRvPiAgIDxMaWNlbnNlS2V5PjI0NDE0LTQ4ODUyLTE1NDI3LTQxMDgyPC9MaWNlbnNlS2V5PiAgIDxWZXJzaW9uPjIuMDwhLS0gTGljZW5zZSBTY2hlbWEgVmVyc2lvbiAtLT48L1ZlcnNpb24+ICAgPFZhbGlkRnJvbT4yMDE3LTEyLTA4PC9WYWxpZEZyb20+ICAgPE1haW50ZW5hbmNlRXhwaXJlcz4yMDIzLTAxLTAxPC9NYWludGVuYW5jZUV4cGlyZXM+ICAgPFByb2plY3RMaW1pdD5VbmxpbWl0ZWQ8L1Byb2plY3RMaW1pdD4gICA8TWFjaGluZUxpbWl0PjE8L01hY2hpbmVMaW1pdD4gICA8VXNlckxpbWl0PlVubGltaXRlZDwvVXNlckxpbWl0PiA8L0xpY2Vuc2U+"
-  LogTaskMetrics=$false;
-  LogRequestMetrics=$false;
   SkipLicenseCheck = $true;
-}
+}
diff --git a/OctopusDSC/Tests/OctopusServerExeInvocationFiles/UpgradeExistingInstance/ExpectedResult.ps1 b/OctopusDSC/Tests/OctopusServerExeInvocationFiles/UpgradeExistingInstance/ExpectedResult.ps1
@@ -1,7 +1,6 @@
 return @(
   "service --stop --console --instance OctopusServer",
   "configure --console --instance OctopusServer --upgradeCheck True --upgradeCheckWithStatistics False --webForceSSL False --webListenPrefixes http://localhost:82 --commsListenPort 10935 --home C:\Octopus --autoLoginEnabled True --hstsEnabled False --hstsMaxAge 3600",
-  "metrics --console --instance OctopusServer --tasks True --webapi True",
   "node --console --instance OctopusServer --taskCap 10",
   "database --upgrade --instance OctopusServer --skipLicenseCheck",
   "service --start --console --instance OctopusServer"

diff --git a/OctopusDSC/Tests/OctopusServerExeInvocationFiles/UpgradeExistingInstance/RequestedState.ps1 b/OctopusDSC/Tests/OctopusServerExeInvocationFiles/UpgradeExistingInstance/RequestedState.ps1
@@ -16,8 +16,6 @@ return @{
     HomeDirectory = "C:\Octopus";
     AutoLoginEnabled = $true
     LicenseKey = "PExpY2Vuc2UgU2lnbmF0dXJlPSJoUE5sNFJvYWx2T2wveXNUdC9Rak4xcC9PeVVQc0l6b0FJS282bk9VM1kzMUg4OHlqaUI2cDZGeFVDWEV4dEttdWhWV3hVSTR4S3dJcU9vMTMyVE1FUT09Ij4gICA8TGljZW5zZWRUbz5PY3RvVGVzdCBDb21wYW55PC9MaWNlbnNlZFRvPiAgIDxMaWNlbnNlS2V5PjI0NDE0LTQ4ODUyLTE1NDI3LTQxMDgyPC9MaWNlbnNlS2V5PiAgIDxWZXJzaW9uPjIuMDwhLS0gTGljZW5zZSBTY2hlbWEgVmVyc2lvbiAtLT48L1ZlcnNpb24+ICAgPFZhbGlkRnJvbT4yMDE3LTEyLTA4PC9WYWxpZEZyb20+ICAgPE1haW50ZW5hbmNlRXhwaXJlcz4yMDIzLTAxLTAxPC9NYWludGVuYW5jZUV4cGlyZXM+ICAgPFByb2plY3RMaW1pdD5VbmxpbWl0ZWQ8L1Byb2plY3RMaW1pdD4gICA8TWFjaGluZUxpbWl0PjE8L01hY2hpbmVMaW1pdD4gICA8VXNlckxpbWl0PlVubGltaXRlZDwvVXNlckxpbWl0PiA8L0xpY2Vuc2U+"
-    LogTaskMetrics=$true;
-    LogRequestMetrics=$true;
     SkipLicenseCheck = $true;
     TaskCap = 10;
 }
diff --git a/OctopusDSC/Tests/OctopusServerExeInvocationFiles/WhenNothingChanges/CurrentState.ps1 b/OctopusDSC/Tests/OctopusServerExeInvocationFiles/WhenNothingChanges/CurrentState.ps1
@@ -25,8 +25,6 @@ return @{
   ArtifactsDirectory = "C:\Octopus\Artifacts";
   AutoLoginEnabled = $true
   LicenseKey = "PExpY2Vuc2UgU2lnbmF0dXJlPSJoUE5sNFJvYWx2T2wveXNUdC9Rak4xcC9PeVVQc0l6b0FJS282bk9VM1kzMUg4OHlqaUI2cDZGeFVDWEV4dEttdWhWV3hVSTR4S3dJcU9vMTMyVE1FUT09Ij4gICA8TGljZW5zZWRUbz5PY3RvVGVzdCBDb21wYW55PC9MaWNlbnNlZFRvPiAgIDxMaWNlbnNlS2V5PjI0NDE0LTQ4ODUyLTE1NDI3LTQxMDgyPC9MaWNlbnNlS2V5PiAgIDxWZXJzaW9uPjIuMDwhLS0gTGljZW5zZSBTY2hlbWEgVmVyc2lvbiAtLT48L1ZlcnNpb24+ICAgPFZhbGlkRnJvbT4yMDE3LTEyLTA4PC9WYWxpZEZyb20+ICAgPE1haW50ZW5hbmNlRXhwaXJlcz4yMDIzLTAxLTAxPC9NYWludGVuYW5jZUV4cGlyZXM+ICAgPFByb2plY3RMaW1pdD5VbmxpbWl0ZWQ8L1Byb2plY3RMaW1pdD4gICA8TWFjaGluZUxpbWl0PjE8L01hY2hpbmVMaW1pdD4gICA8VXNlckxpbWl0PlVubGltaXRlZDwvVXNlckxpbWl0PiA8L0xpY2Vuc2U+"
-  LogTaskMetrics=$true;
-  LogRequestMetrics=$true;
   OctopusMasterKey = $MasterKeyCred;
   ForceSSL = $true;
   OctopusBuiltInWorkerCredential = $octopusBuiltInWorkerCredential;

diff --git a/OctopusDSC/Tests/OctopusServerExeInvocationFiles/WhenNothingChanges/RequestedState.ps1 b/OctopusDSC/Tests/OctopusServerExeInvocationFiles/WhenNothingChanges/RequestedState.ps1
@@ -21,8 +21,6 @@ return @{
     HomeDirectory = "C:\Octopus";
     AutoLoginEnabled = $true
     LicenseKey = "PExpY2Vuc2UgU2lnbmF0dXJlPSJoUE5sNFJvYWx2T2wveXNUdC9Rak4xcC9PeVVQc0l6b0FJS282bk9VM1kzMUg4OHlqaUI2cDZGeFVDWEV4dEttdWhWV3hVSTR4S3dJcU9vMTMyVE1FUT09Ij4gICA8TGljZW5zZWRUbz5PY3RvVGVzdCBDb21wYW55PC9MaWNlbnNlZFRvPiAgIDxMaWNlbnNlS2V5PjI0NDE0LTQ4ODUyLTE1NDI3LTQxMDgyPC9MaWNlbnNlS2V5PiAgIDxWZXJzaW9uPjIuMDwhLS0gTGljZW5zZSBTY2hlbWEgVmVyc2lvbiAtLT48L1ZlcnNpb24+ICAgPFZhbGlkRnJvbT4yMDE3LTEyLTA4PC9WYWxpZEZyb20+ICAgPE1haW50ZW5hbmNlRXhwaXJlcz4yMDIzLTAxLTAxPC9NYWludGVuYW5jZUV4cGlyZXM+ICAgPFByb2plY3RMaW1pdD5VbmxpbWl0ZWQ8L1Byb2plY3RMaW1pdD4gICA8TWFjaGluZUxpbWl0PjE8L01hY2hpbmVMaW1pdD4gICA8VXNlckxpbWl0PlVubGltaXRlZDwvVXNlckxpbWl0PiA8L0xpY2Vuc2U+"
-    LogTaskMetrics=$true;
-    LogRequestMetrics=$true;
     OctopusMasterKey = $MasterKeyCred;
     ForceSSL = $true;
     OctopusBuiltInWorkerCredential = $octopusBuiltInWorkerCredential;

diff --git a/README-cOctopusServer.md b/README-cOctopusServer.md
@@ -61,9 +61,6 @@ Configuration SampleConfig
             # if not supplied, Octopus will use a free license
             LicenseKey = "base64encodedlicense"
 
-            # whether to log metrics
-            LogTaskMetrics = $false
-            LogRequestMetrics = $false
 
             TaskCap = 10
         }
@@ -124,8 +121,8 @@ When `State` is `Started`, the resource will ensure that the Octopus Servr windo
 | `GrantDatabasePermissions`            | `boolean`                                           | `$true`                                                         | Whether to grant `db_owner` permissions to the service account user (`$OctopusServiceCredential` user if supplied, or `NT AUTHORITY\System`)  |
 | `OctopusMasterKey`                    | `PSCredential`                                      | `[PSCredential]::Empty`                                         | The master key for the existing database. |
 | `OctopusBuiltInWorkerCredential`      | `PSCredential`                                      | `[PSCredential]::Empty`                                         | The user account to use to execute run-on-server scripts. If not supplied, executes scripts under the service account used for `Octopus.Server.exe` |
-| `LogTaskMetrics`                      | `boolean`                                           | `$false`                                                        | Whether to log task metrics |
-| `LogRequestMetrics`                   | `boolean`                                           | `$false`                                                        | Whether to log api requests metrics |
+| `LogTaskMetrics`                      | `boolean`                                           | `$false`                                                        | DEPRECATED. Whether to log task metrics |
+| `LogRequestMetrics`                   | `boolean`                                           | `$false`                                                        | DEPRECATED. Whether to log api requests metrics |
 | `TaskCap`                             | `int`                                               |                                                                 | The number of tasks this Octopus Server node should attempt to process at once |
 
 ## Drift

diff --git a/Tests/Scenarios/Server_Scenario_01_Install.ps1 b/Tests/Scenarios/Server_Scenario_01_Install.ps1
@@ -38,9 +38,6 @@ Configuration Server_Scenario_01_Install
 
             LicenseKey = "PExpY2Vuc2UgU2lnbmF0dXJlPSJoUE5sNFJvYWx2T2wveXNUdC9Rak4xcC9PeVVQc0l6b0FJS282bk9VM1kzMUg4OHlqaUI2cDZGeFVDWEV4dEttdWhWV3hVSTR4S3dJcU9vMTMyVE1FUT09Ij4gICA8TGljZW5zZWRUbz5PY3RvVGVzdCBDb21wYW55PC9MaWNlbnNlZFRvPiAgIDxMaWNlbnNlS2V5PjI0NDE0LTQ4ODUyLTE1NDI3LTQxMDgyPC9MaWNlbnNlS2V5PiAgIDxWZXJzaW9uPjIuMDwhLS0gTGljZW5zZSBTY2hlbWEgVmVyc2lvbiAtLT48L1ZlcnNpb24+ICAgPFZhbGlkRnJvbT4yMDE3LTEyLTA4PC9WYWxpZEZyb20+ICAgPE1haW50ZW5hbmNlRXhwaXJlcz4yMDIzLTAxLTAxPC9NYWludGVuYW5jZUV4cGlyZXM+ICAgPFByb2plY3RMaW1pdD5VbmxpbWl0ZWQ8L1Byb2plY3RMaW1pdD4gICA8TWFjaGluZUxpbWl0PjE8L01hY2hpbmVMaW1pdD4gICA8VXNlckxpbWl0PlVubGltaXRlZDwvVXNlckxpbWl0PiA8L0xpY2Vuc2U+"
             SkipLicenseCheck = $true
-
-            LogTaskMetrics = $true
-            LogRequestMetrics = $false
         }
 
         cOctopusServerUsernamePasswordAuthentication "Enable Username/Password Auth"

diff --git a/Tests/Spec/server_scenario_01_install_spec.rb b/Tests/Spec/server_scenario_01_install_spec.rb
@@ -16,10 +16,6 @@
   it { should be_directory }
 end
 
-describe file('c:/ChezOctopus/Logs/metrics.txt') do
-  it { should be_file }
-end
-
 describe file('c:/ChezOctopus/TaskLogs') do
   it { should be_directory }
 end