Public/SignalR/Send-KrSignalRLog.ps1
|
<# .SYNOPSIS Broadcasts a log message to all connected SignalR clients. .DESCRIPTION This function sends a log message to all connected SignalR clients via the IRealtimeBroadcaster service. The message is broadcast in real-time to all connected clients listening on the hub. .PARAMETER Level The log level (e.g., Information, Warning, Error, Debug, Verbose). .PARAMETER Message The log message to broadcast. .EXAMPLE Send-KrSignalRLog -Level Information -Message "Server started successfully" Broadcasts an information log message to all connected SignalR clients. .EXAMPLE Send-KrSignalRLog -Level Error -Message "Failed to process request" Broadcasts an error log message to all connected SignalR clients. .EXAMPLE Get-KrServer | Send-KrSignalRLog -Level Warning -Message "High memory usage detected" Broadcasts a warning log message using the pipeline. .NOTES This function requires that SignalR has been configured on the server using Add-KrSignalRHubMiddleware. The IRealtimeBroadcaster service must be registered for this cmdlet to work. #> function Send-KrSignalRLog { [KestrunRuntimeApi('Everywhere')] [CmdletBinding()] param( [Parameter(Mandatory = $true)] [ValidateSet('Verbose', 'Debug', 'Information', 'Warning', 'Error', 'Fatal')] [string]$Level, [Parameter(Mandatory = $true)] [string]$Message ) # Only works inside a route script block where $Context is available if ($null -ne $Context) { if ($Context.BroadcastLog($Level, $Message, [System.Threading.CancellationToken]::None)) { Write-KrLog -Level Debug -Message "Broadcasted log message: $Level - $Message" return } else { Write-KrLog -Level Error -Message 'Failed to broadcast log message: Unknown error' return } } Write-KrOutsideRouteWarning } |