| 1 |
efrain |
1 |
// Copyright 2020 Google LLC
|
|
|
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 <Foundation/Foundation.h>
|
|
|
16 |
|
|
|
17 |
#import "FIRTrace.h"
|
|
|
18 |
|
|
|
19 |
/**
|
|
|
20 |
* This class allows you to configure the Firebase Performance Reporting SDK. It also provides the
|
|
|
21 |
* interfaces to create timers and enable or disable automatic metrics capture.
|
|
|
22 |
*
|
|
|
23 |
* This SDK uses a Firebase Installations ID to identify the app instance and periodically sends
|
|
|
24 |
* data to the Firebase backend. (see `[FIRInstallations installationIDWithCompletion:]`).
|
|
|
25 |
* To stop the periodic sync, call `[FIRInstallations deleteWithCompletion:]` and
|
|
|
26 |
* either disable this SDK or set FIRPerformance.dataCollectionEnabled to NO.
|
|
|
27 |
*/
|
|
|
28 |
NS_EXTENSION_UNAVAILABLE("FirebasePerformance does not support app extensions at this time.")
|
|
|
29 |
NS_SWIFT_NAME(Performance)
|
|
|
30 |
@interface FIRPerformance : NSObject
|
|
|
31 |
|
|
|
32 |
/**
|
|
|
33 |
* Controls the capture of performance data. When this value is set to NO, none of the performance
|
|
|
34 |
* data will sent to the server. Default is YES.
|
|
|
35 |
*
|
|
|
36 |
* This setting is persisted, and is applied on future invocations of your application. Once
|
|
|
37 |
* explicitly set, it overrides any settings in your Info.plist.
|
|
|
38 |
*/
|
|
|
39 |
@property(nonatomic, assign, getter=isDataCollectionEnabled) BOOL dataCollectionEnabled;
|
|
|
40 |
|
|
|
41 |
/**
|
|
|
42 |
* Controls the instrumentation of the app to capture performance data. Setting this value to NO has
|
|
|
43 |
* immediate effect only if it is done so before calling [FIRApp configure]. Otherwise it takes
|
|
|
44 |
* effect after the app starts again the next time.
|
|
|
45 |
*
|
|
|
46 |
* If set to NO, the app will not be instrumented to collect performance
|
|
|
47 |
* data (in scenarios like app_start, networking monitoring). Default is YES.
|
|
|
48 |
*
|
|
|
49 |
* This setting is persisted, and is applied on future invocations of your application. Once
|
|
|
50 |
* explicitly set, it overrides any settings in your Info.plist.
|
|
|
51 |
*/
|
|
|
52 |
@property(nonatomic, assign, getter=isInstrumentationEnabled) BOOL instrumentationEnabled;
|
|
|
53 |
|
|
|
54 |
/** @return The shared instance. */
|
|
|
55 |
+ (nonnull instancetype)sharedInstance NS_SWIFT_NAME(sharedInstance());
|
|
|
56 |
|
|
|
57 |
/**
|
|
|
58 |
* Creates an instance of FIRTrace after creating the shared instance of FIRPerformance. The trace
|
|
|
59 |
* will automatically be started on a successful creation of the instance. The |name| of the trace
|
|
|
60 |
* cannot be an empty string.
|
|
|
61 |
*
|
|
|
62 |
* @param name The name of the Trace.
|
|
|
63 |
* @return The FIRTrace object.
|
|
|
64 |
*/
|
|
|
65 |
+ (nullable FIRTrace *)startTraceWithName:(nonnull NSString *)name NS_SWIFT_NAME(startTrace(name:));
|
|
|
66 |
|
|
|
67 |
/**
|
|
|
68 |
* Creates an instance of FIRTrace. This API does not start the trace. To start the trace, use the
|
|
|
69 |
* -start API on the returned |FIRTrace| object. The |name| cannot be an empty string.
|
|
|
70 |
*
|
|
|
71 |
* @param name The name of the Trace.
|
|
|
72 |
* @return The FIRTrace object.
|
|
|
73 |
*/
|
|
|
74 |
- (nullable FIRTrace *)traceWithName:(nonnull NSString *)name NS_SWIFT_NAME(trace(name:));
|
|
|
75 |
|
|
|
76 |
@end
|