e919e9e8e2
[doc only] |
||
---|---|---|
.. | ||
api | ||
appendix | ||
dev | ||
user | ||
README.md | ||
SUMMARY.md | ||
book.toml | ||
chart-distributions-ui.js | ||
chart-distributions.js | ||
chart.min.js | ||
code_coverage.md | ||
contributing.md | ||
glean.css | ||
glean.jpeg | ||
highlight.js | ||
mermaid-init.js | ||
mermaid.css | ||
mermaid.min.js | ||
tab_footer.md | ||
tab_header.md | ||
tabs.js |
README.md
Glean SDK
The Glean SDK
is a modern approach for a Telemetry library and is part of the Glean project.
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: SDK.
- Send an email to glean-team@mozilla.com.
- The Glean SDK team is: :janerik, :dexter, :travis, :mdroettboom, :gfritzsche, :chutten, :brizental.
The source code is available on GitHub.
Using this book
This book is specifically about the Glean SDK
(the client side code for collecting telemetry). Documentation about the broader end-to-end Glean project.
This book is divided into 5 main chapters:
Using the Glean SDK
If you want to use the Glean SDK to report data then this is the section you should read. It explains the first steps from integrating Glean into your project, contains details about all available metric types and how to do send your own custom pings.
Metrics collected by the Glean SDK
This chapter lists all metrics collected by the Glean SDK itself.
Developing the Glean SDK
This chapter describes how to develop the Glean SDK and its various implementations. This is relevant if you plan to contribute to the Glean SDK code base.
API Reference Documentation
Reference documentation for the API in its various language bindings.
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.
License
The Glean SDK 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/.