Merge c4a9a1e into 66c32dc

Source/common/SNTCommonEnums.h

@@ -91,6 +91,12 @@ typedef NS_ENUM(NSInteger, SNTEventLogType) {
   SNTEventLogTypeFilelog,
 };
 
+typedef NS_ENUM(NSInteger, SNTMetricFormatType) {
+  SNTMetricFormatTypeUnknown,
+  SNTMetricFormatTypeRawJSON,
+  SNTMetricFormatTypeJSON,
+};
+
 static const char *kKextPath = "/Library/Extensions/santa-driver.kext";
 static const char *kSantaDPath =
   "/Applications/Santa.app/Contents/Library/SystemExtensions/"

Source/common/SNTConfigurator.h

@@ -371,6 +371,22 @@
 ///
 @property(readonly, nonatomic) BOOL fcmEnabled;
 
+///
+/// True if metricsFormat and metricsURL are set. False otherwise.
+///
+@property(readonly, nonatomic) BOOL exportMetrics;
+
+///
+/// Format to export Metrics as.
+///
+@property(readonly, nonatomic) SNTMetricFormatType metricFormat;
+
+///
+/// URL describing where metrics are exported, defaults to nil.
+///
+@property(readonly, nonatomic) NSURL *metricURL;
+
+
 ///
 ///  Retrieve an initialized singleton configurator object using the default file path.
 ///

Source/common/SNTConfigurator.m

@@ -1,4 +1,4 @@
-/// Copyright 2015 Google Inc. All rights reserved.
+/// 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.
@@ -101,6 +101,12 @@ @implementation SNTConfigurator
 static NSString *const kBlockedPathRegexKey = @"BlockedPathRegex";
 static NSString *const kBlockedPathRegexKeyDeprecated = @"BlacklistRegex";
 
+// TODO(markowsky): move these to sync server only.
+// Valid values for kMetricsFormat should be rawjson, and json. 
+// TODO(markowsky): add support for prometheus.
+static NSString *const kMetricsFormat = @"MetricsFormat";
+static NSString *const kMetricsURL = @"MetricsURL";
+
 // The keys managed by a sync server.
 static NSString *const kFullSyncLastSuccess = @"FullSyncLastSuccess";
 static NSString *const kRuleSyncLastSuccess = @"RuleSyncLastSuccess";
@@ -171,6 +177,8 @@ - (instancetype)init {
       kFCMProject : string,
       kFCMEntity : string,
       kFCMAPIKey : string,
+      kMetricsFormat : number,
+      kMetricsURL : string,
     };
     _defaults = [NSUserDefaults standardUserDefaults];
     [_defaults addSuiteNamed:@"com.google.santa"];
@@ -654,6 +662,32 @@ - (BOOL)fcmEnabled {
   return (self.fcmProject.length && self.fcmEntity.length && self.fcmAPIKey.length);
 }
 
+
+///
+/// Returns YES if all of the necessary options are set to export metrics, NO
+/// otherwise.
+///
+- (BOOL) exportMetrics {
+  return self.configState[kMetricsFormat] != SNTMetricFormatTypeUnknown &&
+    ![self.configState[kMetricsURL] isEqualToString:@""];
+}
+
+- (SNTMetricFormatType)metricsFormat {
+  switch ([self.configState[kMetricsFormat] longLongValue]) {
+    case SNTMetricFormatTypeRawJSON:
+      return SNTMetricFormatTypeRawJSON;
+    case SNTMetricFormatTypeJSON:
+      return SNTMetricFormatTypeJSON;
+    default:
+      return SNTMetricFormatTypeUnknown;
+  }
+}
+
+- (NSURL *)metricsURL {
+  return [NSURL URLWithString:self.configState[kMetricsURL]];
+}
+
+
 #pragma mark Private
 
 ///

docs/deployment/configuration.md

@@ -47,6 +47,8 @@ Additionally, there are options that can be controlled by both.
 | EventLogType                  | String     | Defines how event logs are stored. Options are 1) syslog: Sent to ASL or ULS (if built with the 10.12 SDK or later). 2) filelog: Sent to a file on disk. Use EventLogPath to specify a path. Defaults to filelog      |
 | EventLogPath                  | String     | If EventLogType is set to filelog, EventLogPath will provide the path to save logs. Defaults to /var/db/santa/santa.log. If you change this value ensure you also update com.google.santa.newsyslog.conf with the new path.        |
 | EnableMachineIDDecoration     | Bool       | If YES, this appends the MachineID to the end of each log line. Defaults to NO.       |
+| MetricFormat                 | Integer     | Format to export metrics as 0 = None, 1 = Raw JSON blob, 2 = JSON one metric per line. Defaults to 0. |
+| MetricURL                    | String     | URL describing where monitoring metrics should be exported.  |
 
 *overridable by the sync server: run `santactl status` to check the current
 running config