glean_parser/docs
Jan-Erik Rediger f6b31efd0c Mark the Glean team as author of this package 2022-03-14 11:22:30 +01:00
..
_static 1513617: Turn metrics.yaml schema into formal docs 2018-12-14 14:20:05 -05:00
Makefile Initial commit from cookiecutter 2018-10-15 09:48:45 -04:00
authors.md Bug 1691116: Convert (most) rst files to markdown (#273) 2021-02-16 12:45:51 -05:00
conf.py Mark the Glean team as author of this package 2022-03-14 11:22:30 +01:00
contributing.md Bug 1691116: Convert (most) rst files to markdown (#273) 2021-02-16 12:45:51 -05:00
history.md Bug 1691116: Convert (most) rst files to markdown (#273) 2021-02-16 12:45:51 -05:00
index.rst Bug 1734011 - Support tags in glean parser (#406) 2021-11-02 12:43:06 -04:00
installation.md Mark the Glean team as author of this package 2022-03-14 11:22:30 +01:00
make.bat Initial commit from cookiecutter 2018-10-15 09:48:45 -04:00
metrics-yaml.rst [doc only] Bug 1703280: Move metric parameter docs to the Glean Book (#303) 2021-04-07 08:37:44 -04:00
pings-yaml.rst [doc only] Bug 1703280: Move metric parameter docs to the Glean Book (#303) 2021-04-07 08:37:44 -04:00
readme.md Bug 1691116: Convert (most) rst files to markdown (#273) 2021-02-16 12:45:51 -05:00
tags-yaml.rst Bug 1734011 - Support tags in glean parser (#406) 2021-11-02 12:43:06 -04:00

readme.md

Glean Parser

Parser tools for Mozilla's Glean telemetry.

Features

Contains various utilities for handling metrics.yaml and pings.yaml for the Glean SDKs. This includes producing generated code for various integrations, linting and coverage testing.

Documentation

Requirements

  • Python 3.8 (or later)

The following library requirements are installed automatically when glean_parser is installed by pip.

  • Click
  • diskcache
  • Jinja2
  • jsonschema
  • platformdirs
  • PyYAML

Usage

$ glean_parser --help

Read in metrics.yaml, translate to Kotlin format, and output to output_dir:

$ glean_parser translate -o output_dir -f kotlin metrics.yaml

Check a Glean ping against the ping schema:

$ glean_parser check < ping.json