From 72f8e05b2542b6a583c2c258e425a540a3f94249 Mon Sep 17 00:00:00 2001 From: Daniel Griesser Date: Tue, 13 Mar 2018 21:17:51 +0100 Subject: [PATCH] feat: Update electron docs (#1241) * feat: Update electron docs * fix: typos * meta: Update code example * docs(electron): Remove Electron docs --- docs/integrations/electron.rst | 73 ---------------------------------- docs/integrations/index.rst | 1 - docs/sentry-doc-config.json | 9 ----- 3 files changed, 83 deletions(-) delete mode 100644 docs/integrations/electron.rst diff --git a/docs/integrations/electron.rst b/docs/integrations/electron.rst deleted file mode 100644 index ead6b697d8b6..000000000000 --- a/docs/integrations/electron.rst +++ /dev/null @@ -1,73 +0,0 @@ -Electron -======== - -To use Sentry with your Electron application, you will need to use both Raven.js SDKs, one for Browser and one for Node.js. -Browser SDK is used to report all errors from Electron's ``renderer process``, while Node.js is used to report ``main process`` errors. - -On its own, Raven.js will report any uncaught exceptions triggered from your application. For advanced usage examples of Raven.js, please read :doc:`Raven.js usage <../usage>`. - -Installation ------------- - -Both packages are available via npm. - -.. code-block:: sh - - $ npm install raven raven-js --save - -Configuring the Client ----------------------- - -First, let's configure ``main process``, which uses the Node.js SDK: - -.. code-block:: javascript - - var Raven = require('raven'); - - Raven.config('___PUBLIC_DSN___', { - captureUnhandledRejections: true - }).install(); - -And now ``renderer process``, which uses the Browser SDK: - -.. code-block:: javascript - - var Raven = require('raven-js'); - Raven.config('___PUBLIC_DSN___').install(); - - window.addEventListener('unhandledrejection', function (event) { - Raven.captureException(event.reason); - }); - -This configuration will also take care of unhandled Promise rejections, which can be handled in various ways. By default, Electron uses standard JS API. -To learn more about handling promises, refer to :ref:`raven-js-promises` documentation. - -Sending environment information -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -It's often a good idea to send platform information along with a caught error. -Some things that we can easily add, but are not limited to, are: - -- Environment type (browser/renderer) -- Electron version -- Chrome version -- Operation System type -- Operation System release - -You can configure both processes in the same way. To do this, require the standard Node.js module `os` and add a `tags` attribute to your `config` call: - -.. code-block:: javascript - - var os = require('os'); - var Raven = require('raven'); - - Raven.config('___PUBLIC_DSN___', { - captureUnhandledRejections: true, - tags: { - process: process.type, - electron: process.versions.electron, - chrome: process.versions.chrome, - platform: os.platform(), - platform_release: os.release() - } - }).install(); diff --git a/docs/integrations/index.rst b/docs/integrations/index.rst index 8763f24cbd59..74c507d09f56 100644 --- a/docs/integrations/index.rst +++ b/docs/integrations/index.rst @@ -36,7 +36,6 @@ To install a plugin just include the plugin **after** Raven has been loaded and angularjs angular backbone - electron ember react vue diff --git a/docs/sentry-doc-config.json b/docs/sentry-doc-config.json index ae305ebc53aa..2799eb0efbd4 100644 --- a/docs/sentry-doc-config.json +++ b/docs/sentry-doc-config.json @@ -38,15 +38,6 @@ "integrations/backbone#configuring-the-client" ] }, - "javascript.electron": { - "name": "Electron", - "type": "framework", - "doc_link": "integrations/electron/", - "wizard": [ - "integrations/electron#installation", - "integrations/electron#configuring-the-client" - ] - }, "javascript.ember": { "name": "Ember", "type": "framework",