85 lines
3 KiB
JavaScript
85 lines
3 KiB
JavaScript
import React from 'react';
|
|
import Highlight from 'react-highlight';
|
|
import ToggleContent from 'Shared/ToggleContent';
|
|
import DocLink from 'Shared/DocLink/DocLink';
|
|
import { connect } from 'react-redux';
|
|
|
|
const ProfilerDoc = (props) => {
|
|
const { projectKey } = props;
|
|
return (
|
|
<div className="bg-white h-screen overflow-y-auto" style={{ width: '500px' }}>
|
|
<h3 className="p-5 text-2xl">Profiler</h3>
|
|
<div className="p-5">
|
|
<div>
|
|
The profiler plugin allows you to measure your JS functions' performance and capture both arguments and result for each function
|
|
call.
|
|
</div>
|
|
|
|
<div className="font-bold my-2">Installation</div>
|
|
<Highlight className="js">{`npm i @openreplay/tracker-profiler --save`}</Highlight>
|
|
|
|
<div className="font-bold my-2">Usage</div>
|
|
<p>Initialize the tracker and load the plugin into it. Then decorate any function inside your code with the generated function.</p>
|
|
<div className="py-3" />
|
|
|
|
<div className="font-bold my-2">Usage</div>
|
|
<ToggleContent
|
|
label="Server-Side-Rendered (SSR)?"
|
|
first={
|
|
<Highlight className="js">
|
|
{`import OpenReplay from '@openreplay/tracker';
|
|
import trackerProfiler from '@openreplay/tracker-profiler';
|
|
//...
|
|
const tracker = new OpenReplay({
|
|
projectKey: '${projectKey}'
|
|
});
|
|
// .start() returns a promise
|
|
tracker.start().then(sessionData => ... ).catch(e => ... )
|
|
//...
|
|
export const profiler = tracker.use(trackerProfiler());
|
|
//...
|
|
const fn = profiler('call_name')(() => {
|
|
//...
|
|
}, thisArg); // thisArg is optional`}
|
|
</Highlight>
|
|
}
|
|
second={
|
|
<Highlight className="js">
|
|
{`import OpenReplay from '@openreplay/tracker/cjs';
|
|
import trackerProfiler from '@openreplay/tracker-profiler/cjs';
|
|
//...
|
|
const tracker = new OpenReplay({
|
|
projectKey: '${projectKey}'
|
|
});
|
|
//...
|
|
function SomeFunctionalComponent() {
|
|
useEffect(() => { // or componentDidMount in case of Class approach
|
|
// .start() returns a promise
|
|
tracker.start().then(sessionData => ... ).catch(e => ... )
|
|
}, [])
|
|
//...
|
|
export const profiler = tracker.use(trackerProfiler());
|
|
//...
|
|
const fn = profiler('call_name')(() => {
|
|
//...
|
|
}, thisArg); // thisArg is optional
|
|
}`}
|
|
</Highlight>
|
|
}
|
|
/>
|
|
|
|
<DocLink className="mt-4" label="Integrate Profiler" url="https://docs.openreplay.com/plugins/profiler" />
|
|
</div>
|
|
</div>
|
|
);
|
|
};
|
|
|
|
ProfilerDoc.displayName = 'ProfilerDoc';
|
|
|
|
export default connect((state) => {
|
|
const siteId = state.getIn(['integrations', 'siteId']);
|
|
const sites = state.getIn(['site', 'list']);
|
|
return {
|
|
projectKey: sites.find((site) => site.get('id') === siteId).get('projectKey'),
|
|
};
|
|
})(ProfilerDoc);
|