glean/README.md

Glean SDK

Documentation

All documentation is available online:

The Glean SDK Book

Overview

Refer to the documentation for using and developing the Glean SDK.

For an overview of Glean beyond just the SDK, see the section in the Firefox data docs.

There currently two independent implementations of the Glean SDK:

• An Android-only implementation in android-components.
• A cross-platform implementation. (This implementation is currently under development and not ready for use).

The code in this repository for the cross-platform implementation is organized as follows:

• ./glean-core/ contains the source for the low-level Rust library.
• ./glean-core/ffi contains the mapping into a C FFI.
• ./glean-core/android contains the Kotlin bindings for use by Android applications.
• ./glean-core/ios contains the Swift bindings for use by iOS applications.

Note: The Glean SDK requires at least Rust 1.34.2. Older versions are untested.

Contact

To contact us you can:

• Find us on the Mozilla Slack in #glean, on Mozilla IRC in #telemetry.
• To report issues or request changes, file a bug in Bugzilla in Data Platform & Tools :: Glean: SDK.
• Send an email to glean-team@mozilla.com.
• The Glean Core team is: :dexter, :janerik, :mdroettboom, :travis_, :gfritzsche

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/