Package: glean-parser
Glean ParserParser tools for Mozilla's Glean telemetry.FeaturesContains various utilities for handlingmetrics.yamlandpings.yamlforthe
Glean SDKs. This includes producing generated
code for various integrations, linting and coverage testing.DocumentationHow to Contribute. Please file bugs inbugzilla.User documentation for Glean.glean_parserdeveloper documentation.RequirementsPython 3.8 (or later)The following library requirements are installed automatically whenglean_parseris installed bypip.appdirsClickdiskcacheJinja2jsonschemaPyYAMLUsage$glean_parser--helpRead inmetrics.yaml, translate to Kotlin format, and
output tooutput_dir:$glean_parsertranslate-ooutput_dir-fkotlinmetrics.yamlCheck a Glean ping against the ping schema:$glean_parsercheck<ping.jsonChangelogUnreleased13.0.0BREAKING CHANGE: Support metadata fieldinclude_info_sections(bug 1866559)12.0.1Fix Rust codegen for object metric type (#662)12.0.0Add new metric type object (only Rust codegen support right now) (#587)11.1.0Add Go log outputter (go_server) (#645)Add Python log outputter (python_server) (MPP-3642)11.0.1Fix javascript_server template to include non-event metric parameters in #record call for event metrics (#643)events: Increase extra key limit to 50 (Bug 1869429)11.0.0Add updated logging logic for Ruby Server (#642)Add support for event metric type in server-side JavaScript outputter (DENG-1736)BREAKING CHANGE: Dropped support for Python 3.7 (#638)Add official support for Python 3.11+ (#638)10.0.3Warn about empty or TODO-tagged data reviews in the list (#634)Allowunitfield on all metrics, but warn for all but quantity and custom distribution (#636)10.0.2Allowunitfield for string again, but warn about it in the linter (#634)10.0.1Allowunitfield for custom distribution again (#633)10.0.0Add Ruby log outputter (ruby_server) (#620)BREAKING CHANE:pinglifetime metrics on the events ping are now disallowed (#625)Disallowunitfield for anything but quantity (#630).
Note that this was already considered the case, now the code enforces it.9.0.0BREAKING CHANGE: Dropped support for Python 3.6 (#615)Allow metadata to configure precise timestamps in pings (#592)8.1.1Small updates to thejavascript_servertempalte to address lint warnings (#598)8.1.0Increased the maximum metric name length in version 2.0.0 schema (#596)8.0.0BREAKING CHANGE: Remove exposedlint_yaml_filesfunction (#580)Rust: Removed__glean_metric_mapsfrom the Rust Jinja template. This functionality is better placed downstream (Bug 1816526)New lint: check that all referenced pings are known (#584)Add experimental server-side JavaScript outputter (FXA-7922)7.2.1Unbreak last minor release (#579)7.2.0Remove yamllint integration (#578)7.1.0ENHANCEMENT: Labels inlabels:fields may now contain any printable ASCII characters (bug 1672273)BUGFIX: Enforce ordering of generation of Pings, Metrics and Tags such that order is deterministic (bug 1820334)7.0.0BUGFIX: Remove internal-only fields from serialized metrics data (#550)FEATURE: New subcommand:dumpto dump the metrics data as JSON (#550)BUGFIX: Kotlin: Generate enums with the right generic bound for ping reason codes (#551).BREAKING CHANGE:Fully remove support for the old events API (#549)
Adds a new lintOLD_EVENT_APIto warn about missingtypeattributes on event extra keys.
Note that the Glean SDK already dropped support for the old events API.6.4.0BUGFIX: Correct code generation for labeled metrics in Rust (#533)BUGFIX: Correctly serializeRatesfor Rust code (#530)Feature: Wrap labeled metric's static labels list as CoW strings (requires updated Glean support) (#534)6.3.0events: Increase extras limit to 15 (bug 1798713)6.2.1Add support for Rate, Denominator and Numerator metrics for JavaScript. (bug 1793777)6.2.0[data-review] Use a template to generate the Data Review Request template (bug 1772605)Make tag and no_lint order deterministic (#518)6.1.2Swift: Add a conditionalimport Foundationto support generating metrics when Glean is delivered via the AppServices iOS megazord6.1.1Rust: Use correct name for a ping in generated code.6.1.0[data-review] Include extra keys' names and descriptions in data review template (bug 1767027)Raise limit on number of statically-defined labels to 4096. (bug 1772163)Fix Rust code generation for new UniFFI interface (#491,#494,#495)6.0.1Relax version requirement for MarkupSafe.
Now works with MarkupSafe v1.1.1 to v2.0.1 inclusive again.6.0.0BUGFIX: Add missingextra_argsto Rust constructor generation (bug 1765855)Breaking change:glean_parsernow generates metrics compatible with the UniFFI-powered Glean SDK.
This is not backwards-compatible with previous versions.Generate Rate, Denominator and Numerator metrics for Kotlin and SwiftExplicitly skip Rate, Denominator and Numerator metrics for JavaScript.
These will cause a build failure by default, but can be turned into warnings on request.
Use-s fail_rates=falseto enable warning-only mode.5.1.2BUGFIX: Revert changes made on v5.1.1.The issues addressed by those changes, were non-issues and result of misuse of the APIs.5.1.1BUGFIX: Fix issues with Swift templates (bug 1749494)Make metrics and pings allpublicMake pingsstatic5.1.0Add support for build info generation for JavaScript and Typescript targets (bug 1749494)5.0.1Fix the logic for the metric expiration by version (bug 1753194)5.0.0Remove C# support (#436).Add support for Rust code generation (bug 1677434)Report an error if no files are passed (bug 1751730)[data-review] Report an error if no metrics match provided bug number (bug 1752576)[data-review] Include notification_emails in list of those responsible (bug 1752576)Add support for expiring metrics by the provided major version (bug 1753194)4.4.0Support global file-level tags in metrics.yaml (bug 1745283)Glinter: Reject metric files if they useunitby mistake. It should betime_unit(#432).Automatically generate a build date when generating build info (#431).
Enabled for Kotlin and Swift.
This can be changed with thebuild_datecommand line option.build_date=0will use a static unix epoch time.build_date=2022-01-03T17:30:00will parse the ISO8601 string to use (as a UTC timestamp).
Other values will throw an error.Example:glean_parser translate --format kotlin --option build_date=2021-11-01T01:00:00 path/to/metrics.yaml4.3.1BUGFIX: Skip tags for code generation (#409)4.3.0Support tags in glean parser (bug 1734011)4.2.0Improve the schema validation error messages. They will no longer includeOrderedDict(...)on Python 3.7 and later (bug 1733395)Officially support Python 3.104.1.1 (2021-09-28)Update private import paths on Javascript / Typescript templates. (bug 1702468)4.1.0 (2021-09-16)Add support for Node.js platform on Javascript / Typescript templates. (bug 1728982)4.0.0 (2021-08-20)Add support for Text metric type (#374)Reserve thedefaultping name. It can't be used as a ping name, but it can be used insend_in_pings(#376)3.8.0 (2021-08-18)Expose ping reasons enum on JavaScript / TypeScript templates. (bug 1719136)Define an interface with the allowed extras for each event on the TypeScript template. (bug 1693487)3.7.0 (2021-07-13)New lint: Check for redundant words in ping names (#355)Add support for URL metric type (#361)3.6.0 (2021-06-11)Add a commanddata-reviewto generate a skeleton Data Review Request for all metrics matching a supplied bug number. (bug 1704541)Enable custom distribution outside of GeckoView (gecko_datapointbecomes optional)3.5.0 (2021-06-03)Transform generated folder into QML Module when building Javascript templates for the Qt platform. (bug 1707896Import the Glean QML module from inside each generated file, removing the requirement to import Glean before importing any of the generated files;Prodive aqmldirfile exposing all generated files;Drop thenamespaceoption for Javascript templates;Add a newversionoption for Javascript templates, required when building for Qt, which expected the Glean QML module version.3.4.0 (2021-05-28)Add missing import for Kotlin code (#339)Use a plain Kotlin type in the generated interface implementation (#339)Generate additional generics for event metrics (#339)For Kotlin skip generatingGleanBuildInfo.ktwhen requested (withwith_buildinfo=false) (#341)3.3.2 (2021-05-18)Fix another bug in the Swift code generation when generating extra keys (#334)3.3.1 (2021-05-18)Fix Swift code generation bug for pings (#333)3.3.0 (2021-05-18)Generate new event API construct (#321)3.2.0 (2021-04-28)Add option to add extra introductory text to generated markdown (#298)Add support for Qt in Javascript templates (bug 1706252)Javascript templates will now accept theplatformoption. If this option is set toqtthe generated templates will be Qt compatible. Default value iswebext.3.1.2 (2021-04-21)BUGFIX: Remove the "DO NOT COMMIT" notice from the documentation.3.1.1 (2021-04-19)Recommend to not commit as well as to not edit the generated files. (bug 1706042)BUGFIX: Include import statement for labeled metric subtypes in Javascript and Typescript templates.3.1.0 (2021-04-16)Add support for labeled metric types in Javascript and Typescript templates.3.0.0 (2021-04-13)Raise limit on number of statically-defined lables to 100. (bug 1702263)BUGFIX: Version 2.0.0 of the schema now allows the "special"glean_.*ping names for Glean-internal use again.Remove support for JWE metric types.2.5.0 (2021-02-23)Add parser and object model support forratemetric type. (bug 1645166)Add parser and object model support for telemetry_mirror property. (bug 1685406)Update the Javascript template to match Glean.js expectations. (bug 1693516)Glean.js has updated it's export strategy. It will now export each metric type as an independent module;Glean.js has dropped support for non ES6 modules.Add support for generating Typescript code. (bug 1692157)The templates added generate metrics and pings code for Glean.js.2.4.0 (2021-02-18)Experimental:glean_parserhas a new subcommandcoverageto convert raw coverage reports
into something consumable by coverage tools, such as codecov.ioThe path to the file that each metric is defined in is now stored on theMetricobject indefined_in["filepath"].2.3.0 (2021-02-17)Leverage theglean_namespaceto provide correct import when building for Javascript.2.2.0 (2021-02-11)The Kotlin generator now generates static build information that can be passed
intoGlean.initializeto avoid calling the package manager at runtime.2.1.0 (2021-02-10)Add support for generating Javascript code.The templates added generate metrics and pings code for Glean.js.2.0.0 (2021-02-05)New versions 2.0.0 of themetrics.yamlandpings.yamlschemas now ship
withglean_parser. These schemas are different from version 1.0.0 in the
following ways:Bugs must be specified as URLs. Bug numbers are disallowed.The legacy ping names containing underscores are no longer allowed. These
includeddeletion_request,bookmarks_sync,history_sync,session_end,all_pings,glean_*). In these cases, the_should be
replaced with-.To upgrade your app or library to use the new schema, replace the version in
the$schemavalue with2-0-0.Breaking change:It is now an error to use bug numbers (rather than URLs)
in ping definitions.Add the line number that metrics and pings were originally defined in the yaml
files.1.29.1 (2020-12-17)BUGFIX: Linter output can now be redirected correctly (1675771).1.29.0 (2020-10-07)Breaking change:glean_parserwill now return an error code when any of
the input files do not exist (unless the--allow-missing-filesflag is
passed).Generated code now includes a comment next to each metric containing the name
of the metric in its originalsnake_caseform.When metrics don't provide aunitparameter, it is not included in the
output (as provided by probe-scraper).1.28.6 (2020-09-24)BUGFIX: Ensure Kotlin arguments are deterministically ordered1.28.5 (2020-09-14)Fix deploy step to update pip before deploying to pypi.1.28.4 (2020-09-14)TheSUPERFLUOUS_NO_LINTwarning has been removed from the glinter.
It likely did more harm than good, and makes it hard to makemetrics.yamlfiles that pass across different versions ofglean_parser.Expired metrics will now produce a linter warning,EXPIRED_METRIC.Expiry dates that are more than 730 days (~2 years) in the future
will produce a linter warning,EXPIRATION_DATE_TOO_FAR.Allow using the Quantity metric type outside of Gecko.New parser configscustom_is_expiredandcustom_validate_expiresadded. These are both functions that take theexpiresvalue of the
metric and return a bool. (SeeMetric.is_expiredandMetric.validate_expires). These will allow FOG to provide custom
validation for its version-basedexpiresvalues.1.28.3 (2020-07-28)BUGFIX: Support HashSet and Dictionary in the C## generated code.1.28.2 (2020-07-28)BUGFIX: Generate valid C## code when using Labeled metric types.1.28.1 (2020-07-24)BUGFIX: Add missing column to correctly render markdown tables in generated
documentation.1.28.0 (2020-07-23)Breaking change:The internal pingdeletion-requestwas misnamed in
pings.py causing the linter to not allow use of the correctly named ping for
adding legacy ids to. Consuming apps will need to update their metrics.yaml if
they are usingdeletion_requestin anysend_in_pingstodeletion-requestafter updating.1.27.0 (2020-07-21)Rename thedata_categoryfield todata_sensitivityto be clearer.1.26.0 (2020-07-21)Add support for JWE metric types.Add adata_sensitivityfield to all metrics for specifying the type of data
collected in the field.1.25.0 (2020-07-17)Add support for generating C## code.BUGFIX: The memory unit is now correctly passed to the MemoryDistribution
metric type in Swift.1.24.0 (2020-06-30)BUGFIX: look for metrics in send_if_empty pings. Metrics for these kinds of
pings were being ignored.1.23.0 (2020-06-27)Support for Python 3.5 has been dropped.BUGFIX: The ordering of event extra keys will now match with their enum,
fixing a serious bug where keys of extras may not match the correct values in
the data payload. Seehttps://bugzilla.mozilla.org/show_bug.cgi?id=1648768.1.22.0 (2020-05-28)Breaking change:(Swift only) Combine all metrics and pings into a single
generated fileMetrics.swift.1.21.0 (2020-05-25)glintermessages have been improved with more details and to be more
actionable.A maximum of 10extra_keysis now enforced foreventmetric types.BUGFIX: theLifetimeenum values now match the values of the implementation
in mozilla/glean.1.20.4 (2020-05-07)BUGFIX: yamllint errors are now reported using the correct file name.1.20.3 (2020-05-06)Support for usingtiming_distribution'stime_unitparameter to control
the range of acceptable values is documented. The default unit for this use
case isnanosecondto avoid creating a breaking change. Seebug
1630997for more
information.1.20.2 (2020-04-24)Dependencies that depend on the version of Python being used are now specified
using theDeclaring platform specific dependencies syntax in
setuptools.
This means that more recent versions of dependencies are likely to be
installed on Python 3.6 and later, and unnecessary backport libraries won't
be installed on more recent Python versions.1.20.1 (2020-04-21)The minimum version of the runtime dependencies has been lowered to increase
compatibility with other tools. These minimum versions are now tested in CI,
in addition to testing the latest versions of the dependencies that was
already happening in CI.1.20.0 (2020-04-15)Breaking change:glinter errors found during thetranslatecommand will
now return an error code. glinter warnings will be displayed, but not return
an error code.glean_parsernow produces a linter warning whenuserlifetime metrics are
set to expire. Seebug
1604854for additional
context.1.19.0 (2020-03-18)Breaking change:The regular expression used to validate labels is
stricter and more correct.Add more information about pings to markdown documentation:State whether the ping includes client id;Add list of data review links;Add list of related bugs links.glean_parsernow makes it easier to write external translation
functions for different language targets.BUGFIX:glean_parsernow works on 32-bit Windows.1.18.3 (2020-02-24)Dropped theinflectiondependency.Constrained thezippandMarkupSafetransitive dependencies to versions
that support Python 3.5.1.18.2 (2020-02-14)BUGFIX: Fix rendering of first element of reason list.1.18.1 (2020-02-14)BUGFIX: Reason codes are displayed in markdown output for built-in
pings as well.BUGFIX: Reason descriptions are indented correctly in markdown
output.BUGFIX: To avoid a compiler error, the@JvmNameannotation isn't
added to private members.1.18.0 (2020-02-13)Breaking Change (Java API)Have the metrics names in Java match the names
in Kotlin. SeeBug
1588060.The reasons a ping are sent are now included in the generated markdown
documentation.1.17.3 (2020-02-05)BUGFIX: The version of Jinja2 now specifies < 3.0, since that version no
longer supports Python 3.5.1.17.2 (2020-02-05)BUGFIX: Fixes an import error in generated Kotlin code.1.17.1 (2020-02-05)BUGFIX: Generated Swift code now includesimport Glean, unless generating
for a Glean-internal build.1.17.0 (2020-02-03)Remove default schema URL fromvalidate_pingMakeschemaargument required for CLIBUGFIX: Avoid default import in Swift code for Glean itselfBUGFIX: Restore order of fields in generated Swift code1.16.0 (2020-01-15)Support forreasoncodes on pings was added.1.15.6 (2020-02-06)BUGFIX: The version of Jinja2 now specifies < 3.0, since that version no
longer supports Python 3.5 (backported from 1.17.3).1.15.5 (2019-12-19)BUGFIX: Also allow the legacy nameall_pingsforsend_in_pingsparameter
on metrics1.15.4 (2019-12-19)BUGFIX: Also allow the legacy nameall_pings1.15.3 (2019-12-13)Add project title to markdown template.Remove "Sorry about that" from markdown template.BUGFIX: Replace dashes in variable names to force proper naming1.15.2 (2019-12-12)BUGFIX: Use a pure Python library for iso8601 so there is no compilation
required.1.15.1 (2019-12-12)BUGFIX: Add some additional ping names to the non-kebab-case allow list.1.15.0 (2019-12-12)Restrict new pings names to be kebab-case and changeall_pingstoall-pings1.14.0 (2019-12-06)glean_parsernow supports Python versions 3.5, 3.6, 3.7 and 3.8.1.13.0 (2019-12-04)Thetranslatecommand will no longer clear extra files in the output
directory.BUGFIX: Ensure all newlines in comments are prefixed with comment markersBUGFIX: Escape Swift keywords in variable names in generated codeGenerate documentation for pings that are sent if empty1.12.0 (2019-11-27)Reserve thedeletion_requestping nameAdded a new flagsend_if_emptyfor pings1.11.0 (2019-11-13)Theglintercommand now performsyamllintvalidation on registry files.1.10.0 (2019-11-11)The Kotlin linterdetektis now run during CI, and for local
testing if installed.Python 3.8 is now tested in CI (in addition to Python 3.7). Usingtoxfor this doesn't work in modern versions of CircleCI, so thetoxconfiguration has been removed.yamllinthas been added to test the YAML files on CI.⚠ Metric types that don't yet have implementations in glean-core
have been removed. This includesenumeration,rate,usage, anduse_counter, as well as many labeled metrics that don't exist.1.9.5 (2019-10-22)Allow a Swift lint for generated codeNew lint: Restrict what metric can go into thebaselinepingNew lint: Warn for slight misspellings in ping namesBUGFIX: change Labeled types labels from lists to sets.1.9.4 (2019-10-16)Use lists instead of sets in Labeled types labels to ensure that the order of
the labels passed to themetrics.yamlis kept.glinterwill now check for duplicate labels and error if there are any.1.9.3 (2019-10-09)Add labels from Labeled types to the Extra column in the Markdown template.1.9.2 (2019-10-08)BUGFIX: Don't callis_internal_metriconPingobjects.1.9.1 (2019-10-07)Don't include Glean internal metrics in the generated markdown.1.9.0 (2019-10-04)Glinter now warns when bug numbers (rather than URLs) are used.BUGFIX: addHistogramTypeandMemoryUnitimports in Kotlin generated code.1.8.4 (2019-10-02)Removed unsupported labeled metric types.1.8.3 (2019-10-02)Fix indentation for generated Swift code1.8.2 (2019-10-01)Created labeled metrics and events in Swift code and wrap it in a
configured namespace1.8.1 (2019-09-27)BUGFIX:memory_unitis now passed to the Kotlin generator.1.8.0 (2019-09-26)A new parser config,do_not_disable_expired, was added to turn off the
feature that expired metrics are automatically disabled. This is useful if you
want to retain the disabled value that is explicitly in themetrics.yamlfile.glinterwill now report about superfluousno_lintentries.1.7.0 (2019-09-24)Aglintertool is now included to find common mistakes in metric naming
and setup. This check is run duringtranslateand warnings will be
displayed. ⚠ These warnings will be treated as errors in a future revision.1.6.1 (2019-09-17)BUGFIX:GleanGeckoMetricsMappingmust includeLabeledMetricTypeandCounterMetricType.1.6.0 (2019-09-17)NEW: Support for outputting metrics in Swift.BUGFIX: Provides a helpful error message whengeckoview_datapointis used on
an metric type that doesn't support GeckoView exfiltration.Generate a lookup table for Gecko categorical histograms inGleanGeckoMetricsMapping.Introduce a 'Swift' output generator.1.4.1 (2019-08-28)Documentation only.1.4.0 (2019-08-27)Added support for generating markdown documentation frommetrics.yamlfiles.1.3.0 (2019-08-22)quantitymetric type has been added.1.2.1 (2019-08-13)BUGFIX:includeClientIdwas not being output for PingType.1.2.0 (2019-08-13)memory_distributionmetric type has been added.custom_distributionmetric type has been added.labeled_timespanis no longer an allowed metric type.1.1.0 (2019-08-05)Add a specialall_pingsvalue tosend_in_pings.1.0.0 (2019-07-29)First release to start following strict semver.0.1.0 (2018-10-15)First release on PyPI.