@mozilla/glean

Glean.js

Glean.js is a modern approach for a Telemetry library aimed at JavaScript environments. It is part of the Glean project.

Documentation

All documentation is available online:

The Glean Book

If you are using Glean.js in your project, this is the place to go. It contains user guides on getting started and other topics, as well as reference to Glean APIs.

Glean.js developer documentation

If you want to contribute to the Glean.js code base this is the place to go.

Glean.js internal reference

If you are looking for detailed documentation on the Glean APIs (internal or external) this is the place to go.

This documentation is autogenererated from the doc comments throughout the Glean.js codebase and the Glean book should be preferred over this documentation whenever possible.

Contact

To contact us you can:

• Find us in the #glean channel on chat.mozilla.org.
• To report issues or request changes, file a bug in Bugzilla in Data Platform & Tools :: Glean.js.
• Send an email to [e-mail].
• The Glean Core team is: :dexter, :janerik, :mdroettboom, :travis_, :chutten, :brizental.

Credits

The Glean logo artwork was contributed by Diana Ciufo. It's licensed under MPL.

License

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/

Changelog

v0.28.0 (2021-12-08)

Full changelog

• #984: BUGFIX: Return correct upload result in case an error happens while building a ping request.
• #988: BUGFIX: Enforce rate limitation at upload time, not at ping submission time.
  • Note: This change required a big refactoring of the internal uploading logic.
• #994: Automatically restart ping upload once the rate limit window is ended.
  • Prior to this change, ping uploading would only be resumed once the .submit() API was called again, even if Glean was not throttled anymore.
  • Note: this change does not apply to QML. We used the setTimeout/clearTimeout APIs in this feature and those are not available on the QML platform. Follow Bug 1743140 for updates.
• #1015: BUGFIX: Make attempting to call the setUploadEnabled API before initializing Glean a no-op.
• #1016: BUGFIX: Make shutdown a no-op in case Glean is not initialized.