Lib/Utils.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
$Script:defaultHeaders = @{ "content-type" = "application/json" "accept" = "application/json" } $Script:apiEndpoints = @( "https://api.au.sumologic.com/api/v1/" "https://api.de.sumologic.com/api/v1/" "https://api.eu.sumologic.com/api/v1/" "https://api.jp.sumologic.com/api/v1/" "https://api.sumologic.com/api/v1/" "https://api.us2.sumologic.com/api/v1/" ) function getSession([System.Management.Automation.PSCredential]$credential) { if ($env:SUMOLOGIC_API_ENDPOINT) { $apiEndpoints = @($env:SUMOLOGIC_API_ENDPOINT) + $apiEndpoints } foreach ($apiEndpoint in $apiEndpoints) { $url = $apiEndpoint + "collectors?limit=1" try { $res = Invoke-RestMethod -Uri $url -Headers $defaultHeaders -Method Get ` -Credential $credential -SessionVariable webSession -ErrorAction SilentlyContinue -ErrorVariable err if ($res) { return [SumoAPISession]::new($apiEndpoint, $webSession) } } catch { Write-Verbose "An error occurred when calling $apiEndpoint." } } $err | ForEach-Object { Write-Verbose $_ } } function getHex([long]$id) { "{0:X16}" -f $id } function getFullName([psobject]$obj) { "'{0}'[{1}]" -f $obj.name, (getHex $obj.id) } function urlEncode([string]$str) { [System.Web.HttpUtility]::UrlEncode($str) } function urlDecode([string]$str) { [System.Web.HttpUtility]::UrlDecode($str) } function getQueryString([hashtable]$form) { $sections = $form.GetEnumerator() | Sort-Object -Property Name | ForEach-Object { "{0}={1}" -f (urlEncode($_.Name)), (urlEncode($_.Value)) } $sections -join "&" } function getUnixTimeStamp([datetime]$time) { $base = New-Object -TypeName DateTime -ArgumentList (1970, 1, 1, 0, 0, 0, [DateTimeKind]::Utc) [long](($time.ToUniversalTime() - $base).TotalMilliseconds) } function getDotNetDateTime([long]$time) { $base = New-Object -TypeName DateTime -ArgumentList (1970, 1, 1, 0, 0, 0, [DateTimeKind]::Utc) $base + [TimeSpan]::FromMilliseconds($time) } function invokeSumoAPI([SumoAPISession]$session, [hashtable]$headers = $Script:defaultHeaders, [Microsoft.PowerShell.Commands.WebRequestMethod]$method, [string]$function, [hashtable]$query, [string]$body, $cmdlet) { $url = $session.Endpoint + $function if ($query) { $qStr = getQueryString($query) $url += "?" + $qStr } if ($method -ne [Microsoft.PowerShell.Commands.WebRequestMethod]::Get) { Write-Verbose "Cmdlet:: $cmdlet" Write-Verbose "Headers: $headers" Write-Verbose "Method: $method" Write-Verbose "WebSession: ${session.WebSession}" Write-Verbose "Body: $body" & $cmdlet -Uri $url -Headers $headers -Method $method -WebSession $session.WebSession -Body $body -ErrorVariable err } else { & $cmdlet -Uri $url -Headers $headers -Method $method -WebSession $session.WebSession -ErrorVariable err } if ($err) { $err | ForEach-Object { Write-Error $_ } } } function invokeSumoWebRequest([SumoAPISession]$session, [hashtable]$headers = $Script:defaultHeaders, [Microsoft.PowerShell.Commands.WebRequestMethod]$method, [string]$function, [hashtable]$query, [string]$body) { invokeSumoAPI $session $headers $method $function $query $body (Get-Command Invoke-WebRequest -Module Microsoft.PowerShell.Utility) } function invokeSumoRestMethod([SumoAPISession]$session, [hashtable]$headers = $Script:defaultHeaders, [Microsoft.PowerShell.Commands.WebRequestMethod]$method, [string]$function, [hashtable]$query, [string]$body) { invokeSumoAPI $session $headers $method $function $query $body (Get-Command Invoke-RestMethod -Module Microsoft.PowerShell.Utility) } function getCollectorsByPage([SumoAPISession]$session, [int]$offset, [int]$limit) { $query = @{ 'offset' = $offset 'limit' = $limit } try { (invokeSumoRestMethod -session $Session -method Get -function "collectors" -query $query).collectors } catch { @() } } function getAllCollectors([SumoAPISession]$session) { $res = @() $limit = 1000 $offset = 0 do { $text = "Processing {0} to {1} collectors" -f $offset, ($offset + $limit) Write-Progress -Activity "Query collectors" -Status $text -PercentComplete -1 $set = getCollectorsByPage -session $session -offset $offset -limit $limit $res += $set $offset += $limit } while ($set.count -gt 0) $res } function startSearchJob ([SumoAPISession]$session, [string]$query, [datetime]$from, [datetime]$to, [string]$timeZone) { $fromT = getUnixTimeStamp ($from) $toT = getUnixTimeStamp ($to) $q = @{ "query" = $query "from" = $fromT "to" = $toT "timeZone" = $timeZone } invokeSumoRestMethod -session $session -method Post -function "search/jobs" -body ($q | ConvertTo-Json) } function getSearchResult ([SumoAPISession]$session, [string]$id, [int]$limit, [SumoSearchResultType]$type, [int]$page) { $status = invokeSumoRestMethod -session $session -method Get -function "search/jobs/$id" if ($status.state -ne "DONE GATHERING RESULTS") { throw "Result is not ready" } if ([SumoSearchResultType]::Record -eq $type) { $ttype = "records" $total = $status.recordCount } else { $ttype = "messages" $total = $status.messageCount } if ($limit -and ($limit -lt $total)) { $total = $limit } [array]$results = @() while ($results.Count -lt $total) { $func = "search/jobs/{0}/{1}" -f $id, $ttype $lowerBound = $results.Count $upperBound = if ($results.Count + $page -lt $total) { $results.Count + $page } else { $total } Write-Verbose "Requesting result $lowerBound - $upperBound ..." $res = invokeSumoRestMethod -session $session -method Get -function $func -query @{ offset = $lowerBound limit = ($upperBound - $lowerBound) } if ([SumoSearchResultType]::Record -eq $type) { $set = $res.records } else { $set = $res.messages } $set | ForEach-Object { $results += $_.map } Write-Verbose "Got $($set.Count) results (Total: $($results.Count))" if ($total -ne 0 -and $results.Count -lt $total) { $text = "Downloaded {0} of {1} {2}" -f $results.Count, $total, $ttype Write-Progress -Activity "Downloading Result" -Status $text -PercentComplete ($results.Count * 100 / $total) } } $results } function convertCollectorToJson([psobject]$collector) { if (!($collector.collectorType -and $collector.collectorType -ieq "Hosted")) { throw "Only hosted collector can be created though API" } $validProperties = @( "collectorType", "name", "description", "category", "timeZone" ) $propNames = $collector.PSObject.Properties | ForEach-Object { $_.Name } $propNames | ForEach-Object { if (!($_ -in $validProperties)) { Write-Verbose "Property [$_] in input collector is removed." $collector.PSObject.Properties.Remove($_) } } $wrapper = New-Object -TypeName psobject @{ "collector" = $collector } ConvertTo-Json $wrapper -Depth 10 } function convertSourceToJson([psobject]$source) { $removeProperties = @( "collectorId", "id", "alive" ) $propNames = $source.PSObject.Properties | ForEach-Object { $_.Name } $propNames | ForEach-Object { if ($_ -in $removeProperties) { Write-Verbose "Property [$_] in input source is removed." $source.PSObject.Properties.Remove($_) } } $wrapper = New-Object -TypeName psobject @{ "source" = $source } ConvertTo-Json $wrapper -Depth 10 } function writeCollectorUpgradeStatus($collector, $upgrade) { getFullName $collector | Write-Host -NoNewline -ForegroundColor White if ($collector.alive) { "(alive) " | Write-Host -NoNewline -ForegroundColor Green } else { "(connection lost) " | Write-Host -NoNewline -ForegroundColor Red } if ((get-host).UI.RawUI.MaxWindowSize.Width -ge 150) { "on $($collector.osName)($($collector.osVersion)) $($collector.collectorVersion)=>$($upgrade.toVersion); " | Write-Host -NoNewline -ForegroundColor Gray } "STATUS: " | Write-Host -NoNewline -ForegroundColor White switch ($upgrade.status) { 0 { getStatusMessage $upgrade | Write-Host -NoNewline -ForegroundColor White } 1 { getStatusMessage $upgrade | Write-Host -NoNewline -ForegroundColor Blue } 2 { getStatusMessage $upgrade | Write-Host -NoNewline -ForegroundColor Green } 3 { getStatusMessage $upgrade | Write-Host -NoNewline -ForegroundColor Red } 6 { getStatusMessage $upgrade | Write-Host -NoNewline -ForegroundColor Cyan } } } function getCollectorUpgradeStatus($collector, $upgrade) { Add-Member -InputObject $upgrade -MemberType NoteProperty -Name collectorName -Value $collector.name Add-Member -InputObject $upgrade -MemberType NoteProperty -Name osName -Value $collector.osName Add-Member -InputObject $upgrade -MemberType NoteProperty -Name osVersion -Value $collector.osVersion Add-Member -InputObject $upgrade -MemberType NoteProperty -Name collectorVersion -Value $collector.collectorVersion Add-Member -InputObject $upgrade -MemberType NoteProperty -Name alive -Value $collector.alive $requestTime = $upgrade.requestTime $upgrade.PSObject.Properties.Remove("requestTime") Add-Member -InputObject $upgrade -MemberType NoteProperty -Name requestTime -Value (getDotNetDateTime $requestTime) $lastSeenAlive = $collector.lastSeenAlive Add-Member -InputObject $upgrade -MemberType NoteProperty -Name lastHeartbeat -Value (getDotNetDateTime $lastSeenAlive) $message = getStatusMessage $upgrade $upgrade.PSObject.Properties.Remove("message") Add-Member -InputObject $upgrade -MemberType NoteProperty -Name message -Value $message $upgrade } function getStatusMessage($upgrade) { switch ($upgrade.status) { 0 { "Not started" } 1 { "Preparing to upgrade collector" } 2 { "Upgrade completed and success " } 3 { "Upgrade failed ($($upgrade.message))" } 6 { "Working on upgrade collector " } } } function waitForSingleUpgrade([SumoAPISession]$Session, [long]$UpgradeId, [long]$RefreshMs, [switch]$Quiet) { $counter = 0 $spinner = "|", "/", "-", "\" do { $counter++ $upgrade = (invokeSumoRestMethod -session $Session -method Get -function "collectors/upgrades/$UpgradeId").upgrade if (!$upgrade) { Write-Error "Cannot get upgrade with id $UpgradeId" return } $collector = (invokeSumoRestMethod -session $Session -method Get -function "collectors/$($upgrade.collectorId)").collector if (!$collector) { Write-Error "Cannot get collector with id $($upgrade.collectorId)" return } if (-not $Quiet) { Write-Host -NoNewLine -ForegroundColor Cyan -Object "`r$($spinner[$counter % 4]) " writeCollectorUpgradeStatus $collector $upgrade } Start-Sleep -Milliseconds $RefreshMs } while ($collector -and $upgrade -and $upgrade.status -ne 2 -and $upgrade.status -ne 3) } function waitForMultipleUpgrades([SumoAPISession]$Session, [array]$UpgradeIds, [long]$RefreshMs, [switch]$Quiet) { [array]$completed = @() $counter = 0 $succeed = 0 $failed = 0 $na = 0 $spinner = "|", "/", "-", "\" do { $counter++ foreach ($upgradeId in $UpgradeIds) { if ($completed -contains $upgradeId) { continue } $upgrade = (invokeSumoRestMethod -session $Session -method Get -function "collectors/upgrades/$upgradeId").upgrade if (!$upgrade) { Write-Warning "Cannot get upgrade with id $upgradeId" $completed += $upgradeId $na++ } elseif ($upgrade.status -eq 2) { $completed += $upgradeId $succeed++ } elseif ($upgrade.status -eq 3) { $completed += $upgradeId $failed++ } } if (-not $Quiet) { Write-Host -NoNewLine -ForegroundColor Cyan -Object "`r$($spinner[$counter % 4]) " "Upgrade STATUS - Total: " | Write-Host -NoNewLine -ForegroundColor Gray $UpgradeIds.Count | Write-Host -NoNewLine -ForegroundColor White " - Running: " | Write-Host -NoNewLine -ForegroundColor Gray $UpgradeIds.Count - $failed - $succeed - $na | Write-Host -NoNewLine -ForegroundColor Cyan ", Succeed: " | Write-Host -NoNewLine -ForegroundColor Gray $succeed | Write-Host -NoNewLine -ForegroundColor Green ", Failed: " | Write-Host -NoNewLine -ForegroundColor Gray $failed | Write-Host -NoNewLine -ForegroundColor Red ", N/A: " | Write-Host -NoNewLine -ForegroundColor Gray "$na " | Write-Host -NoNewLine -ForegroundColor Yellow } Start-Sleep -Milliseconds $RefreshMs } while ($completed.Length -lt $UpgradeIds.Length) } |