Error Reporting Client for Client-side JavaScript

JavaScript client for Google Cloud Error Reporting.

It can be used in web browsers.

Inspired by stackdriver-errors-js, added the ability to insert the source location to the request body automatically, and changed the behavior if the source maps are available.

Prerequisites

See the Prerequisites in the stackdriver-errors-js package.

Installation

1npm i error-reporting-client
2# if you use pnpm
3pnpm i error-reporting-client

Usage

1import ErrorReporting from "error-reporting-client";
2
3// Initialize the error reporting client with your API key and project ID
4const reportClient = new ErrorReporting({
5    apiKey: "YOUR_API_KEY",
6    projectId: "YOUR_PROJECT_ID",
7    // below are optional
8    // 
9    // service: "my-service",
10    // version: "1.0.0",
11    // reportUncaughtExceptions: true,
12    // reportUnhandledPromiseRejections: true,
13    // sourceReferences: [
14    //     {
15    //         repository: "",
16    //         revisionId: "",
17    //     },
18    // ],
19});
20
21// Register the global error and unhandled promise rejection handlers
22reportClient.registerHandler();
23
24// Set the user identifier
25reportClient.setUser("john-smith");
26
27// Send an error report manually
28try {
29    // code that might throw an error
30} catch(e) {
31    reportClient.sendError(e);
32}
33
34// You can also provide a source location
35reportClient.sendError(new Error("An error occurred"), {
36    filePath: "src/App.tsx",
37    lineNumber: 53,
38    functionName: "App",
39});

as a utility

1// errorHandler.ts
2import ErrorReporting from "error-reporting-client";
3
4let errorHandler: ErrorReporting | undefined
5if (typeof window !== "undefined" && typeof errorHandler === "undefined") {
6    errorHandler = new ErrorReporting({
7        apiKey: "YOUR_API_KEY",
8        projectId: "YOUR_PROJECT_ID",
9    })
10    errorHandler.registerHandler()
11}
12export default errorHandler

1import errorHandler from "./errorHandler"
2
3errorHandler?.sendError(err);

API

ErrorReporting

constructor(options: { projectId: string; apiKey: string; service?: string; version?: string; reportUncaughtExceptions?: boolean; reportUnhandledPromiseRejections?: boolean; sourceReferences?: SourceReference[]; })

Creates a new instance of the ErrorReporting client.

• projectId: Your Google Cloud project ID.
• apiKey: Your Google Cloud API key.
• service: (Optional) The service name. Defaults to "web".
• version: (Optional) The version of the service.
• reportUncaughtExceptions: (Optional) Whether to report uncaught exceptions. Defaults to true.
• reportUnhandledPromiseRejections: (Optional) Whether to report unhandled promise rejections. Defaults to true.
• sourceReferences: (Optional) A list of source references.

setUser(user: string | undefined): void

Sets the user identifier for error reports.

• user: The user identifier.

disable(): void

Disables error reporting.

enable(): void

Enables error reporting.

registerHandler(): void

Registers global error and unhandled promise rejection handlers.

sendError(err: Error | string, reportLocation?: SourceLocation): Promise<void>

Sends an error report.

• err: The error to report.
• reportLocation: (Optional) The location in the source code where the error was reported. If not provided, the location is determined automatically.

SourceLocation

Indicates a location in the source code of the service for which errors are reported.

• filePath: The source code filename, which can include a truncated relative path, or a full path from a production machine.
• lineNumber: (Optional) 1-based. 0 indicates that the line number is unknown.
• functionName: Human-readable name of a function or method. The value can include optional context like the class or package name.

SourceReference

A reference to a particular snapshot of the source tree used to build and deploy an application.

• repository: (Optional) A URI string identifying the repository.
• revisionId: The canonical and persistent identifier of the deployed revision.