4025805081

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/google/santa/commit/<a class=hub.com/google/santa/commit/<a class="double-link" href="https://git"><a class=hub.com/google/santa/commit/<a class="double-link" href="https://git"><a class=hub.com/google/santa/commit/3ccfa5d2a6c4a67b0f4807fce1da2d37d8707364">3ccfa5d2a<a href="https://github.com/google/santa/commit/3ccfa5d2a6c4a67b0f4807fce1da2d37d8707364">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/google/santa/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/google/santa/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/google/santa/commit/3ccfa5d2a6c4a67b0f4807fce1da2d37d8707364&quot;&gt;3ccfa5d2a&lt;/a&gt;&lt;a href=&quot;https://github.com/google/santa/commit/3ccfa5d2a6c4a67b0f4807fce1da2d37d8707364&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/google/santa/commit/3ccfa5d2a6c4a67b0f4807fce1da2d37&lt;/a&gt;d8707364">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/google/santa/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/google/santa/commit/<a class="double-link" href="https://github.com/google/santa/commit/7ab4bb22c2e2757d1640dfedcba31b068a4c20ce">7ab4bb22c</a><a href="https://github.com/google/santa/commit/3ccfa5d2a6c4a67b0f4807fce1da2d37d8707364">&amp;quot;&amp;gt;7ab4bb22c&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;7ab4bb22c&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/google/santa/commit/3ccfa5d2a6c4a67b0f4807fce1da2d37d8707&lt;/a&gt;364&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/google/santa/commit/<a class="double-link" href="https://github.com/google/santa/commit/b4149816c">b4149816c">b4149816c</a>

Pull Request Pull Request #1018: Log type metrics

Run Details

3818 of 7740 branches covered (49.33%)

Branch coverage included in aggregate %.

30 of 30 new or added lines in 2 files covered. (100.0%)

13541 of 18946 relevant lines covered (71.47%)

15876.92 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.03

/Source/santad/SNTApplicationCoreMetrics.mm

/// Copyright 2021 Google Inc. All rights reserved.
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
///    http://www.apache.org/licenses/LICENSE-2.0
///
///    Unless required by applicable law or agreed to in writing, software
///    distributed under the License is distributed on an "AS IS" BASIS,
///    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
///    See the License for the specific language governing permissions and
///    limitations under the License.

#import "Source/santad/SNTApplicationCoreMetrics.h"

#import <Foundation/Foundation.h>
#include <mach/mach.h>
#include <sys/resource.h>

#import "Source/common/SNTCommonEnums.h"
#import "Source/common/SNTConfigurator.h"
#import "Source/common/SNTMetricSet.h"
#import "Source/common/SNTSystemInfo.h"
#import "Source/common/SystemResources.h"

/**
 * Register the mode metric checking the config before reporting the status.
 */
static void RegisterModeMetric(SNTMetricSet *metricSet) {
  SNTMetricStringGauge *mode = [metricSet stringGaugeWithName:@"/santa/mode"
                                                   fieldNames:@[]
                                                     helpText:@"Santa's operating mode"];

  // create a callback that gets the current mode
  [metricSet registerCallback:^{
    SNTConfigurator *config = [SNTConfigurator configurator];

    switch (config.clientMode) {
      case SNTClientModeLockdown: [mode set:@"lockdown" forFieldValues:@[]]; break;
      case SNTClientModeMonitor: [mode set:@"monitor" forFieldValues:@[]]; break;
      default:
        // Should never be reached.
        [mode set:@"unknown" forFieldValues:@[]];
        break;
    }
  }];
}

/**
 * Register the event log type metric checking the config before reporting the status.
 */
static void RegisterEventLogType(SNTMetricSet *metricSet) {
  SNTMetricStringGauge *logType = [metricSet stringGaugeWithName:@"/santa/log_type"
                                                      fieldNames:@[]
                                                        helpText:@"Santa's log type"];

  // create a callback that gets the current log type
  [metricSet registerCallback:^{
    switch ([[SNTConfigurator configurator] eventLogType]) {
      case SNTEventLogTypeProtobuf: [logType set:@"protobuf" forFieldValues:@[]]; break;
      case SNTEventLogTypeSyslog: [logType set:@"syslog" forFieldValues:@[]]; break;
      case SNTEventLogTypeNull: [logType set:@"null" forFieldValues:@[]]; break;
      case SNTEventLogTypeFilelog: [logType set:@"file" forFieldValues:@[]]; break;
      default:
        // Should never be reached.
        [logType set:@"unknown" forFieldValues:@[]];
        break;
    }
  }];
}

/**
 * Register metrics for measuring memory usage.
 */
static void RegisterMemoryAndCPUMetrics(SNTMetricSet *metricSet) {
  SNTMetricInt64Gauge *vsize =
    [metricSet int64GaugeWithName:@"/proc/memory/virtual_size"
                       fieldNames:@[]
                         helpText:@"The virtual memory size of this process"];
  SNTMetricInt64Gauge *rsize =
    [metricSet int64GaugeWithName:@"/proc/memory/resident_size"
                       fieldNames:@[]
                         helpText:@"The resident set size of this process"];

  SNTMetricDoubleGauge *cpuUsage =
    [metricSet doubleGaugeWithName:@"/proc/cpu_usage"
                        fieldNames:@[ @"mode" ]  // "user" or "system"
                          helpText:@"CPU time consumed by this process, in seconds"];

  [metricSet registerCallback:^(void) {
    std::optional<SantaTaskInfo> tinfo = GetTaskInfo();
    if (!tinfo.has_value()) {
      return;
    }

    [vsize set:tinfo->virtual_size forFieldValues:@[]];
    [rsize set:tinfo->resident_size forFieldValues:@[]];

    // convert times to seconds
    double user_time = tinfo->total_user_nanos / (double)NSEC_PER_SEC;
    double system_time = tinfo->total_system_nanos / (double)NSEC_PER_SEC;

    [cpuUsage set:user_time forFieldValues:@[ @"user" ]];
    [cpuUsage set:system_time forFieldValues:@[ @"system" ]];
  }];
}

static void RegisterHostnameAndUsernameLabels(SNTMetricSet *metricSet) {
  NSString *hostname = [NSProcessInfo processInfo].hostName;

  [metricSet addRootLabel:@"host_name" value:hostname];
  [metricSet addRootLabel:@"username" value:NSUserName()];
  [metricSet addRootLabel:@"job_name" value:@"santad"];
  [metricSet addRootLabel:@"service_name" value:@"santa"];

  // get extra root labels from configuration
  SNTConfigurator *config = [SNTConfigurator configurator];

  NSDictionary *extraLabels = [config extraMetricLabels];

  if (extraLabels.count == 0) return;

  for (NSString *key in extraLabels) {
    // remove the root label if the value is empty.
    if ([@"" isEqualToString:(NSString *)extraLabels[key]]) {
      [metricSet removeRootLabel:key];
      continue;
    }

    // Set or override the value.
    [metricSet addRootLabel:key value:(NSString *)extraLabels[key]];
  }
}
static void RegisterCommonSantaMetrics(SNTMetricSet *metricSet) {
  NSString *version = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleVersion"];

  // register the version
  [metricSet addConstantStringWithName:@"/build/label"
                              helpText:@"Version of the binary"
                                 value:version];

  // register start time
  [metricSet
    addConstantIntegerWithName:@"/proc/birth_timestamp"
                      helpText:@"Start time of Santad, in microseconds since epoch"
                         value:(long long)([[NSDate date] timeIntervalSince1970] * 1000000)];

  // Register OS version
  [metricSet addConstantStringWithName:@"/proc/os/version"
                              helpText:@"Short operating System version"
                                 value:[SNTSystemInfo osVersion]];

  RegisterModeMetric(metricSet);
  RegisterEventLogType(metricSet);
  // TODO(markowsky) Register CSR status
  // TODO(markowsky) Register system extension status
}

void SNTRegisterCoreMetrics() {
  SNTMetricSet *metricSet = [SNTMetricSet sharedInstance];
  RegisterHostnameAndUsernameLabels(metricSet);
  RegisterMemoryAndCPUMetrics(metricSet);
  RegisterCommonSantaMetrics(metricSet);
}

1	/// Copyright 2021 Google Inc. All rights reserved.
2	///
3	/// Licensed under the Apache License, Version 2.0 (the "License");
4	/// you may not use this file except in compliance with the License.
5	/// You may obtain a copy of the License at
6	///
7	/// http://www.apache.org/licenses/LICENSE-2.0
8	///
9	/// Unless required by applicable law or agreed to in writing, software
10	/// distributed under the License is distributed on an "AS IS" BASIS,
11	/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12	/// See the License for the specific language governing permissions and
13	/// limitations under the License.
14
15	#import "Source/santad/SNTApplicationCoreMetrics.h"
16
17	#import <Foundation/Foundation.h>
18	#include <mach/mach.h>
19	#include <sys/resource.h>
20
21	#import "Source/common/SNTCommonEnums.h"
22	#import "Source/common/SNTConfigurator.h"
23	#import "Source/common/SNTMetricSet.h"
24	#import "Source/common/SNTSystemInfo.h"
25	#import "Source/common/SystemResources.h"
26
27	/**
28	* Register the mode metric checking the config before reporting the status.
29	*/
30	static void RegisterModeMetric(SNTMetricSet *metricSet) {	3✔
31	SNTMetricStringGauge *mode = [metricSet stringGaugeWithName:@"/santa/mode"	3✔
32	fieldNames:@[]	3✔
33	helpText:@"Santa's operating mode"];	3✔
34
35	// create a callback that gets the current mode
36	[metricSet registerCallback:^{	6✔
37	SNTConfigurator *config = [SNTConfigurator configurator];	6✔
38
39	switch (config.clientMode) {	6✔
40	case SNTClientModeLockdown: [mode set:@"lockdown" forFieldValues:@[]]; break;	1✔
41	case SNTClientModeMonitor: [mode set:@"monitor" forFieldValues:@[]]; break;	×
42	default:	5✔
43	// Should never be reached.
44	[mode set:@"unknown" forFieldValues:@[]];	5✔
45	break;	5✔
46	}	6✔
47	}];	6✔
48	}	3✔
49
50	/**
51	* Register the event log type metric checking the config before reporting the status.
52	*/
53	static void RegisterEventLogType(SNTMetricSet *metricSet) {	3✔
54	SNTMetricStringGauge *logType = [metricSet stringGaugeWithName:@"/santa/log_type"	3✔
55	fieldNames:@[]	3✔
56	helpText:@"Santa's log type"];	3✔
57
58	// create a callback that gets the current log type
59	[metricSet registerCallback:^{	6✔
60	switch ([[SNTConfigurator configurator] eventLogType]) {	6✔
61	case SNTEventLogTypeProtobuf: [logType set:@"protobuf" forFieldValues:@[]]; break;	1✔
62	case SNTEventLogTypeSyslog: [logType set:@"syslog" forFieldValues:@[]]; break;	5✔
63	case SNTEventLogTypeNull: [logType set:@"null" forFieldValues:@[]]; break;	×
64	case SNTEventLogTypeFilelog: [logType set:@"file" forFieldValues:@[]]; break;	×
65	default:	×
66	// Should never be reached.
67	[logType set:@"unknown" forFieldValues:@[]];	×
68	break;	×
69	}	6✔
70	}];	6✔
71	}	3✔
72
73	/**
74	* Register metrics for measuring memory usage.
75	*/
76	static void RegisterMemoryAndCPUMetrics(SNTMetricSet *metricSet) {	3✔
77	SNTMetricInt64Gauge *vsize =	3✔
78	[metricSet int64GaugeWithName:@"/proc/memory/virtual_size"	3✔
79	fieldNames:@[]	3✔
80	helpText:@"The virtual memory size of this process"];	3✔
81	SNTMetricInt64Gauge *rsize =	3✔
82	[metricSet int64GaugeWithName:@"/proc/memory/resident_size"	3✔
83	fieldNames:@[]	3✔
84	helpText:@"The resident set size of this process"];	3✔
85
86	SNTMetricDoubleGauge *cpuUsage =	3✔
87	[metricSet doubleGaugeWithName:@"/proc/cpu_usage"	3✔
88	fieldNames:@[ @"mode" ] // "user" or "system"	3✔
89	helpText:@"CPU time consumed by this process, in seconds"];	3✔
90
91	[metricSet registerCallback:^(void) {	6✔
92	std::optional<SantaTaskInfo> tinfo = GetTaskInfo();	6✔
93	if (!tinfo.has_value()) {	6!
94	return;	×
95	}	×
96
97	[vsize set:tinfo->virtual_size forFieldValues:@[]];	6✔
98	[rsize set:tinfo->resident_size forFieldValues:@[]];	6✔
99
100	// convert times to seconds
101	double user_time = tinfo->total_user_nanos / (double)NSEC_PER_SEC;	6✔
102	double system_time = tinfo->total_system_nanos / (double)NSEC_PER_SEC;	6✔
103
104	[cpuUsage set:user_time forFieldValues:@[ @"user" ]];	6✔
105	[cpuUsage set:system_time forFieldValues:@[ @"system" ]];	6✔
106	}];	6✔
107	}	3✔
108
109	static void RegisterHostnameAndUsernameLabels(SNTMetricSet *metricSet) {	3✔
110	NSString *hostname = [NSProcessInfo processInfo].hostName;	3✔
111
112	[metricSet addRootLabel:@"host_name" value:hostname];	3✔
113	[metricSet addRootLabel:@"username" value:NSUserName()];	3✔
114	[metricSet addRootLabel:@"job_name" value:@"santad"];	3✔
115	[metricSet addRootLabel:@"service_name" value:@"santa"];	3✔
116
117	// get extra root labels from configuration
118	SNTConfigurator *config = [SNTConfigurator configurator];	3✔
119
120	NSDictionary *extraLabels = [config extraMetricLabels];	3✔
121
122	if (extraLabels.count == 0) return;	3!
123
124	for (NSString *key in extraLabels) {	4✔
125	// remove the root label if the value is empty.
126	if ([@"" isEqualToString:(NSString *)extraLabels[key]]) {	4✔
127	[metricSet removeRootLabel:key];	1✔
128	continue;	1✔
129	}	1✔
130
131	// Set or override the value.
132	[metricSet addRootLabel:key value:(NSString *)extraLabels[key]];	3✔
133	}	3✔
134	}	3✔
135	static void RegisterCommonSantaMetrics(SNTMetricSet *metricSet) {	3✔
136	NSString *version = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleVersion"];	3✔
137
138	// register the version
139	[metricSet addConstantStringWithName:@"/build/label"	3✔
140	helpText:@"Version of the binary"	3✔
141	value:version];	3✔
142
143	// register start time
144	[metricSet	3✔
145	addConstantIntegerWithName:@"/proc/birth_timestamp"	3✔
146	helpText:@"Start time of Santad, in microseconds since epoch"	3✔
147	value:(long long)([[NSDate date] timeIntervalSince1970] * 1000000)];	3✔
148
149	// Register OS version
150	[metricSet addConstantStringWithName:@"/proc/os/version"	3✔
151	helpText:@"Short operating System version"	3✔
152	value:[SNTSystemInfo osVersion]];	3✔
153
154	RegisterModeMetric(metricSet);	3✔
155	RegisterEventLogType(metricSet);	3✔
156	// TODO(markowsky) Register CSR status
157	// TODO(markowsky) Register system extension status
158	}	3✔
159
160	void SNTRegisterCoreMetrics() {	3✔
161	SNTMetricSet *metricSet = [SNTMetricSet sharedInstance];	3✔
162	RegisterHostnameAndUsernameLabels(metricSet);	3✔
163	RegisterMemoryAndCPUMetrics(metricSet);	3✔
164	RegisterCommonSantaMetrics(metricSet);	3✔
165	}	3✔

google / santa / 4025805081

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous