Browser logger

@squasher-ai/browser-logger sends each console.error call in the browser to Squasher. It does nothing else: it does not capture uncaught errors, Web Vitals, or session replays. For those, use the Browser SDK. This page is tested with version 0.4.0.

Install the logger

npm
Script tag

npm install @squasher-ai/browser-logger

Copy the browser build from the package into the public folder of your site:

npm install @squasher-ai/browser-logger
mkdir -p public/vendor
cp node_modules/@squasher-ai/browser-logger/dist/browser-logger.umd.js public/vendor/

The file defines window.SquasherBrowserLogger.

To get your ingest key and project ID, see Create an ingest key. The key is visible to anyone who opens your site. An ingest key can send events to your project, but it cannot read data.

Start the logger

Start the logger once, when the page loads.

npm
Script tag

src/main.ts

import { init } from "@squasher-ai/browser-logger";

init({
  apiKey: import.meta.env.VITE_SQUASHER_API_KEY,
  projectId: import.meta.env.VITE_SQUASHER_PROJECT_ID,
});

index.html

<script src="/vendor/browser-logger.umd.js"></script>
<script>
  window.SquasherBrowserLogger.init({
    apiKey: "sq_pk_...",
    projectId: "...",
  });
</script>

From now on, each console.error call still writes to the console, and it also goes to Squasher.

What each event contains

console.error("Checkout failed", new Error("Card declined"), { cartId: "cart_123" });

For this call, the event gets:

The message Checkout failed Card declined {"cartId":"cart_123"}: all arguments, joined with spaces.
The error type and the stack trace of the first Error argument.
The page URL and the browser user agent.
All arguments, as JSON, in the console_arguments extra field.

The logger sends every argument of every console.error call, and the full page URL. Do not log tokens, card data, or personal data, and do not put them in URLs on pages that load the logger.

Send a test error

Run this in the browser console of your running site, or from a button handler:

console.error(new Error("Squasher test error"));

The logger sends events in batches, every 5 seconds or when 10 events are queued. When the page is hidden or closed, it sends the rest. Then select Issues in the sidebar of your project. If the error does not appear, see Troubleshooting.

Options

Option	Default	Description
`apiKey`	Required	Your ingest key.
`projectId`	Required	Your project ID.
`captureConsoleErrors`	`true`	Send `console.error` calls. With `false`, the logger sends nothing.
`endpoint`	`https://ingest.squasher.ai`	The ingest URL.

init returns the logger. flush() sends the queued events now, and close() sends them and restores the original console.error.

Limits

The logger has no environment or release option, so its events have no environment. Automatic AI triage runs only on production issues. To triage one of these issues, select Run triage in the Squasher triage card on the issue page.
init throws when apiKey or projectId is empty, and when you call it a second time.
When a send fails, the logger keeps the events and tries again at the next send.
Stack traces from a minified bundle point at the minified files. Upload source maps for the release so the issue page shows the original files.

Get started

Guides

Install the logger

Start the logger

What each event contains

Send a test error

Options

Limits

Next steps

Browser SDK

Troubleshooting

​Install the logger

​Start the logger

​What each event contains

​Send a test error

​Options

​Limits

​Next steps

Browser SDK

Troubleshooting

Install the logger

Start the logger

What each event contains

Send a test error

Options

Limits

Next steps