openreplay/frontend/app/components/Client/Integrations/Tracker/GraphQLDoc/GraphQLDoc.js
Delirium c144add4bd
Backend logs UI (#2635)
* backend integrations ui start

* some more ui things

* moving around some integration code

* add dynatrace

* add datadog, useform hook and other things to update backend logging integration forms

* change api queries

* backend logging modals

* tracker: fix some types

* remove deprecated integrations, update types

* some ui fixes and improvements

* update notifications on success/error

* ui: debugging log output, autoclose fix

* ui: some stuff for logs base64str

* ui: improve log formatting,  change datadog data format

* some improvs for logging irm

* ui: fixup for sentry
2024-10-29 15:15:28 +01:00

77 lines
2.9 KiB
JavaScript

import { useStore } from "App/mstore";
import React from 'react';
import { CodeBlock } from "UI";
import DocLink from 'Shared/DocLink/DocLink';
import ToggleContent from 'Shared/ToggleContent';
import { observer } from 'mobx-react-lite'
const GraphQLDoc = () => {
const { integrationsStore, projectsStore } = useStore();
const sites = projectsStore.list;
const siteId = integrationsStore.integrations.siteId
const projectKey = siteId ? sites.find((site) => site.id === siteId)?.projectKey : sites[0]?.projectKey
const usage = `import OpenReplay from '@openreplay/tracker';
import trackerGraphQL from '@openreplay/tracker-graphql';
//...
const tracker = new OpenReplay({
projectKey: '${projectKey}'
});
// .start() returns a promise
tracker.start().then(sessionData => ... ).catch(e => ... )
//...
export const recordGraphQL = tracker.use(trackerGraphQL());`
const usageCjs = `import OpenReplay from '@openreplay/tracker/cjs';
import trackerGraphQL from '@openreplay/tracker-graphql/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 recordGraphQL = tracker.use(trackerGraphQL());`
return (
<div className="bg-white h-screen overflow-y-auto" style={{ width: '500px' }}>
<h3 className="p-5 text-2xl">GraphQL</h3>
<div className="p-5">
<p>
This plugin allows you to capture GraphQL requests and inspect them later on while replaying session recordings. This is very
useful for understanding and fixing issues.
</p>
<p>GraphQL plugin is compatible with Apollo and Relay implementations.</p>
<div className="font-bold my-2">Installation</div>
<CodeBlock code={'npm i @openreplay/tracker-graphql --save'} language={'bash'} />
<div className="font-bold my-2">Usage</div>
<p>
The plugin call will return the function, which receives four variables operationKind, operationName, variables and result. It
returns result without changes.
</p>
<div className="py-3" />
<ToggleContent
label="Server-Side-Rendered (SSR)?"
first={
<CodeBlock language={'js'} code={usage} />
}
second={
<CodeBlock language={'jsx'} code={usageCjs} />
}
/>
<DocLink className="mt-4" label="Integrate GraphQL" url="https://docs.openreplay.com/plugins/graphql" />
</div>
</div>
);
};
GraphQLDoc.displayName = 'GraphQLDoc';
export default observer(GraphQLDoc);