Tools for parsing the metadata for Mozilla's glean telemetry SDK
Перейти к файлу
Michael Droettboom f5a52a5e24 Bump version: 0.22.0 → 0.23.0 2019-04-12 09:46:23 -04:00
.circleci Build tags 2019-04-09 13:18:59 -04:00
.github Initial commit from cookiecutter 2018-10-15 09:48:45 -04:00
docs 1540725: Make labeled metrics individual metric types. 2019-04-09 16:05:28 -04:00
glean_parser Bump version: 0.22.0 → 0.23.0 2019-04-12 09:46:23 -04:00
tests 1540725: Make labeled metrics individual metric types. 2019-04-09 16:05:28 -04:00
.editorconfig Initial commit from cookiecutter 2018-10-15 09:48:45 -04:00
.gitignore Minor doc improvements to get the docs to build 2018-11-20 18:03:35 -05:00
AUTHORS.rst Add Travis Long to AUTHORS 2019-03-29 15:28:01 -04:00
CODE_OF_CONDUCT.md Add Mozilla Code of Conduct file (#52) 2019-04-01 09:30:27 +02:00
CONTRIBUTING.rst Fix deploy instructions 2019-02-22 09:27:41 -05:00
HISTORY.rst Initial commit from cookiecutter 2018-10-15 09:48:45 -04:00
LICENSE Initial commit from cookiecutter 2018-10-15 09:48:45 -04:00
MANIFEST.in Fix typo 2018-10-22 15:02:47 -04:00
Makefile Upload to "real" PyPI 2019-04-09 13:31:02 -04:00
README.rst 1528260: Simplify and implement metric expiry 2019-03-12 18:00:39 -04:00
requirements_dev.txt First pass at PyPI deploy 2019-04-09 13:14:06 -04:00
setup.cfg Bump version: 0.22.0 → 0.23.0 2019-04-12 09:46:23 -04:00
setup.py Bump version: 0.22.0 → 0.23.0 2019-04-12 09:46:23 -04:00
tox.ini Basic customization after cookiecutter 2018-10-15 10:00:16 -04:00

README.rst

============
Glean Parser
============

Parser tools for Mozilla's glean telemetry.

Features
--------

Parses the ``metrics.yaml`` files for the glean telemetry SDK and produces
output for various integrations.

Documentation
-------------

The full documentation is available `here <https://mozilla.github.io/glean_parser/>`__.

Requirements
------------

- Python 3.7 (or later)

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

- appdirs
- Click
- diskcache
- inflection
- Jinja2
- jsonschema
- PyYAML

Usage
-----

.. code-block:: console

  $ glean_parser --help

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

.. code-block:: console

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

Check a glean ping against the ping schema:

.. code-block:: console

  $ glean_parser check < ping.json