glean/docs
Jan-Erik Rediger e919e9e8e2 Call out that `notification_emails` are used to send expiration alerts
[doc only]
2020-11-04 15:02:12 +01:00
..
api WIP: 1591185: Set up basic Python project structure (#423) 2019-11-04 13:18:03 -05:00
appendix Update TWiG index with Glean.js blog post (#1293) 2020-11-03 10:09:36 +01:00
dev Merge pull request #1285 from mozilla/document-megazord 2020-10-28 10:09:49 +01:00
user Call out that `notification_emails` are used to send expiration alerts 2020-11-04 15:02:12 +01:00
README.md Split book into more explicit groups 2020-09-29 13:37:16 +02:00
SUMMARY.md Document the pending ping file format 2020-10-06 14:24:46 +02:00
book.toml Bug 1654384 - Add a specific simulator to each of the distributions metrics on the book (#1150) 2020-08-19 10:19:43 +02:00
chart-distributions-ui.js Bug 1654384 - Add a specific simulator to each of the distributions metrics on the book (#1150) 2020-08-19 10:19:43 +02:00
chart-distributions.js Add a default transformation function to simulators code (#1237) 2020-09-29 13:41:19 +02:00
chart.min.js Bug 1654384 - Add a specific simulator to each of the distributions metrics on the book (#1150) 2020-08-19 10:19:43 +02:00
code_coverage.md Drop automated code coverage reports 2020-02-06 14:34:52 +01:00
contributing.md Don't require swiftformat to run anymore 2020-08-24 12:56:15 +02:00
glean.css Bug 1654384 - Add a specific simulator to each of the distributions metrics on the book (#1150) 2020-08-19 10:19:43 +02:00
glean.jpeg Branding is important (#4) 2019-04-30 14:30:48 +02:00
highlight.js Add modified highlightjs to support required languages 2019-06-19 17:03:16 -04:00
mermaid-init.js Add missing license headers 2020-05-11 13:52:38 +02:00
mermaid.css Add missing license headers 2020-05-11 13:52:38 +02:00
mermaid.min.js Add mermaid support and start using mdbook-dtmo on CI 2020-04-20 15:06:26 +02:00
tab_footer.md 1589677: Fix jumping around when switching language tabs 2019-10-21 08:26:07 -04:00
tab_header.md WIP: 1591185: Set up basic Python project structure (#423) 2019-11-04 13:18:03 -05:00
tabs.js WIP: 1591185: Set up basic Python project structure (#423) 2019-11-04 13:18:03 -05:00

README.md

Glean SDK

Glean logo

The Glean SDK is a modern approach for a Telemetry library and is part of the Glean project.

To contact us you can:

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/.