Class MetricsReporter

constructor

• new MetricsReporter(messaging: SharedMessaging): MetricsReporter

  Creates a new MetricsReporter instance.

  Parameters

  • messaging: SharedMessaging

    The messaging instance used to communicate with the native layer

  Returns MetricsReporter

  Throws

  When messaging is not provided or messaging.notify is not defined

messaging

StaticDEFAULT_EXCEPTION_MESSAGE

StaticMESSAGE_ID

StaticMETRIC_NAME_EXCEPTION

reportException

• reportException(params?: ExceptionMetricParams): void

  Sends a reportMetric event with metric name exception, getting message and kind from the params object. If no params object is passed, defaults are used.

  Parameters

  • Optionalparams: ExceptionMetricParams

    The exception parameters containing message and kind (both optional)

  Returns void

  Example

  // Report an exception with custom message and kind
  metrics.reportException({
      message: 'Failed to fetch user data from API',
      kind: 'NetworkError'
  });
  
  // Report an exception with default values (message: 'Unknown error', kind: 'Error')
  metrics.reportException();
  Copy

reportExceptionWithError

• reportExceptionWithError(error?: Error): void

  Sends a reportMetric event with metric name exception, getting message and kind from the error object. The kind property is inferred from error.name.

  If no error object is passed, a default error is reported.

  If an invalid error object is passed, nothing is reported.

  Parameters

  • Optionalerror: Error

    The error to report

  Returns void

  Example

  const error = new Error('Failed to fetch user data from API');
  error.name = 'NetworkError';
  metrics.reportExceptionWithError(error);
  Copy

reportMetric

• reportMetric(metricEvent: ExceptionMetric): void

  Sends a standard reportMetric event to the native layer.

  Parameters

  • metricEvent: ExceptionMetric

    The metric event to report, must contain a metricName

  Returns void

  Throws

  When metricEvent.metricName is missing

  Example

  metrics.reportMetric({
      metricName: 'pageLoad',
      params: { duration: 1500, page: 'home' }
  });
  Copy