glean_parser/README.md

2.2 KiB

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