Files
Hippy/framework/ios/base/HippyPerformanceLogger.h

84 lines
2.8 KiB
Objective-C

/*!
* iOS SDK
*
* Tencent is pleased to support the open source community by making
* Hippy available.
*
* Copyright (C) 2019 THL A29 Limited, a Tencent company.
* 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 <Foundation/Foundation.h>
typedef NS_ENUM(NSUInteger, HippyPLTag) {
HippyPLScriptDownload = 0, //bundle download tag
HippyExecuteSource, //bundle execution tag
HippyPLBundleSize, //bundle size tag
HippyPLNativeModuleInit, //native module initialization tag
HippyPLJSExecutorSetup, //js executor setup tag
HippyPLBridgeStartup, //bridge set up tag
HippyPLSize
};
@interface HippyPerformanceLogger : NSObject
/**
* Starts measuring a metric with the given tag.
* Overrides previous value if the measurement has been already started.
* If HippyProfile is enabled it also begins appropriate async event.
* All work is scheduled on the background queue so this doesn't block current thread.
*/
- (void)markStartForTag:(HippyPLTag)tag forKey:(NSString *)key;
/**
* Stops measuring a metric with given tag.
* Checks if HippyPerformanceLoggerStart() has been called before
* and doesn't do anything and log a message if it hasn't.
* If HippyProfile is enabled it also ends appropriate async event.
* All work is scheduled on the background queue so this doesn't block current thread.
*/
- (void)markStopForTag:(HippyPLTag)tag forKey:(NSString *)key;
/**
* Sets given value for a metric with given tag.
* All work is scheduled on the background queue so this doesn't block current thread.
*/
- (void)setValue:(int64_t)value forTag:(HippyPLTag)tag forKey:(NSString *)key;
/**
* Adds given value to the current value for a metric with given tag.
* All work is scheduled on the background queue so this doesn't block current thread.
*/
- (void)addValue:(int64_t)value forTag:(HippyPLTag)tag forKey:(NSString *)key;
/**
* Returns a duration in ms (stop_time - start_time) for given HippyPLTag.
*/
- (int64_t)durationForTag:(HippyPLTag)tag forKey:(NSString *)key;
/**
* Returns a value for given HippyPLTag.
*/
- (int64_t)valueForTag:(HippyPLTag)tag forKey:(NSString *)key;
/**
* Returns an array with values for all tags.
* Use HippyPLTag to go over the array.
*/
- (NSArray<NSString *> *)labelsForTags;
@end