docs(react): Add withProfiler docs

Author: AbhiPrasad

packages/react/package.json

@@ -18,6 +18,7 @@
   "dependencies": {
     "@sentry/browser": "5.16.0-beta.5",
     "@sentry/types": "5.16.0-beta.5",
+    "@sentry/utils": "^5.15.5",
     "tslib": "^1.9.3"
   },
   "peerDependencies": {

packages/react/src/profiler.tsx

@@ -1,5 +1,6 @@
 import { getCurrentHub } from '@sentry/browser';
 import { Integration, IntegrationClass } from '@sentry/types';
+import { logger } from '@sentry/utils';
 import * as React from 'react';
 
 /** The Props Injected by the HOC */
@@ -32,10 +33,16 @@ const getInitActivity = (componentDisplayName: string, timeout = DEFAULT_DURATIO
     );
   }
 
+  logger.warn(`Unable to profile component ${componentDisplayName} due to invalid Tracing Integration`);
   return null;
 };
 
-// tslint:disable-next-line: variable-name
+/**
+ * withProfiler() is a HOC that leverages the Sentry AM tracing integration to
+ * send transactions about a React component.
+ * @param WrappedComponent The component profiled
+ * @param timeout A maximum timeout for the component render
+ */
 export const withProfiler = <P extends object>(WrappedComponent: React.ComponentType<P>, timeout?: number) => {
   const componentDisplayName = WrappedComponent.displayName || WrappedComponent.name || 'Component';
 

yarn.lock

@@ -1117,6 +1117,19 @@
     universal-user-agent "^2.0.0"
     url-template "^2.0.8"
 
+"@sentry/[email protected]":
+  version "5.15.5"
+  resolved "https://registry.yarnpkg.com/@sentry/types/-/types-5.15.5.tgz#16c97e464cf09bbd1d2e8ce90d130e781709076e"
+  integrity sha512-F9A5W7ucgQLJUG4LXw1ZIy4iLevrYZzbeZ7GJ09aMlmXH9PqGThm1t5LSZlVpZvUfQ2rYA8NU6BdKJSt7B5LPw==
+
+"@sentry/utils@^5.15.5":
+  version "5.15.5"
+  resolved "https://registry.yarnpkg.com/@sentry/utils/-/utils-5.15.5.tgz#dec1d4c79037c4da08b386f5d34409234dcbfb15"
+  integrity sha512-Nl9gl/MGnzSkuKeo3QaefoD/OJrFLB8HmwQ7HUbTXb6E7yyEzNKAQMHXGkwNAjbdYyYbd42iABP6Y5F/h39NtA==
+  dependencies:
+    "@sentry/types" "5.15.5"
+    tslib "^1.9.3"
+
 "@sinonjs/commons@^1", "@sinonjs/commons@^1.4.0":
   version "1.4.0"
   resolved "https://registry.yarnpkg.com/@sinonjs/commons/-/commons-1.4.0.tgz#7b3ec2d96af481d7a0321252e7b1c94724ec5a78"