System Diagnostics and Server Logs

Add System Diagnostics Rule

To add a new custom diagnostic rule, click Add System Diagnostics Rule action and fill out the following fields:

• Title: the name of the rule that will be shown in the description column when the System Diagnostics is run
  
• Disabled: checkbox options
  • Not selected (default): the created rule is run during the system diagnostics
  • Selected: the rule is saved in the system but not activated and is not run during the system diagnostics
• Comments: comment for the diagnostic rule that will be shown in the details section in case the diagnostic rule result is an Information message
  
• Implementation Script:  write a PowerShell script that checks the necessary component and includes logic for Information, Error, and Warning check results.

Implementation Script Example: state result

The Diagnostics Rule check can have the following results: 

The following PowerShell script checks the free disk space in the system drives and includes the examples of the the output messages that are shown in case the diagnostics rule results in Error, Warning, and Information message details:

# Check free disk space on all filesystem drives
$drives = Get-PSDrive -PSProvider FileSystem
 
foreach ($drive in $drives) {
    # Convert free space from bytes to gigabytes
    $freeGB = $drive.Free / 1GB
    $roundedFree = [math]::Round($freeGB, 2)
 
    # Output message details for the diagnostics result with Error state:
    if ($freeGB -lt 1) {
        Write-Error "Drive $($drive.Name): CRITICAL low disk space - only $roundedFree GB free!"
    }
   
    # Output message details for the diagnostics result with Warning state:
    elseif ($freeGB -lt 10) {
        Write-Warning "Drive $($drive.Name): Warning - low disk space - $roundedFree GB free."
    }
    
    # Output message details for the diagnostics result with Information state:
    else {
        Write-Output "Drive $($drive.Name): Sufficient disk space - $roundedFree GB free."
    }
}

Implementation Script Example: reading data from the Data Layer

In the PowerShell script use the global PowerShell variables which provide easy access to the system's Data Layer, Service Connections, Logs, and WebApiClient components.

 The following PowerShell script reads data from the DWPSystemDiagnosticRuleClassBase Data Definition from the Data Layer:

#Read data from Data Layer 
$dbData = $M42_DatabaseProvider.GetData("DWPSystemDiagnosticRuleClassBase", "ID,Title,ImplementationScript,Order,Comments", "Disabled=0",$null)

# Output message details for the diagnostics result with Warning state:
if ($dbData -eq $null) {
    Write-Warning "GetData returned null. Ensure the query is correct and the database contains the expected data."
} elseif ($dbData -is [System.Data.DataTable]) {   
    if ($dbData.Rows.Count -eq 0) {
        Write-Warning "GetData returned a DataTable, but it contains no rows."
    } else {
        echo "DataTable rows:"
        foreach ($row in $dbData.Rows) {
            echo "ID: $($row['ID']), Title: $($row['Title']), Script: $($row['ImplementationScript']), Order: $($row['Order']), Comments: $($row['Comments'])"
        }
    }
} elseif ($dbData -is [System.Data.DataRow[]]) {
    if ($dbData.Length -eq 0) {
       Write-Warning "GetData returned a DataRow array, but it is empty."
    } else {
        echo "DataRow array:"
        foreach ($row in $dbData) {
            echo "ID: $($row['ID']), Title: $($row['Title']), Script: $($row['ImplementationScript']), Order: $($row['Order']), Comments: $($row['Comments'])"
        }
    }
} else {

  # Output message details for the diagnostics result with Error state:
    Write-Error "Unexpected return type from GetData: $($dbData.GetType().FullName)"
}

When the Implementation Script is completed, click Save&Close to proceed. 

All created rules that are listed in the Diagnostics Rules area are added to the standard System Diagnostics check and will be run with the next system check unless the rule is marked as Disabled. Custom rules are added to the end of the list after the standard system rules. 

Run the System Diagnostics from the homepage of the Administration application to see the created Diagnostics Rule:

In the case of the Success rule check result, no message is shown.

Actions

• Edit: open the user-defined Diagnostics Rule for editing
• Delete: deletes the object
• History: view the history of all the Diagnostic Rule related transactions
• Export: export the Diagnostic Rule data to a file