Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/siddiqsoft/winprocessinfo
Windows Process Information utility class
https://github.com/siddiqsoft/winprocessinfo
cpu-info memory-info nuget process thread-info windows
Last synced: 18 days ago
JSON representation
Windows Process Information utility class
- Host: GitHub
- URL: https://github.com/siddiqsoft/winprocessinfo
- Owner: SiddiqSoft
- License: bsd-3-clause
- Created: 2021-07-30T06:48:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-15T13:27:47.000Z (about 3 years ago)
- Last Synced: 2024-04-28T06:53:58.316Z (10 months ago)
- Topics: cpu-info, memory-info, nuget, process, thread-info, windows
- Language: C++
- Homepage:
- Size: 65.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
WinProcessInfo : Sample Windows process information
-------------------------------------------
[](https://github.com/SiddiqSoft/WinProcessInfo/actions/workflows/codeql-analysis.yml)
[](https://dev.azure.com/siddiqsoft/siddiqsoft/_build/latest?definitionId=12&branchName=main)
# Objective
Provide for a simple "stats" for a daemon/service without the heft of the full process information library.
- Minimal footprint
- Serializer for nlohmann::json (you must include the library prior to this header file)
- Serializer for std::format (if supported by your compiler)
# Requirements
- We use [`nlohmann::json`](https://github.com/nlohmann/json) only in our tests and the library is aware to provide a conversion operator if library is detected.
- We use `std::format` if present
-
# Usage
- Use the nuget [SiddiqSoft.WinProcessInfo](https://www.nuget.org/packages/SiddiqSoft.WinProcessInfo/)
- Copy paste..whatever works.
## Interface
```
WinProcessInfo
- uptime()
- snapshot()
- serializer for nlohmann::json
- serializer for std::format
```
## Example
```cpp
#include "gtest/gtest.h"
#include
#include "nlohmann/json.hpp"
#include "siddiqsoft/WinProcessInfo.hpp"
TEST(examples, Example2)
{
try {
siddiqsoft::WinProcessInfo procInfo;
// We must perform the snapshot to obtain memory and thread usage
procInfo.snapshot();
// tip: do not use brace-init/assignment as it will create an array instead of object!
nlohmann::json info(procInfo);
std::cerr << info.dump() << std::endl;
EXPECT_EQ(GetCurrentProcessId(), info.value("processId", 0));
}
catch (std::exception& e) {
EXPECT_TRUE(false) << e.what(); // if we throw then the test fails.
}
}
```
## Output
Member Field | json Field | Comments
-------------:|:----------:|:-------------------
cpuCores | `cpuCount` | Number of cores/cpu
cpuHandles | `cpuHandles` | Handle count
cpuThreads | `cpuThreads` | Thread count. _This is expensive._
memPeakWorkingSet | `memPeakWorkingSet` | Peak virtual working memory in Kbytes.
memWorkingSet | `memWorkingSet` | Current working set in Kbytes.
memPrivate | `memPrivate` | Current physically allocated memory for this process in Kbytes.
nameHostname | `hostname` | The local hostname
nameDomainName | `domain` | The fully qualified domain portion
nameHostnamePhysical | `localFqdn` | The local physical hostname
nameFqdn | `fqdn` | The fully qualified dns name
processId | `processId` | The process id
timeStartup | `timeStartup` | The startup timestamp as ISO 8601 format. _This is the time of instance of this object._
| `timeCurrent` | The current timestamp as ISO 8601 format when the serialization took place.
| `uptime` | The number of _microseconds_ between the `timeStartup` and `timeCurrent`.
Use the method `uptime()` and `duration_cast<>` to your desired ratio.
```json
{
"cpuCores": 8,
"cpuHandles": 48,
"cpuThreads": 4,
"domain": "",
"fqdn": "istanbul",
"hostname": "istanbul",
"localFqdn": "istanbul",
"memPeakWorkingSet": 42960, // KBytes
"memPrivateBytes": 84452, // Kbytes
"memWorkingSet": 42584, // Kbytes
"processId": 10828,
"timeCurrent": "2021-07-30T06:43:54.8649027Z",
"timeStartup": "2021-07-30T06:43:54.8599558Z",
"uptime": 5124 // Microseconds
}
```
© 2021 Siddiq Software LLC. All rights reserved.