Getting Started   •   Getting Involved

Splunk distribution of OpenTelemetry JavaScript for Web

The Splunk distribution of OpenTelemetry JavaScript for Web

🚧 This project is currently in BETA. It is officially supported by Splunk. However, breaking changes MAY be introduced.

Getting Started

The easiest way to get started is to use Splunk RUM distributed via CDN

1. Include & initialize the Splunk RUM by copying the following to HEAD section for all the HTML files or templates in your application

   <script src="https://cdn.signalfx.com/o11y-gdi-rum/latest/splunk-otel-web.js" crossorigin="anonymous"></script>
   <script>
     SplunkRum.init({
         beaconUrl: 'https://rum-ingest.<REALM>.signalfx.com/v1/rum',
         rumAuth: 'RUM access token',
         app: 'enter-your-application-name'
       });
   </script>

2. Modify the initialization parameters to specify:

   • beaconUrl - the destination URL to which captured telemetry is sent to be ingested. Replace the <REALM> with the actual realm you are using (i.e. us0, us1).
   • rumAuth - token authorizing the Agent to send the telemetry to the backend. You can find (or generate) the token here. Notice that RUM and APM auth tokens are different.
   • app - naming the application that will be monitored so it can be distinguished from other applications.

3. Deploy the changes to your application and make sure that the application is being used.

The method above is the recommendation to get started with Splunk RUM. This approach picks up the latest stable version of the Browser Agent distributed via CDN and loads the agent synchronously.

If you don't yet have a backend where to send data to you can set debug: true and see the created spans in browser console. Please read Installation.md for more info on different installation options.

Documentation

The official Splunk documentation for this page is Instrument browser-based web applications for Splunk RUM.

Open Telemetry version

Compatibility between the versions of this project and Open Telemetry is specified in CHANGELOG.md.

Building and contributing

Please read CONTRIBUTING.md for instructions on building, running tests, and so forth.

License and versioning

The Splunk distribution of OpenTelemetry JavaScript Browser is a distribution of the OpenTelemetry JavaScript Browser project. It is released under the terms of the Apache Software License version 2.0. See the license file for more details.

ℹ️  SignalFx was acquired by Splunk in October 2019. See Splunk SignalFx for more information.