Analytics/SFAnalyticsLogger.h

   1 /*
   2  * Copyright (c) 2017 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #import <Foundation/Foundation.h>
  25
  26 #if __OBJC2__
  27
  28 @interface SFAnalyticsLogger : NSObject <NSURLSessionDelegate>
  29
  30 + (instancetype)logger;
  31
  32 + (NSInteger)fuzzyDaysSinceDate:(NSDate*)date;
  33
  34 - (void)logSuccessForEventNamed:(NSString*)eventName;
  35 - (void)logHardFailureForEventNamed:(NSString*)eventName withAttributes:(NSDictionary*)attributes;
  36 - (void)logSoftFailureForEventNamed:(NSString*)eventName withAttributes:(NSDictionary*)attributes;
  37
  38 - (void)noteEventNamed:(NSString*)eventName;
  39
  40 // --------------------------------
  41 // Things below are for subclasses
  42
  43 // Override to create a concrete logger instance
  44 @property (readonly, class) NSString* databasePath;
  45
  46 // Storing dates
  47 - (void)setDateProperty:(NSDate*)date forKey:(NSString*)key;
  48 - (NSDate*)datePropertyForKey:(NSString*)key;
  49
  50 - (NSDictionary*)extraValuesToUploadToServer;
  51 - (NSString*)sysdiagnoseStringForEventRecord:(NSDictionary*)eventRecord;
  52
  53 // --------------------------------
  54 // Things below are for utilities to drive and/or test the system
  55
  56 - (NSString*)getSysdiagnoseDumpWithError:(NSError**)error;
  57 - (NSData*)getLoggingJSONWithError:(NSError**)error;
  58 - (BOOL)forceUploadWithError:(NSError**)error;
  59
  60 // --------------------------------
  61 // Things below are for unit testing
  62
  63 @property (readonly) dispatch_queue_t splunkLoggingQueue;
  64 @property (readonly) NSURL* splunkUploadURL;
  65 @property (readonly) NSString* splunkTopicName;
  66 @property (readonly) NSURL* splunkBagURL;
  67 @property (readonly) BOOL allowsInsecureSplunkCert;
  68 @property BOOL ignoreServerDisablingMessages;
  69
  70 @end
  71
  72 #endif