New Relic - Complete Deployment

To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.

{
  "Id": "7c88ea1e-de71-452d-be7e-b99dda397ba7",
  "Name": "New Relic - Complete Deployment",
  "Description": "Notifies [New Relic](https://newrelic.com) of a deployment.\nSends the revision/version number, deployer, etc from the Octopus deployment.",
  "Version": 27,
  "ExportedAt": "2024-04-16T20:50:00.0000000+03:00",
  "ActionType": "Octopus.Script",
  "Author": "Softer",
  "Parameters": [
    {
      "Id": "caf3f015-671f-4600-bce0-ebcc7d5957fe",
      "Name": "ApiKey",
      "Label": "Api Key",
      "HelpText": "Your New Relic API key.",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "3748da93-614d-4040-8c63-7c86a260c79e",
      "Name": "AppId",
      "Label": "App ID",
      "HelpText": "The ID of the application in New Relic RPM.",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "719ab099-a361-4a58-ad34-b1d4acb70dd2",
      "Name": "User",
      "Label": "User (optional)",
      "HelpText": "The name of the user/process that triggered this deployment.",
      "DefaultValue": null,
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Script.ScriptBody": "# Minimum PowerShell version for ConvertTo-Json is 3\n\nAdd-Type -AssemblyName System.Web\n\n[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor [System.Net.SecurityProtocolType]::Tls12\n\n$apiKey = $OctopusParameters['ApiKey']\n$user = $OctopusParameters['User']\n$appId = $OctopusParameters['AppId']\n\n#https://octopus.com/docs/deployment-process/variables/system-variables\n$releaseNumber = $OctopusParameters['Octopus.Release.Number']\n$releaseNotes = $OctopusParameters['Octopus.Release.Notes']\n$machineName = $OctopusParameters['Octopus.Machine.Name']\n$projectName = $OctopusParameters['Octopus.Project.Name']\n$deploymentLink = $OctopusParameters['Octopus.Web.DeploymentLink']\n\n## --------------------------------------------------------------------------------------\n## Helpers\n## --------------------------------------------------------------------------------------\n# Helper for validating input parameters\nfunction Validate-Parameter([string]$foo, [string[]]$validInput, $parameterName) {\n  Write-Host \"${parameterName}: $foo\"\n  if (! $foo) {\n    throw \"No value was set for $parameterName, and it cannot be empty\"\n  }\n\n  if ($validInput) {\n    if (! $validInput -contains $foo) {\n      throw \"'$input' is not a valid input for '$parameterName'\"\n    }\n  }\n}\n\n## --------------------------------------------------------------------------------------\n## Configuration\n## --------------------------------------------------------------------------------------\nValidate-Parameter $apiKey -parameterName \"Api Key\"\n\nif (!$appId) {\n  Write-Host \"NewRelic Deploy - AppId has not been set yet. Skipping call to API.\"\n  exit 0\n}\n\nif ($appId -eq 0) {\n  Write-Host \"NewRelic Deploy - AppId has been set to zero. Skipping call to API.\"\n  exit 0\n}\n\n$userText = $((\" by user $user\", \"\")[!$user])\nWrite-Host (\"NewRelic Deploy - Notify deployment{0} - App {1} - Revision {2}\" -f $userText, $appId, $revision)\n\n\n# https://rpm.newrelic.com/api/explore/application_deployments/create?application_id=1127348\n$deployment = New-Object -TypeName PSObject\n$deployment | Add-Member -MemberType NoteProperty -Name \"user\" -Value $user\n$deployment | Add-Member -MemberType NoteProperty -Name \"revision\" -Value $releaseNumber\n$deployment | Add-Member -MemberType NoteProperty -Name \"changelog\" -Value $releaseNotes\n$deployment | Add-Member -MemberType NoteProperty -Name \"description\" -Value \"Octopus deployment of $projectName to $machineName. ($deploymentLink)\"\n\n$deploymentContainer = New-Object -TypeName PSObject\n$deploymentContainer | Add-Member -MemberType NoteProperty -Name \"deployment\" -Value $deployment\n\n$post = $deploymentContainer | ConvertTo-Json\nWrite-Debug $post\n\n# in production, we need to\n#Create a URI instance since the HttpWebRequest.Create Method will escape the URL by default.\n$URL = \"https://api.newrelic.com/v2/applications/$appId/deployments.json\"\n$URI = New-Object System.Uri($URL,$true)\n\n#Create a request object using the URI\n$request = [System.Net.HttpWebRequest]::Create($URI)\n$request.Method = \"POST\"\n$request.Headers.Add(\"X-Api-Key\",\"$apiKey\");\n$request.ContentType = \"application/json\"\n\n#Build up a nice User Agent\n$request.UserAgent = $(\n\"{0} (PowerShell {1}; .NET CLR {2}; {3})\" -f $UserAgent,\n$(if($Host.Version){$Host.Version}else{\"1.0\"}),\n[Environment]::Version,\n[Environment]::OSVersion.ToString().Replace(\"Microsoft Windows \", \"Win\")\n)\n$ReturnCode = 0\ntry {\n  Write-Host \"Posting data to $URL\"\n  #Create a new stream writer to write the xml to the request stream.\n  $stream = New-Object IO.StreamWriter $request.GetRequestStream()\n  $stream.AutoFlush = $True\n  $PostStr = [System.Text.Encoding]::UTF8.GetBytes($Post)\n  $stream.Write($PostStr, 0,$PostStr.length)\n  $stream.Close()\n\n  #Make the request and get the response\n  $response = $request.GetResponse()\n\n  if ([int]$response.StatusCode -eq 201) {\n    Write-Host \"NewRelic Deploy - API called succeeded - HTTP $($response.StatusCode).\"\n  } else {\n    Write-Host \"NewRelic Deploy - API called failed - HTTP $($response.StatusCode).\"\n    $ReturnCode = 1\n  }\n  $response.Close()\n} catch {\n  $ErrorMessage = $_.Exception.Message\n  $res = $_.Exception.Response\n  Write-Host \"NewRelic Deploy - API called failed - $ErrorMessage\"\n  $ReturnCode = 1\n}\nexit $ReturnCode\n",
    "Octopus.Action.Script.Syntax": "PowerShell",
    "Octopus.Action.Script.ScriptSource": "Inline",
    "Octopus.Action.RunOnServer": "false",
    "Octopus.Action.Script.ScriptFileName": null,
    "Octopus.Action.Package.FeedId": null,
    "Octopus.Action.Package.PackageId": null
  },
  "Category": "New Relic",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates//opt/buildagent/work/75443764cd38076d/step-templates/newrelic-complete-deployment.json",
  "Website": "/step-templates/7c88ea1e-de71-452d-be7e-b99dda397ba7",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAMAAACahl6sAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAC1QTFRFoNjdQq22w+bqLqSuWbvD6fb3HZqmaMXM////AIyZcMzTes/WhcjOD5OfB5CdP/L59AAABehJREFUeNrs3dla6yAQAGB2mgTy/o97aj1qtQVmI41+w50XLr8zLAkDNZc/0oxCFKIQhShEIQpRiEIUohCFKEQhClGIQhSiEIUoRCEKUYhCFKKQXwGJzpVSgv1s16+Mc78IEl3JNi2tVm0uLp4d4kqHcN9SKO6skCtiQbR9qcHEs0GisXWhNF/ieSBXxcJonhcXMQhP8d7/g3s1JOa6iDRrXgkRCMbdOGZeBTFpkW00ijkb49bv3dGQKYxbX4lHQtwsxtsIVg6DRLtMbcigUCGxLLMbLijmfFn11UKcDIl5OaYhhi9z2nC8p5eZCCnLcW1fzCzI7MHqoZU5EIdfHe7J+/DRrPXYxAwzIAab4z7k9aFl66u0BAcJuNWffYL4aAFhKcKQiHHsPqyDFjz0hxlRSPQIRi8YdznmxSRmhgPIQFCqE4MgHAnMuCVYAiVqFILAHTWsyGZ3gaHLSDt8XtEtJ343McIOu5Ia4OfXKACBjrt7WIkNkF6WD8lTevmPPr/zkssIrksqwwGRpMiDuAPiAZMUFiSmYxwASa+/jyGgUf7az9kOgKQwIIU/XhmzQccuekhGEFd3+vyxGRfj55YihOPJIRlBgA+2/pkiPm4FDS2DDpmokEIdeLfGctUNKHknziV9SAQ+xT10kM6qe0CxxLWjkVia/Eys/m5gNJzkihQIcCr8OfIOH4Jcdwym5ZYR6OkW1DvA6eVJuWX4AanfHaAXz3Gj9vdKgFACsgFfoPck/ZA4NIQSkA38+rzTT7pPDXtBQygBQexiOmJIAhYSgav3+yEL9d7S0AYuj4UA55BE6CDDbtKdh5EQyqSO3B53tNxyOAj0+fY+INitlo2UW0iIxWcWul7BkXKroCDQrm7pAbm2jZJbOAg0swJxyBoMXFYMAhyz9rtfTiiAi5Q50aIgFd1FCJnVya1dCAJ9l+VZmdXJrSQEKfi+TqpHdITejoKEHd3XSTWikdDbURC/vBgShCALfl6nlRkRIJjh1+EhGw2ynQ5CrXKdCykvh6wyi8by8j7yZyBB5sHKnhjiZ0OOmkfCFEiYtUQJ2C0SOYjsorH5F+xuCsTOWsZbmVemFIjog1V7GY97iQ0eftM651G3/fbBzIHUdc7Lhyy00QOvUc5zXgcFdGUNc9H4rZNsYgFpPyCaWRC/znhl2uzr7YoB5oPVt/dBci+xM74gkPmo+2NnWmhboT2LoEs4Ai23hDZ6mpll0UU1hZZbCEnPkZH7hwIv6B43pwU2Q5tjliUUnsEr8NMqvD3d3p92BAiinj/Aymng9SiWUmbK3VZ4DAm3hGNtnsR2FEhcyCFhFtU0A9IvKjcXfm7Vx6Kzzv0ablRfvstWYmMOIT2pA6QWnrWHrMGxnvZcjDjT9bTClFYK2Fz32gsVgjlumJ7/UW/FmR8GWHFms6cPT8J0SjgqL7nuOIZ/bGF4XqyzzEOdACUfUwCNWLu9MCCokFQRR6iE8v5x4RkqJEnAQZsKx5CIOozq+Y5EOTgCgCAPtLIlrXjkCxdysQdKmvGQOHQc63GS1q/yUQCCPS1NPwzTPFYJdEidVvgchYnzSbNAAeoYQjAnjd+nLtFjiGDH+EQP+koB/NHQ9mlduANwxsrsy9Sg5Hb2etl7UbDXI+B6SufSOsz9LqADlYT7Q1JgM4DzBwaCvOrhP8UCkqoSDopwICTJ6NaH/o0PFbvZAnQTb6d5fpvI7T6R/hAy76Iws1BbTTZ8cXKwNrEO5TIhlCtqqC1Rag/gXcr5gxyZVAyCuRfFnjYcF+SVO2V+epEvZ8WN1ie7QI8OmRuUxLnD+DwXhSXm3ZeEGit/PgbxVsCT3MPKhwhTrMhdveRvFOorNcvcuc74Z7hQzxEMLuRt48bzFCe6AD8WmqWKKi4id2JHg80xW0772QquBOBnEMxACEJukXn7VIjaIch+KsQ8yEdwnCmlfH1MR7h+5SYKpkFe1BSiEIUoRCEKUYhCFKIQhShEIQpRiEIUohCFKEQhClGIQhSiEIWItH8CDABzxxpRBO0axAAAAABJRU5ErkJggg==",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History