FIRTrace


@interface FIRTrace : NSObject <FIRPerformanceAttributable>

FIRTrace objects contain information about a Trace, which is a sequence of steps. Traces can be used to measure the time taken for a sequence of steps. Traces also include Counters. Counters are used to track information which is cumulative in nature (e.g., Bytes downloaded). Counters are scoped to an FIRTrace object.

  • Name of the trace.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nonnull) NSString *name;
  • Not a valid initializer.

    Declaration

    Objective-C

    - (nonnull instancetype)init;
  • Starts the trace.

    Declaration

    Objective-C

    - (void)start;
  • Stops the trace if the trace is active.

    Declaration

    Objective-C

    - (void)stop;
  • Atomically increments the metric for the provided metric name with the provided value. If it is a new metric name, the metric value will be initialized to the value. Does nothing if the trace has not been started or has already been stopped.

    Declaration

    Objective-C

    - (void)incrementMetric:(nonnull NSString *)metricName
                      byInt:(int64_t)incrementValue;

    Parameters

    metricName

    The name of the metric to increment.

    incrementValue

    The value to increment the metric by.

  • Gets the value of the metric for the provided metric name. If the metric doesn’t exist, a 0 is returned.

    Declaration

    Objective-C

    - (int64_t)valueForIntMetric:(nonnull NSString *)metricName;

    Parameters

    metricName

    The name of metric whose value to get.