Skip to content

openobserve/browser-sdk

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenObserve Browser SDK

Collect and send browser data to OpenObserve for logs and Real User Monitoring (RUM).

Overview

The OpenObserve Browser SDK provides a comprehensive solution for monitoring your web applications. It includes packages for log collection, real user monitoring, and performance tracking directly from the browser.

Installation

Using npm

# For logs collection
npm install @openobserve/browser-logs

# For RUM (Real User Monitoring)
npm install @openobserve/browser-rum

# For RUM Slim (lighter version without session replay)
npm install @openobserve/browser-rum-slim

For detailed setup instructions and configuration options, see the OpenObserve RUM Setup Guide.

Using CDN

You can include the SDK directly in your HTML using our CDN:

<!-- For logs collection -->
<script src="https://browsersdk.openobserve.ai/0.3.1/openobserve-logs.js"></script>

<!-- For RUM -->
<script src="https://browsersdk.openobserve.ai/0.3.1/openobserve-rum.js"></script>

<!-- For RUM Slim -->
<script src="https://browsersdk.openobserve.ai/0.3.1/openobserve-rum-slim.js"></script>

CDN Bundles

OpenObserve provides CDN bundles based on version:

Version Logs RUM RUM Slim
0.3.1 openobserve-logs.js openobserve-rum.js openobserve-rum-slim.js

Getting Started

Log Collection

The OpenObserve Browser Logs package allows you to collect and forward logs from your browser application to OpenObserve. It supports multiple log levels, custom context, and automatic error tracking.

See the dedicated OpenObserve Browser Log Collection documentation to learn how to configure and use log collection.

Real User Monitoring

The OpenObserve Browser RUM packages enable you to collect real user monitoring data including page views, user interactions, errors, and performance metrics from your browser application.

Choose the right package:

  • @openobserve/browser-rum: Full RUM package with session replay capabilities
  • @openobserve/browser-rum-slim: Lighter version without session replay (recommended for smaller bundle sizes)

See the dedicated OpenObserve Browser RUM Collection documentation to learn how to configure and use RUM.

Packages

This repository contains several packages available on npm:

Package Version Description npm Link
@openobserve/browser-logs 0.3.1 Browser log collection npm
@openobserve/browser-rum 0.3.1 Real User Monitoring with session replay npm
@openobserve/browser-rum-slim 0.3.1 Real User Monitoring (lightweight, no session replay) npm
@openobserve/browser-rum-core 0.3.1 Core RUM functionality (internal package) npm
@openobserve/browser-core 0.3.1 Core utilities (internal package) npm

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Attribution

This project is based on the Datadog Browser SDK and includes modifications by Zinc Labs Inc. (OpenObserve). We are grateful to Datadog for their original work and open-source contribution.

About

Browser SDK

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 92.1%
  • JavaScript 4.9%
  • CSS 2.8%
  • Other 0.2%