Skip to content

Latest commit

 

History

History
221 lines (175 loc) · 8.74 KB

README.md

File metadata and controls

221 lines (175 loc) · 8.74 KB
Raw

Machine Stats for Windows

Machine Stats for Windows uses WinRM to Invoke-Command across your servers, creating a JSON file which you can securely send to your Tidal Accelerator instance using the tidal command.

If WinRM is not the best solution for you, you can use an alternative approach backed by WMI by running the -NoWinRM flag. For more information check out the guide.

Usage

For detailed information on the different ways to run Machine Stats for Windows, check out the guide. This README will explain one common use case - where you want to take a single reading of your inventory and then pipe the result straight to Tidal Accelerator using Tidal Tools.

  1. Download and install Tidal Tools.

  2. Make sure you are logged into your Tidal Accelerator workspace with 👇 . Check out the guides for more information.

    tidal login

  3. Prepare the username and a password to access your servers:

    • Specify -UserName parameter value
    • Store the password securely by running .\save_password.ps1 script

  4. Ensure you have a text file (unicode/ascii) that has a list of hosts to be scanned. Hosts can be specified either as IP addresses or as hostnames that resolve via DNS. In either case, the hostnames and IP addresses must be resolvable (private or global DNS) and routable (either locally or over the internet) from the machine that machine-stats is running on. By default, Machine Stats looks for servers.txt, but you can also specify any custom location with -ServersPath parameter.

    You can easily export these with the 'Export' button from your Tidal Accelerator workspace, https://your_domain.tidal.cloud/#/servers

  5. Invoke the runner and sync with Tidal Accelerator:

.\windows\runner.ps1 | tidal sync servers

You should be able to check your account and see the VMs and their corresponding attributes and metrics. You'll find that at a URL that is something like:

https://your_domain.tidal.cloud/#/servers

Data captured

For Windows, by default, the following metrics are captured from the resources and sent and stored in Tidal Accelerator:

Host Name
RAM Allocated (GB)
RAM Used (GB)
Storage Allocated (GB)
Storage Used (GB)
CPU Count
Operating System
Operating System Version
CPU Name
CPU Description
CPU Manufacturer
CPU L2 Cache Size
CPU L3 Cache Size
CPU Socket Designation
Total Visible Memory (GB)
Total Virtual Memory (GB)

Here is an example of the output:

{
    "servers": [
        {
            "operating_system": "Microsoft Windows Server 2019 Datacenter",
            "storage_used_gb": 20,
            "ram_used_gb": 0.79,
            "operating_system_version": "10.0.17763",
            "cpu_name": "Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz",
            "storage_allocated_gb": 30,
            "cpu_count": 1,
            "host_name": "EC2AMAZ-9G7PBLG",
            "ram_allocated_gb": 1,
            "custom_fields": {
                "CPU_SocketDesignation": "CPU 0",
                "CPU_Manufacturer": "GenuineIntel",
                "CPU_Description": "Intel64 Family 6 Model 85 Stepping 7",
                "CPU_L3CacheSize": 36608,
                "CPU_L2CacheSize": 24576,
                "TotalVirtual_Memory_GB": 1.97,
                "TotalVisible_Memory_GB": 0.97,
                "cpu_average": 61.58534415260111,
                "cpu_peak": 99.230730450115985,
                "cpu_sampling_timeout": 30
            }
        }
    ]
}

It's also possible to capture point-in-time CPU utilization using the flags -CPUUtilizationOnlyValue and -CPUUtilizationTimeout.

Here's an example of the output of running ./runner.ps1 -CPUUtilizationOnlyValue -CPUUtilizationTimeout 1:

{
    "servers": [
        {
            "operating_system": "Microsoft Windows Server 2019 Datacenter",
            "storage_used_gb": 20,
            "ram_used_gb": 0.69,
            "operating_system_version": "10.0.17763",
            "cpu_name": "Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz",
            "storage_allocated_gb": 30,
            "cpu_count": 1,
            "host_name": "EC2AMAZ-9G7PBLG",
            "ram_allocated_gb": 1,
            "custom_fields": {
                "CPU_SocketDesignation": "CPU 0",
                "CPU_Manufacturer": "GenuineIntel",
                "CPU_Description": "Intel64 Family 6 Model 85 Stepping 7",
                "CPU_L3CacheSize": 36608,
                "CPU_L2CacheSize": 24576,
                "TotalVirtual_Memory_GB": 1.97,
                "TotalVisible_Memory_GB": 0.97,
                "cpu_utilization": 3.029071205656042,
                "cpu_utilization_timestamp": "2024-05-21 05:17:19"
            }
        }
    ]
}

You can also capture information about processes running on the host machine. This feature is disabled by default, to enable it use the flag -ProcessStats. Note that this will only work when using WinRM, and so can't be used alongside the -NoWinRM flag. Running this flag will gather the following information about a process:

User
Process Name
Process Path
Memory Used (MB)
Max Memory Used (MB)
Total Alive Time in Seconds

Here's an example of the output:

{
    "servers": [
        {
            "operating_system": "Microsoft Windows Server 2019 Datacenter",
            "storage_used_gb": 20,
            "ram_used_gb": 0.86,
            "operating_system_version": "10.0.17763",
            "cpu_name": "Intel(R) Xeon(R) Platinum 8259CL CPU @ 2.50GHz",
            "storage_allocated_gb": 30,
            "cpu_count": 1,
            "host_name": "EC2AMAZ-9G7PBLG",
            "ram_allocated_gb": 1,
            "custom_fields": {
                "CPU_SocketDesignation": "CPU 0",
                "CPU_Manufacturer": "GenuineIntel",
                "CPU_Description": "Intel64 Family 6 Model 85 Stepping 7",
                "CPU_L3CacheSize": 36608,
                "CPU_L2CacheSize": 24576,
                "TotalVirtual_Memory_GB": 1.97,
                "TotalVisible_Memory_GB": 0.97,
                "cpu_average": 69.767332954700024,
                "cpu_peak": 82.032417892836961,
                "cpu_sampling_timeout": 30
            },
            "process_stats": [
                {
                    "user": "NT AUTHORITY\\SYSTEM",
                    "name": "AM_Delta",
                    "path": "C:\\Windows\\SoftwareDistribution\\Download\\Install\\AM_Delta.exe",
                    "pid": 3280,
                    "memory_used_mb": 2.88,
                    "max_memory_used_mb": 2.99,
                    "total_alive_time": 295
                }
            ]
        }
    ]
}

NB: The names must match the names above exactly. If you wish to change these or add other values you can do so at the end of the file in windows/server_stats.ps1

Troubleshooting

Scripts disabled error

If you see an error that says:

[file] cannot be loaded because running scripts is disabled on this system.

You can allow the script to be run by executing the following:

Set-ExecutionPolicy -ExecutionPolicy ByPass -Scope CurrentUser

See the PowerShell documentation for more information.

Authentication error

If an error is returned describing that

The WinRM client cannot process the request. If the authentication scheme is different from Kerberos, or if the client computer is not joined to a domain, then HTTPS transport must be used or the destination machine must be added to the TrustedHosts configuration setting. Use winrm.cmd to configure TrustedHosts

You can resolve this by running this command:

Set-Item WSMan:localhost\client\trustedhosts -value *

You can confirm this ran successfully with, get-item WSMan:\localhost\Client\TrustedHosts, which should list an output with a * under the Value column.

After running this command you should be able to try again and successfully connect to the remote hosts to gather data.

Server name cannot be resolved error