{"id":17679932,"url":"https://github.com/signalfx/splunk-otel-js-web","last_synced_at":"2026-01-19T16:00:42.136Z","repository":{"id":37158274,"uuid":"269155914","full_name":"signalfx/splunk-otel-js-web","owner":"signalfx","description":"Splunk distribution of Open Telemetry for browser environment.","archived":false,"fork":false,"pushed_at":"2026-01-12T14:22:58.000Z","size":15599,"stargazers_count":63,"open_issues_count":5,"forks_count":37,"subscribers_count":51,"default_branch":"main","last_synced_at":"2026-01-12T14:57:25.212Z","etag":null,"topics":["javascript","opentelemetry","splunk"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/signalfx.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-06-03T17:47:33.000Z","updated_at":"2026-01-09T09:55:08.000Z","dependencies_parsed_at":"2023-12-11T11:44:59.848Z","dependency_job_id":"34e774da-d3a1-43fe-82bc-82ef2018e5ed","html_url":"https://github.com/signalfx/splunk-otel-js-web","commit_stats":{"total_commits":521,"total_committers":17,"mean_commits":"30.647058823529413","dds":0.6007677543186181,"last_synced_commit":"a53f8373a83c603f148e6f27d61b24959fb9c7a2"},"previous_names":["signalfx/splunk-otel-js-browser"],"tags_count":152,"template":false,"template_full_name":null,"purl":"pkg:github/signalfx/splunk-otel-js-web","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signalfx%2Fsplunk-otel-js-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signalfx%2Fsplunk-otel-js-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signalfx%2Fsplunk-otel-js-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signalfx%2Fsplunk-otel-js-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/signalfx","download_url":"https://codeload.github.com/signalfx/splunk-otel-js-web/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signalfx%2Fsplunk-otel-js-web/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28573281,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-19T15:45:05.669Z","status":"ssl_error","status_checked_at":"2026-01-19T15:44:23.317Z","response_time":67,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","opentelemetry","splunk"],"created_at":"2024-10-24T09:04:47.872Z","updated_at":"2026-01-19T16:00:42.131Z","avatar_url":"https://github.com/signalfx.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Splunk OpenTelemetry JavaScript for Web\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003e\n    \u003ca href=\"https://quickdraw.splunk.com/redirect/?product=Observability\u0026location=github.rum.get.started\u0026version=current\"\u003e🚀 Get Started\u003c/a\u003e\n\t\u0026bull;\n\t\u003ca href=\"https://quickdraw.splunk.com/redirect/?product=Observability\u0026location=github.browser.rum\u0026version=current\"\u003e📖 Documentation\u003c/a\u003e\n    \u0026bull;\n    \u003ca href=\"./CONTRIBUTING.md\"\u003e🤝 Contributing\u003c/a\u003e\n    \u0026bull;\n    \u003ca href=\"#-troubleshooting\"\u003e🛠️ Troubleshooting\u003c/a\u003e\n    \u0026bull;\n    \u003ca href=\"./LICENSE\"\u003e📜 License\u003c/a\u003e\n  \u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/signalfx/splunk-otel-js-web/releases\"\u003e\n    \u003cimg alt=\"Latest GitHub release version\" src=\"https://img.shields.io/github/v/release/signalfx/splunk-otel-js-web?include_prereleases\u0026style=for-the-badge\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@splunk/otel-web\"\u003e\n    \u003cimg alt=\"npm package version\" src=\"https://img.shields.io/npm/v/@splunk/otel-web?style=for-the-badge\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"./LICENSE\"\u003e\n    \u003cimg alt=\"Apache 2.0 License\" src=\"https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=for-the-badge\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n\u003e [!IMPORTANT]\n\u003e For complete instructions for how to get started with the Splunk distribution of OpenTelemetry JavaScript for Web, see [Install the Browser RUM agent for Splunk RUM](https://quickdraw.splunk.com/redirect/?product=Observability\u0026location=github.rum.get.started\u0026version=current)\n\u003e\n\u003e The official Splunk documentation for this repository is [Instrument browser-based web applications for Splunk RUM](https://quickdraw.splunk.com/redirect/?product=Observability\u0026location=github.browser.rum\u0026version=current).\n\nGain insights into the issues affecting real users of your front-end browser and mobile applications with Splunk Real User Monitoring (RUM). This repository contains several packages that provide core instrumentation, session recording, and build tooling to accelerate RUM adoption.\n\n## 📦 Packages\n\n| Package                                                             | Description                                                                                                              | Version                                                                                                                                   | Documentation                                      |\n| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |\n| [`@splunk/otel-web`](./packages/web/)                               | **Core RUM Library** - Automated instrumentation for page loads, network requests, errors, Web Vitals, user interactions | [![npm](https://img.shields.io/npm/v/@splunk/otel-web)](https://www.npmjs.com/package/@splunk/otel-web)                                   | [📖 README](./packages/web/README.md)              |\n| [`@splunk/otel-web-session-recorder`](./packages/session-recorder/) | **Session Replay** - Privacy-aware visual session recording with timeline correlation for synchronized debugging         | [![npm](https://img.shields.io/npm/v/@splunk/otel-web-session-recorder)](https://www.npmjs.com/package/@splunk/otel-web-session-recorder) | [📖 README](./packages/session-recorder/README.md) |\n| [`@splunk/rum-build-plugins`](./packages/build-plugins/)            | **Build Integration** - Webpack plugins for automated source map uploads and enhanced debugging                          | [![npm](https://img.shields.io/npm/v/@splunk/rum-build-plugins)](https://www.npmjs.com/package/@splunk/rum-build-plugins)                 | [📖 README](./packages/build-plugins/README.md)    |\n\n## 🚀 Quick Start\n\n### 1. Install RUM Packages\n\n```bash\n# Using npm\nnpm install @splunk/otel-web @splunk/otel-web-session-recorder\n\n# Using pnpm\npnpm add @splunk/otel-web @splunk/otel-web-session-recorder\n\n# Using yarn\nyarn add @splunk/otel-web @splunk/otel-web-session-recorder\n```\n\n### 2. Initialize RUM packages\n\n```typescript\nimport { SplunkRum } from '@splunk/otel-web'\n\nSplunkRum.init({\n\trealm: 'us1', // Your Splunk realm (us0, us1, eu0, etc.)\n\trumAccessToken: 'YOUR_RUM_ACCESS_TOKEN',\n\tapplicationName: 'my-app',\n\tdeploymentEnvironment: 'production',\n})\n\nSplunkSessionRecorder.init({\n\trealm: 'us1',\n\trumAccessToken: 'YOUR_RUM_ACCESS_TOKEN',\n})\n```\n\n### 3. Configure source map upload (optional)\n\n```bash\nnpm install --save-dev @splunk/rum-build-plugins\n```\n\n```javascript\n// webpack.config.js\nconst { SplunkRumWebpackPlugin } = require('@splunk/rum-build-plugins')\n\nmodule.exports = {\n\tdevtool: 'source-map', // Required for source map upload\n\tplugins: [\n\t\tnew SplunkRumWebpackPlugin({\n\t\t\tsourceMaps: {\n\t\t\t\trealm: 'us1',\n\t\t\t\ttoken: process.env.SPLUNK_ORG_ACCESS_TOKEN,\n\t\t\t\tdisableUpload: process.env.NODE_ENV !== 'production',\n\t\t\t},\n\t\t}),\n\t],\n}\n```\n\n## 📚 Documentation\n\n- **[Getting Started Guide](https://quickdraw.splunk.com/redirect/?product=Observability\u0026location=github.rum.get.started\u0026version=current)** - Complete setup instructions\n- **[Browser RUM Documentation](https://quickdraw.splunk.com/redirect/?product=Observability\u0026location=github.browser.rum\u0026version=current)** - Advanced configuration and features\n- **[API Reference](./packages/web/README.md#api-reference)** - Detailed API documentation\n- **[Examples](./examples/)** - Integration examples for popular frameworks\n\n## 🔧 Development\n\n### Prerequisites\n\n- **[Node.js](https://nodejs.org/)**: \u003e=22\n- **[pnpm](https://pnpm.io/)**: \u003e=10\n\n### Setup\n\n```bash\n# Clone the repository\ngit clone https://github.com/signalfx/splunk-otel-js-web.git\ncd splunk-otel-js-web\n\n# Install dependencies\npnpm install\n\n# Build all packages\npnpm build\n\n# Run tests\npnpm test\n\n# Start development mode\npnpm dev\n```\n\n### Commands\n\n| Command          | Description                    |\n| ---------------- | ------------------------------ |\n| `pnpm build`     | Build all packages             |\n| `pnpm test`      | Run unit and integration tests |\n| `pnpm test:unit` | Run unit tests only            |\n| `pnpm test:e2e`  | Run end-to-end tests           |\n| `pnpm lint`      | Run linting checks             |\n| `pnpm lint:fix`  | Fix linting issues             |\n| `pnpm dev`       | Start development watch mode   |\n\n## 🤝 Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details on:\n\n- Setting up the development environment\n- Code style and testing requirements\n- Pull request process\n- Issue reporting guidelines\n\n## 🛠️ Troubleshooting\n\nFor troubleshooting issues with the Splunk Distribution of OpenTelemetry JS for Web, see [Troubleshoot browser instrumentation for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability\u0026version=current\u0026location=web.rum.troubleshooting) in the official documentation.\n\n## 📜 License\n\nLicensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.\n\n---\n\n\u003e ℹ️\u0026nbsp;\u0026nbsp;SignalFx was acquired by Splunk in October 2019. See [Splunk SignalFx](https://www.splunk.com/en_us/investor-relations/acquisitions/signalfx.html) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsignalfx%2Fsplunk-otel-js-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsignalfx%2Fsplunk-otel-js-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsignalfx%2Fsplunk-otel-js-web/lists"}