@splunk/otel-web

Getting Started   •   Getting Involved

Splunk distribution of OpenTelemetry JavaScript for Web

The Splunk distribution of OpenTelemetry JavaScript for Web

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

Getting Started

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

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

The Splunk distribution of OpenTelemetry JavaScript Browser is a distribution of OpenTelemetry JavaScript Browser. It is licensed 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.

Changelog

0.24.0

• @splunk/otel-web
  • Deprecation Warnings: Added console warning messages for better visibility of previously deprecated APIs and configuration options. #1345
  • These items were deprecated in earlier versions but now show explicit deprecation warnings to help users migrate before they are removed in a future major version:
    • Configuration Options: The following configuration options have been renamed and the old names will show deprecation warnings:
      • app → Use applicationName instead
      • beaconUrl → Use beaconEndpoint instead
      • environment → Use deploymentEnvironment instead
      • rumAuth → Use rumAccessToken instead
    • API Methods: The following methods are deprecated:
      • SplunkRum._experimental_getGlobalAttributes() → Use SplunkRum.getGlobalAttributes() instead
      • SplunkRum.error(...args) → Use SplunkRum.reportError(error, context) instead
      • SplunkRum._experimental_addEventListener(name, callback) → Use SplunkRum.addEventListener(name, callback) instead
      • SplunkRum._experimental_removeEventListener(name, callback) → Use SplunkRum.removeEventListener(name, callback) instead
      • SplunkRum._experimental_getSessionId() → Use SplunkRum.getSessionId() instead