You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage.rst
+5-4
Original file line number
Diff line number
Diff line change
@@ -136,10 +136,11 @@ All optional attributes are passed as part of the options to ``captureException`
136
136
137
137
If you're inside a context and your context data includes a ``user`` key, that data will be merged into this.
138
138
139
-
.. describe:: req
139
+
.. describe:: request
140
140
141
-
The ``req`` object associated with this event, from a Node http server, Express, Koa, or similar.
142
-
Will be parsed for request details and user context from ``req.user`` if present.
141
+
Alias: ``req``. The ``request`` object associated with this event, from a Node http server, Express, Koa, or similar.
142
+
Will be parsed for request details and user context from ``request.user`` if present. It will only pull out the data
143
+
that's handled by the server: ``headers``, ``method``, ``host``, ``protocol``, ``url``, ``query``, ``cookies``, ``body``, ``ip`` and ``user``.
143
144
144
145
.. code-block:: javascript
145
146
@@ -299,7 +300,7 @@ It can do anything necessary, including asynchronous operations, to make a best
299
300
not throw, and it absolutely must not allow the process to keep running indefinitely. This means it should probably make an explicit ``process.exit()`` call.
300
301
301
302
After catching a fatal exception, Raven will make a best-effort attempt to send it to Sentry before it calls the fatal exception handler.
302
-
If sending fails, a ``sendErr`` error object will be passed, and otherwise the ``eventId`` will be provided. In either case, the error object
303
+
If sending fails, a ``sendErr`` error object will be passed, and otherwise the ``eventId`` will be provided. In either case, the error object
303
304
resulting in the shutdown is passed as the first parameter.
0 commit comments