Introduction

The Glean SDKs are modern cross-platform telemetry client libraries and are a part of the Glean project.

The Glean SDKs are available for several programming languages and development environments. Each SDK aims to contain the same group of features with similar, but idiomatic APIs.

To learn more about each SDK, refer to the SDKs overview page.

To get started adding Glean to your project, choose one of the following guides:

• Kotlin
  • Get started adding Glean to an Android application or library.
• Swift
  • Get started adding Glean to an iOS application or library.
• Python
  • Get started adding Glean to any Python project.
• Rust
  • Get started adding Glean to any Rust project or library.
• JavaScript
  • Get started adding Glean to a website, web extension or Node.js project.
• QML
  • Get started adding Glean to a Qt/QML application or library.

• Server
  • Get started adding Glean to a server-side application.

For development documentation on the Glean SDK, refer to the Glean SDK development book.

Sections

User Guides

This section of the book contains step-by-step guides and essays detailing how to achieve specific tasks with each Glean SDK.

It contains guides on the first steps of integrating Glean into your project, choosing the right metric type for you, debugging products that use Glean and Glean's built-in error reporting mechanism.

If you want to start using Glean to report data, this is the section you should read.

API Reference

This section of the book contains reference pages for Glean’s user facing APIs.

If you are looking for information a specific Glean API, this is the section you should check out.

SDK Specific Information

This section contains guides and essays regarding specific usage information and possibilities in each Glean SDK.

Check out this section for more information on the SDK you are using.

Appendix

Glossary

In this book we use a lot of Glean specific terminology. In the glossary, we go through many of the terms used throughout this book and describe exactly what we mean when we use them.

Changelog

This section contains detailed notes about changes in Glean, per release.

This Week in Glean

“This Week in Glean” is a series of blog posts that the Glean Team at Mozilla is using to try to communicate better about our work. They could be release notes, documentation, hopes, dreams, or whatever: so long as it is inspired by Glean.

Contribution Guidelines

This section contains detailed information on where and how to include new content to this book.

Contact

To contact the Glean team 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: SDK.
• Send an email to glean-team@mozilla.com.
• The Glean SDKs team is: :janerik, :dexter, :travis, :chutten, :perrymcmanis.

License

The Glean SDKs Source Code is subject to the terms of the Mozilla Public License v2.0. You can obtain a copy of the MPL at https://mozilla.org/MPL/2.0/.