Compare commits

..
Author SHA1 Message Date
gronod 0aaa9d0110 feat(telemetry): implement real-time network bandwidth and interface throughput provider (fixes #15)
MacMonitor CI/CD Pipeline / Build & Test (Intel x86_64) (push) Canceled after 0s
2026-09-08 12:35:48 +01:00
gronod 54b6e6a7f8 Merge branch 'feat/10-disk-io' into milestone/m3-advanced-telemetry
MacMonitor CI/CD Pipeline / Build & Test (Intel x86_64) (push) Canceled after 0s
2026-09-08 12:34:29 +01:00
4 changed files with 327 additions and 0 deletions
@@ -22,5 +22,6 @@
#import "MMKernelTelemetryProvider.h" #import "MMKernelTelemetryProvider.h"
#import "MMLoadAverageProvider.h" #import "MMLoadAverageProvider.h"
#import "MMDiskIOProvider.h" #import "MMDiskIOProvider.h"
#import "MMNetworkBandwidthProvider.h"
#endif /* MacMonitor_Bridging_Header_h */ #endif /* MacMonitor_Bridging_Header_h */
@@ -0,0 +1,30 @@
#ifndef MMNetworkBandwidthProvider_h
#define MMNetworkBandwidthProvider_h
#import <Foundation/Foundation.h>
#import "MMTelemetryProvider.h"
NS_ASSUME_NONNULL_BEGIN
/**
* MMNetworkBandwidthProvider
* Samples real-time network download and upload throughput, packets/sec, and error counts
* across physical (Wi-Fi, Ethernet) and virtual (VPN, bridge) network interfaces.
*/
@interface MMNetworkBandwidthProvider : NSObject <MMTelemetryProvider>
- (instancetype)init;
/**
* Pure calculator method for deterministic unit testing.
*/
+ (NSDictionary<NSString *, id> *)calculateBandwidthMetricsWithCurrentSnapshots:(NSDictionary<NSString *, NSDictionary<NSString *, NSNumber *> *> *)current
previousSnapshots:(nullable NSDictionary<NSString *, NSDictionary<NSString *, NSNumber *> *> *)previous
timeDelta:(NSTimeInterval)timeDelta
ipAddresses:(nullable NSDictionary<NSString *, NSString *> *)ipAddresses;
@end
NS_ASSUME_NONNULL_END
#endif /* MMNetworkBandwidthProvider_h */
@@ -0,0 +1,211 @@
#import "MMNetworkBandwidthProvider.h"
#import <sys/sysctl.h>
#import <net/if.h>
#import <net/if_dl.h>
#import <net/route.h>
#import <ifaddrs.h>
#import <arpa/inet.h>
#import <mach/mach_time.h>
#import <os/lock.h>
@interface MMNetworkBandwidthProvider () {
os_unfair_lock _lock;
NSDictionary<NSString *, NSDictionary<NSString *, NSNumber *> *> *_previousSnapshots;
uint64_t _previousTimestamp;
mach_timebase_info_data_t _timebase;
}
@end
@implementation MMNetworkBandwidthProvider
- (instancetype)init {
self = [super init];
if (self) {
_lock = OS_UNFAIR_LOCK_INIT;
_previousSnapshots = nil;
_previousTimestamp = 0;
mach_timebase_info(&_timebase);
}
return self;
}
- (MMTelemetryDomain)domain {
return MMTelemetryDomainNetwork;
}
- (NSString *)providerIdentifier {
return @"com.i3omb.macmonitor.telemetry.network.bandwidth";
}
- (BOOL)isAvailable {
return YES;
}
+ (NSDictionary<NSString *, id> *)calculateBandwidthMetricsWithCurrentSnapshots:(NSDictionary<NSString *, NSDictionary<NSString *, NSNumber *> *> *)current
previousSnapshots:(nullable NSDictionary<NSString *, NSDictionary<NSString *, NSNumber *> *> *)previous
timeDelta:(NSTimeInterval)timeDelta
ipAddresses:(nullable NSDictionary<NSString *, NSString *> *)ipAddresses {
double totalDownBps = 0.0;
double totalUpBps = 0.0;
double totalDownPps = 0.0;
double totalUpPps = 0.0;
NSMutableArray<NSDictionary<NSString *, id> *> *interfaces = [NSMutableArray arrayWithCapacity:current.count];
NSArray<NSString *> *sortedNames = [current.allKeys sortedArrayUsingSelector:@selector(compare:)];
NSString *primaryInterface = @"";
double maxActivity = -1.0;
for (NSString *name in sortedNames) {
// Skip loopback for aggregate statistics
BOOL isLoopback = [name hasPrefix:@"lo"];
NSDictionary<NSString *, NSNumber *> *curr = current[name];
NSDictionary<NSString *, NSNumber *> *prev = previous ? previous[name] : nil;
uint64_t currInBytes = [curr[@"inBytes"] unsignedLongLongValue];
uint64_t currOutBytes = [curr[@"outBytes"] unsignedLongLongValue];
uint64_t currInPackets = [curr[@"inPackets"] unsignedLongLongValue];
uint64_t currOutPackets = [curr[@"outPackets"] unsignedLongLongValue];
uint64_t inErrors = [curr[@"inErrors"] unsignedLongLongValue];
uint64_t outErrors = [curr[@"outErrors"] unsignedLongLongValue];
uint64_t prevInBytes = prev ? [prev[@"inBytes"] unsignedLongLongValue] : currInBytes;
uint64_t prevOutBytes = prev ? [prev[@"outBytes"] unsignedLongLongValue] : currOutBytes;
uint64_t prevInPackets = prev ? [prev[@"inPackets"] unsignedLongLongValue] : currInPackets;
uint64_t prevOutPackets = prev ? [prev[@"outPackets"] unsignedLongLongValue] : currOutPackets;
double deltaInBytes = (currInBytes >= prevInBytes) ? (double)(currInBytes - prevInBytes) : 0.0;
double deltaOutBytes = (currOutBytes >= prevOutBytes) ? (double)(currOutBytes - prevOutBytes) : 0.0;
double deltaInPackets = (currInPackets >= prevInPackets) ? (double)(currInPackets - prevInPackets) : 0.0;
double deltaOutPackets = (currOutPackets >= prevOutPackets) ? (double)(currOutPackets - prevOutPackets) : 0.0;
double downBps = (timeDelta > 0.0001) ? (deltaInBytes / timeDelta) : 0.0;
double upBps = (timeDelta > 0.0001) ? (deltaOutBytes / timeDelta) : 0.0;
double downPps = (timeDelta > 0.0001) ? (deltaInPackets / timeDelta) : 0.0;
double upPps = (timeDelta > 0.0001) ? (deltaOutPackets / timeDelta) : 0.0;
if (!isLoopback) {
totalDownBps += downBps;
totalUpBps += upBps;
totalDownPps += downPps;
totalUpPps += upPps;
double activity = downBps + upBps;
if (activity > maxActivity) {
maxActivity = activity;
primaryInterface = name;
}
}
NSString *ip = ipAddresses[name] ?: @"";
[interfaces addObject:@{
@"name": name,
@"downloadBytesPerSec": @(downBps),
@"uploadBytesPerSec": @(upBps),
@"downloadPacketsPerSec": @(downPps),
@"uploadPacketsPerSec": @(upPps),
@"cumulativeInBytes": @(currInBytes),
@"cumulativeOutBytes": @(currOutBytes),
@"cumulativeInPackets": @(currInPackets),
@"cumulativeOutPackets": @(currOutPackets),
@"inErrors": @(inErrors),
@"outErrors": @(outErrors),
@"ipv4Address": ip,
@"isLoopback": @(isLoopback)
}];
}
if (primaryInterface.length == 0 && current[@"en0"]) {
primaryInterface = @"en0";
}
return @{
@"interfaces": interfaces,
@"totalDownloadBytesPerSec": @(totalDownBps),
@"totalUploadBytesPerSec": @(totalUpBps),
@"totalDownloadPacketsPerSec": @(totalDownPps),
@"totalUploadPacketsPerSec": @(totalUpPps),
@"primaryInterface": primaryInterface,
@"timeDelta": @(timeDelta)
};
}
- (nullable NSDictionary<NSString *, id> *)sampleTelemetryWithError:(NSError **)error {
uint64_t now = mach_absolute_time();
// 1. Read 64-bit interface stats via NET_RT_IFLIST2
NSMutableDictionary<NSString *, NSDictionary<NSString *, NSNumber *> *> *currentSnapshots = [NSMutableDictionary dictionary];
int mib[] = { CTL_NET, PF_ROUTE, 0, 0, NET_RT_IFLIST2, 0 };
size_t len = 0;
if (sysctl(mib, 6, NULL, &len, NULL, 0) == 0 && len > 0) {
char *buf = malloc(len);
if (buf && sysctl(mib, 6, buf, &len, NULL, 0) == 0) {
char *next = buf;
char *lim = buf + len;
while (next < lim) {
struct if_msghdr *ifm = (struct if_msghdr *)next;
next += ifm->ifm_msglen;
if (ifm->ifm_type == RTM_IFINFO2) {
struct if_msghdr2 *if2m = (struct if_msghdr2 *)ifm;
struct sockaddr_dl *sdl = (struct sockaddr_dl *)(if2m + 1);
if (sdl->sdl_nlen > 0 && sdl->sdl_nlen < 32) {
char nameBuf[33] = {0};
memcpy(nameBuf, sdl->sdl_data, sdl->sdl_nlen);
NSString *name = [NSString stringWithUTF8String:nameBuf];
currentSnapshots[name] = @{
@"inBytes": @(if2m->ifm_data.ifi_ibytes),
@"outBytes": @(if2m->ifm_data.ifi_obytes),
@"inPackets": @(if2m->ifm_data.ifi_ipackets),
@"outPackets": @(if2m->ifm_data.ifi_opackets),
@"inErrors": @(if2m->ifm_data.ifi_ierrors),
@"outErrors": @(if2m->ifm_data.ifi_oerrors)
};
}
}
}
}
if (buf) free(buf);
}
// 2. Query IPv4 addresses via getifaddrs
NSMutableDictionary<NSString *, NSString *> *ipDict = [NSMutableDictionary dictionary];
struct ifaddrs *ifap = NULL;
if (getifaddrs(&ifap) == 0) {
for (struct ifaddrs *ifa = ifap; ifa != NULL; ifa = ifa->ifa_next) {
if (ifa->ifa_addr && ifa->ifa_addr->sa_family == AF_INET) {
char ipBuf[INET_ADDRSTRLEN] = {0};
struct sockaddr_in *sin = (struct sockaddr_in *)ifa->ifa_addr;
if (inet_ntop(AF_INET, &sin->sin_addr, ipBuf, sizeof(ipBuf))) {
NSString *name = [NSString stringWithUTF8String:ifa->ifa_name];
ipDict[name] = [NSString stringWithUTF8String:ipBuf];
}
}
}
freeifaddrs(ifap);
}
os_unfair_lock_lock(&_lock);
NSDictionary<NSString *, NSDictionary<NSString *, NSNumber *> *> *prev = _previousSnapshots;
uint64_t prevTime = _previousTimestamp;
_previousSnapshots = currentSnapshots;
_previousTimestamp = now;
os_unfair_lock_unlock(&_lock);
NSTimeInterval timeDelta = 1.0;
if (prevTime > 0) {
uint64_t elapsed = now - prevTime;
timeDelta = (double)elapsed * _timebase.numer / _timebase.denom / 1e9;
}
return [MMNetworkBandwidthProvider calculateBandwidthMetricsWithCurrentSnapshots:currentSnapshots
previousSnapshots:prev
timeDelta:timeDelta
ipAddresses:ipDict];
}
@end
+85
View File
@@ -0,0 +1,85 @@
import XCTest
@testable import MacMonitor
final class MMNetworkBandwidthTests: XCTestCase {
func testNetworkBandwidthCalculation() {
let prev: [String: [String: NSNumber]] = [
"en0": [
"inBytes": NSNumber(value: 50_000_000),
"outBytes": NSNumber(value: 10_000_000),
"inPackets": NSNumber(value: 40_000),
"outPackets": NSNumber(value: 20_000),
"inErrors": NSNumber(value: 0),
"outErrors": NSNumber(value: 0)
],
"lo0": [
"inBytes": NSNumber(value: 5_000_000),
"outBytes": NSNumber(value: 5_000_000),
"inPackets": NSNumber(value: 5_000),
"outPackets": NSNumber(value: 5_000),
"inErrors": NSNumber(value: 0),
"outErrors": NSNumber(value: 0)
]
]
let curr: [String: [String: NSNumber]] = [
"en0": [
"inBytes": NSNumber(value: 60_000_000), // delta in = 10,000,000 bytes
"outBytes": NSNumber(value: 12_000_000), // delta out = 2,000,000 bytes
"inPackets": NSNumber(value: 48_000), // delta in = 8,000 pkts
"outPackets": NSNumber(value: 24_000), // delta out = 4,000 pkts
"inErrors": NSNumber(value: 0),
"outErrors": NSNumber(value: 0)
],
"lo0": [
"inBytes": NSNumber(value: 7_000_000),
"outBytes": NSNumber(value: 7_000_000),
"inPackets": NSNumber(value: 7_000),
"outPackets": NSNumber(value: 7_000),
"inErrors": NSNumber(value: 0),
"outErrors": NSNumber(value: 0)
]
]
let timeDelta: TimeInterval = 2.0 // 2 seconds
let ipDict: [String: String] = ["en0": "192.168.1.100", "lo0": "127.0.0.1"]
let metrics = MMNetworkBandwidthProvider.calculateBandwidthMetrics(
withCurrentSnapshots: curr,
previousSnapshots: prev,
timeDelta: timeDelta,
ipAddresses: ipDict
)
let totalDownBps = metrics["totalDownloadBytesPerSec"] as? Double ?? 0
let totalUpBps = metrics["totalUploadBytesPerSec"] as? Double ?? 0
let totalDownPps = metrics["totalDownloadPacketsPerSec"] as? Double ?? 0
let totalUpPps = metrics["totalUploadPacketsPerSec"] as? Double ?? 0
let primary = metrics["primaryInterface"] as? String ?? ""
let interfaces = metrics["interfaces"] as? [[String: Any]] ?? []
// en0 delta in = 10MB / 2s = 5,000,000 B/s (lo0 is excluded from total)
XCTAssertEqual(totalDownBps, 5_000_000.0, accuracy: 1.0)
// en0 delta out = 2MB / 2s = 1,000,000 B/s
XCTAssertEqual(totalUpBps, 1_000_000.0, accuracy: 1.0)
// en0 delta in pkts = 8,000 / 2s = 4,000 pps
XCTAssertEqual(totalDownPps, 4000.0, accuracy: 0.1)
// en0 delta out pkts = 4,000 / 2s = 2,000 pps
XCTAssertEqual(totalUpPps, 2000.0, accuracy: 0.1)
XCTAssertEqual(primary, "en0")
XCTAssertEqual(interfaces.count, 2)
}
func testLiveNetworkBandwidthProvider() throws {
let provider = MMNetworkBandwidthProvider()
XCTAssertEqual(provider.domain, .network)
XCTAssertEqual(provider.providerIdentifier, "com.i3omb.macmonitor.telemetry.network.bandwidth")
let sample = try provider.sampleTelemetry()
XCTAssertNotNil(sample)
XCTAssertNotNil(sample["totalDownloadBytesPerSec"])
XCTAssertNotNil(sample["totalUploadBytesPerSec"])
XCTAssertNotNil(sample["interfaces"])
}
}