mozilla
/
glean
зеркало из https://github.com/mozilla/glean.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
4 753 коммитов 50 Ветки 176 Теги 614 MiB
Граф коммитов

1057 Коммитов

Автор SHA1 Сообщение Дата
Beatriz Rizental 88fc8e53ca
Merge pull request #1646 from brizental/1698800-metrics-docs 
Bug 1698800 - Finish including Glean.js docs to metrics reference pages
 2021-05-31 11:28:28 +02:00
Alessio Placitelli 98882c0775 Address review feedback 2021-05-31 11:19:17 +02:00
Alessio Placitelli e036d381e0 Add security considerations 2021-05-31 09:47:32 +02:00
Alessio Placitelli f5e8750c5c Move 'adding-glean-to-your-project' and update the links 2021-05-28 19:33:11 +02:00
Alessio Placitelli ea3866bd8f Add documentation for adding Glean to your javascript project 2021-05-28 19:24:04 +02:00
Alessio Placitelli 3d2e0a30ca Tweak the 'adding glean to your project' page a bit 2021-05-28 18:57:57 +02:00
Alessio Placitelli 4550006b1a Update the Python page with the parallelism information 2021-05-28 18:55:36 +02:00
Alessio Placitelli 60b6c86251 Move "adding Glean to a C# project" to its own page 2021-05-28 18:55:19 +02:00
Alessio Placitelli 8db590198b Move "adding Glean to a Python project" to its own page 2021-05-28 18:39:56 +02:00
Alessio Placitelli 1695a7a320 Move "adding Glean to a Swift project" to its own page 2021-05-28 18:33:16 +02:00
Alessio Placitelli 898daa5d06 Move "adding Glean to a Kotlin project" to its own page 2021-05-28 18:21:34 +02:00
Jan-Erik Rediger 3a1b8502c2 Document new event API (and deprecate the old one) 2021-05-28 16:38:06 +02:00
Jan-Erik Rediger 58172c6cbc Kotlin: Allow new event extra properties to be passed as an object 2021-05-28 16:38:06 +02:00
Jan-Erik Rediger 260b5c789e
Merge pull request #1645 from mozilla/m1-setup 
Document how to set up the dev env on M1 macbooks
 2021-05-28 13:25:25 +02:00
Chris H-C c07b23dcc6 bug 1712772 - Update datetime docs for FOG changes [doc only] 2021-05-27 09:18:40 -04:00
brizental 1038dc19bc Add Glean.js information to timespan ref page 
[doc only]
 2021-05-26 12:21:52 +02:00
brizental d8c1e7f7d5 Document testGetNumRecordedErrors for Javascript where missing 
...And add reference link to where it was missing too.

[doc only]
 2021-05-26 12:09:08 +02:00
Alessio Placitelli 110f88bc1e
Merge pull request #1649 from Dexterp37/new_addglean_template 
Bug 1710794 - Updates the template to add Glean to the pipeline [docs only]
 2021-05-25 18:20:23 +02:00
Alessio Placitelli 1ad93fbe3b Clarify what end-to-end encryption is about 2021-05-25 17:55:18 +02:00
Chris H-C e048f3b202 [doc only] Rewire the timespan docs to the new format 2021-05-25 11:32:07 -04:00
Alessio Placitelli 9a2cd69b09 Updates the template to add Glean to the pipeline 
This splits the template in two sections: one for the
requester, one for the Glean team to fill.

The details for this were discussed in bug 1710794
 2021-05-25 16:46:09 +02:00
Beatriz Rizental 9809b93c13
Merge pull request #1642 from brizental/1698800-metrics-docs 
Bug 1698800 - Update labeled metrics docs to new structure and add Glean.js docs
 2021-05-20 10:49:45 +02:00
Jan-Erik Rediger 5636d9b88d Document how to set up the dev env on M1 macbooks 
[doc only]
 2021-05-20 10:17:22 +02:00
brizental e0bef59717 Conform quantity metric reference page to new format 
[doc only]
 2021-05-19 17:48:03 +02:00
brizental 1f8cc55b8a Remove extra parenthesis from Javascript example 
[doc only]
 2021-05-19 17:22:51 +02:00
brizental bfb126bdaa EXTRA: Fix tab overflowing when text requires scroll bar 2021-05-19 17:18:49 +02:00
brizental e9cdea8ac6 Conform labeled string metric reference page to new format 2021-05-19 17:18:24 +02:00
brizental f9b8cbb371 Conform labeled counter metric reference page to new format 2021-05-19 16:52:52 +02:00
brizental 335035cadf Conform labeled boolean metric reference page to new format 2021-05-19 14:48:35 +02:00
brizental 824d056d96 Conform UUID metric reference page to new format 
[doc only]
 2021-05-18 18:10:02 +02:00
brizental c3f3153d2e Add Rust and Javascript docs to string metric page 2021-05-18 17:24:53 +02:00
brizental 30c7746e98 Conform string metric reference page to new format 2021-05-18 17:10:22 +02:00
Michael Droettboom aff6566a73
Add "integrating Glean for product managers" (#1598) 
* Add "integrating Glean for product managers"

* Update docs/user/user/integrating-glean-for-product-managers.md

Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>

* Update docs/user/user/integrating-glean-for-product-managers.md

Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>

* Address comments in the PR

Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>
 2021-05-17 14:41:43 -04:00
Beatriz Rizental 31604db5a1
Bug 1698800 - Conform datetime metric reference page to new format (#1611) 
* Add Glean.js information to datetime metric page
* Add missing docs to datetime metric page
* Fix Swift examples
 2021-05-12 10:16:12 +02:00
Jan-Erik Rediger 3629613e61
Merge pull request #1625 from mozilla/event-updated-docs 
Update docs for event metric to conform to new layout
 2021-05-11 10:47:50 +02:00
Jan-Erik Rediger 70bd0f07fe Update docs for event metric to conform to new layout 
[doc only]
 2021-05-11 10:35:22 +02:00
Jan-Erik Rediger d342fd5cbf Upgrade to Chart.js v2.9.4 
Downloaded from https://cdn.jsdelivr.net/npm/chart.js@2.9.4/dist/Chart.min.js

[doc only]
 2021-05-11 10:26:21 +02:00
Alessio Placitelli 2859985a7b
Merge pull request #1624 from Dexterp37/doc_init 
Bug 1706549 - Document that calling Glean.initialize with real values... [doc only]
 2021-05-05 14:49:14 +02:00
Alessio Placitelli 96743550d6
Fix the broken deletion_request link 2021-05-05 14:29:52 +02:00
Alessio Placitelli 9d55137424
Apply suggestions from code review 
Fix the box style references
 2021-05-05 14:13:15 +02:00
Alessio Placitelli 853bf003dd
Fix a typo 2021-05-05 12:34:07 +02:00
Alessio Placitelli 0093a5db2c
Apply suggestions from code review 
Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>
 2021-05-05 12:15:09 +02:00
Alessio Placitelli 268b0ba0e3 Document that calling Glean.initialize with real values... 
... is fundamental and prevents anomalous behaviors.
 2021-05-05 11:49:26 +02:00
Jan-Erik Rediger 6d19bb823d
Merge pull request #1612 from mozilla/missed-a-spot-on-markdown-guidance 2021-05-05 10:08:12 +02:00
Jan-Erik Rediger 0d670fa528
Merge pull request #1620 from mozilla/doc-lang-bindings 
Bug 1708429 - Document the available language bindings
 2021-05-05 09:52:20 +02:00
Jan-Erik Rediger e40c4e7df8 Document the available language bindings 
[doc only]
 2021-05-04 17:15:14 +02:00
Jan-Erik Rediger 1bf066e402 Update generated metric documentation 
Unfortunately there's a left-over "DO NOT COMMIT" in there.
Fix is pending upstream: https://github.com/mozilla/glean_parser/pull/322
 2021-05-04 15:45:56 +02:00
Jan-Erik Rediger 9cce471d98
Merge pull request #1617 from mozilla/1708661-counter-zero 
Bug 1708661 - Counter: Explicitly mention that `0` is not reported
 2021-05-04 14:06:32 +02:00
Jan-Erik Rediger 6702a916d9 Counter: Explicitly mention that `0` is not reported 
[doc only]
 2021-05-04 13:58:57 +02:00
Jan-Erik Rediger 7219a4a7ae Add note on how to disable yamllint if necessary 
[doc only]
 2021-05-04 13:46:54 +02:00
William Lachance d2f10e850e
Update docs/user/user/adding-glean-to-your-project.md 
Co-authored-by: Alessio Placitelli <alessio.placitelli@gmail.com>
 2021-05-03 11:13:00 -04:00
William Lachance 5544732d9f
Update adding-glean-to-your-project.md 2021-05-03 11:09:47 -04:00
William Lachance e61d1741d7
Missed one part where we still recommend generating markdown for Mozilla projects 
See #1604
 2021-05-03 11:08:48 -04:00
William Lachance d89174c250
Update docs to recommend using Glean Dictionary instead of metrics.md (#1604) 2021-04-30 09:05:41 -07:00
Beatriz Rizental 160ba081b7
Bug 1698800 - Conform boolean and counter metric pages to new structure (#1607) 2021-04-30 15:46:05 +02:00
Jan-Erik Rediger 1642abda89
Merge pull request #1593 from chutten/bug1702622-deletionReasons 
bug 1702622 - Add reasons to 'deletion-request' ping r?janerik
 2021-04-30 14:56:45 +02:00
Beatriz Rizental ce6072c514
Mention contribution guidelines section on book README.md (#1606) 
[doc only]
 2021-04-30 14:20:55 +02:00
Beatriz Rizental ca80e769e8
Bug 1708435 - Add a contributions guideline page to Appendix (#1605) 
[doc only]
 2021-04-30 11:09:00 +02:00
Beatriz Rizental cb5a573ff1
Bug 1708204 - Apply new structure to book with minimal content changes (#1601) 2021-04-29 17:05:20 +02:00
Chris H-C 95685448ba bug 1702622 - Add reasons to 'deletion-request' ping r?janerik 2021-04-29 10:24:12 -04:00
Travis Long 56a4079bd1 Add missing TWiG 2021-04-29 09:05:05 -05:00
Jan-Erik Rediger 9c7660173e [doc only] Add today's TWiG 2021-04-16 15:28:12 +02:00
Jan-Erik Rediger 5578c1b567 Instrument timezone offset workaround 
This requires more changes than I'd like,
but recording metrics internally requires a valid `Glean` to be passed around.
Because we use `local_now_with_offset` right when we construct a `Glean` instance,
we need to first finish that and _then_ report it.
In other places we have a `Glean` around and can pass it on.
So we split up the code and do the recording externally when used during
initialization, and internally whenever we can pass in a valid `Glean`.
 2021-04-14 10:00:47 +02:00
Jan-Erik Rediger b1fc82d81c
Merge pull request #1583 from mozilla/disable-jwe 
Bug 1700991 - Remove documentation about JWEs.
 2021-04-14 09:55:47 +02:00
Jan-Erik Rediger 98f90e060e
Merge pull request #1584 from mozilla/labeled-limits 
Bug 1702280 - Document the limit on number of statically-defined labels
 2021-04-14 09:54:58 +02:00
Jan-Erik Rediger 2607adfdf6
Merge pull request #1586 from mozilla/update-glean-parser-and-schemas 2021-04-14 09:54:37 +02:00
Michael Droettboom f22b3e19e0 Update to 2.0.0 glean_parser schemas 2021-04-13 17:49:17 +02:00
Jan-Erik Rediger 6ab5654015 Document the limit on number of statically-defined labels 
The limit was raised in https://github.com/mozilla/glean_parser/pull/297

[doc only]
 2021-04-13 17:29:36 +02:00
William Lachance 8ae671143d
Add a warning about using events (#1582) 
Per discussion today in #glam, we should warn about using events in this document as well (as we do here: https://mozilla.github.io/glean/book/user/adding-new-metrics.html#do-you-need-to-know-the-order-of-events-relative-to-other-events).
 2021-04-13 16:51:53 +02:00
Jan-Erik Rediger 0a083cd98a Remove documentation about JWEs. 
Support is removed from glean_parser in https://github.com/mozilla/glean_parser/pull/310

[doc only]
 2021-04-13 12:00:13 +02:00
Beatriz Rizental 1c08e76050
New TWiG: Publishing Glean.js (#1575) 
* New TWiG: Publishing Glean.js

* Add npm to dictionary

[doc only]
 2021-04-07 13:55:11 -04:00
Michael Droettboom 74150150ae
[doc only] Bug 1703280: Move metric parameter docs to the Glean Book (#1574) 2021-04-07 10:03:20 -04:00
Jan-Erik Rediger 9395cae33d
Merge pull request #1564 from mozilla/1699653-measure-nicety 
Bug 1699653 - Document the convenience function `measure`
 2021-03-22 14:39:56 +01:00
Beatriz Rizental 26b3857980
Bug 1697214 - Clarify source tags documentation about validation (#1563) 2021-03-22 14:15:02 +01:00
Jan-Erik Rediger 36207f27e8 Document the convenience function `measure` 
[doc only]
 2021-03-22 14:14:32 +01:00
Jan-Erik Rediger 33c46add77
Fix link to dev book 2021-03-11 14:05:56 +01:00
Michael Droettboom 730d69ff3b
[doc only] [Bug 1696188] Document adding new metric type to data platform (#1537) 2021-03-08 09:42:36 -05:00
Michael Droettboom e7ab81d9d0
Bug 1690780 - Coverage support (#1482) 
* Bug 1690780: Coverage support

* Fix linkcheck

* Update CHANGELOG.md

Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>

* Add link to user documentation

* Mention codecov.io as the only supported tool

Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>
 2021-03-04 13:15:06 -05:00
Beatriz Rizental 77c225e7f6
Bug 1693489 - Update Glean SDK development and Glean book front page content (#1528) 
[doc only]
 2021-03-04 13:43:41 +01:00
Jan-Erik Rediger 071b7571de
Merge pull request #1530 from mdboom/link-labeled-boolean-docs 
[no bug] Add a link to labeled boolean docs from metrics index
 2021-03-03 10:59:20 +01:00
Michael Droettboom b681d9be33
[doc only] Bug 1694735: Link quantity from counter metric docs (#1531) 2021-03-02 11:59:09 -05:00
Michael Droettboom c58378f26a [no bug] Add a link to labeled boolean docs from metrics index 
This was included in the docs, but not linked from the metrics index page.
 2021-03-02 11:26:42 -05:00
Jan-Erik Rediger 39f922d234 Fix links in the dev book 
[doc only]
 2021-02-26 16:00:55 +01:00
Chris H-C d5004a6416 bug 1694999 - Update payload doc to include "rate" metric 
Also update the payload docs' links to not be broken.
 2021-02-26 09:40:50 -05:00
Chris H-C f01c692341 doc updates per review. 2021-02-25 12:05:19 -05:00
Chris H-C 7457ed72c9 Fixup missed linkcheck 2021-02-25 12:05:19 -05:00
Chris H-C b1a12388de Doc fixes from review comments 2021-02-25 12:05:19 -05:00
Chris H-C 76037b1271 Apply suggestions from code review 
Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>
 2021-02-25 12:05:19 -05:00
Chris H-C 62bc55d362 bug 1645166 - Support rate external denominators 
Rates and Counters are, to the db and to our definitions files, just that:
Rates and Counters.

But to the Language Bindings they can be of a few varieties. Rates can
be RateMetric or NumeratorMetric (for the case of an external denominator).
Counters can be CounterMetric or DenominatorMetric (similarly).

This allows for custom behaviours (CounterMetric can be Labeled,
DenominatorMetric stores its numerators).

Note that Numerator, being a strict subset of Rate, has no Core impl. LBs'
NumeratorMetrics are built atop Core RateMetrics, hiding denominator access.
 2021-02-25 12:05:19 -05:00
Chris H-C 0780f7dcf0 bug 1645166 - Document Rate metric. 
Also update the instructions about how to add a metric.
 2021-02-25 12:05:19 -05:00
Jan-Erik Rediger 6d1fdb2450 New TWiG: Boring Monitoring 
[doc only]
 2021-02-24 15:46:59 +01:00
Jan-Erik Rediger 5d22179f62 Fix link to the dev book 
[doc only]
 2021-02-18 17:55:19 +01:00
Beatriz Rizental ad581e7bd0
Bug 1686670 - Break the book in two: a developer and a user book (#1502) 2021-02-18 16:12:45 +01:00
Michael Droettboom ed1b6d3bcf
Bug 1690088: Use explicitly passed-in buildinfo, if provided (#1495) 
* Upgrade glean_parser to 2.2.0

* Bug 1690088: Use explicitly passed-in buildinfo, if provided
 2021-02-16 11:28:46 -05:00
Jan-Erik Rediger e931a0b43f
Merge pull request #1485 from mozilla/use-xcframeworks 2021-02-10 11:30:02 +01:00
Jan-Erik Rediger 7735132ba5 Docs: Call out that we're using cargo-lipo now 
[doc only]
 2021-02-10 11:24:23 +01:00
Michael Droettboom dfe1f47271
Upgrade to glean_parser 2.0.0 (#1488) 
* Upgrade to glean_parser 2.0.0

* Update metrics docs
 2021-02-08 10:57:01 -05:00
Sebastian Kaspari 9c58a92e1f
Docs: Fix timespan example 2021-02-05 12:34:01 +01:00
Michael Droettboom 124cfae3dd
Bug 1586764: Record the number of pings sent (#1478) 
* WIP: Bug 1586764: Record the number of pings sent

* Update docs

* Fix yamllint

* Update generated docs

* Add comments and make test changes as per PR comments

* Add data review link

* Address documentation comments in the PR

* Update generated metrics docs
 2021-02-04 16:22:44 -05:00
Jan-Erik Rediger 3083ae5d65 Python: Expose the client activity API 2021-02-02 10:59:00 +01:00
William Lachance 54f6dd9855
Go into more detail on metric expiry (#1479) 
* Go into more detail on metric expiry

* Update metric-parameters.md

* Update metric-parameters.md
 2021-02-01 16:28:27 -05:00
Michael Droettboom 41f793b8e4 [doc only] Add TWiG post: The Glean Dictionary 2021-01-29 13:32:23 -05:00
Michael Droettboom 3bc5799c5d
[doc only] Bug 1600006: Mention that the Kotlin testing API req robolectric (#1473) 
* [doc only] Bug 1600006: Mention that the Kotlin testing API req robolectric

* Update spellcheck dictionary
 2021-01-29 12:42:36 -05:00
Chris H-C f03d0898a0
Add Jan 15 TWIG 2021-01-27 14:50:18 -05:00
Alessio Placitelli 86a3eab28e Address review comments 2021-01-27 14:29:17 +01:00
Alessio Placitelli d200c48d4a Use the client activity API in the Kotlin language Bindings 
This additionally moves the logic from the GleanLifecycleObserver
to the Glean.kt file. The logic was spread between the two
files, making it harder than needed to understand what happened
when changing the state.
This additionally fixes the tests.
 2021-01-27 14:29:10 +01:00
Alessio Placitelli a11f6c0259 Rename the "background" reason for the "events" ping 
This additionally updates the docs.
 2021-01-26 18:23:03 +01:00
Alessio Placitelli 9442337687 Rename the baseline ping reasons to inactive/active 
This makes the naming scheme a bit more meaningful
outside of the mobile space. This additionally updates
the documentation.
 2021-01-26 18:23:03 +01:00
Jan-Erik Rediger f560768a44 Update docs on which places in Fenix to modify for a local build 
[doc only]
 2021-01-25 15:09:14 +01:00
Jan-Erik Rediger bebd0090ef Improve documentation on pings 2021-01-25 12:10:35 +01:00
Jan-Erik Rediger 1b606ec5bb Record a new error whenever we fail to write a pending ping to disk 2021-01-15 11:58:46 +01:00
Jan-Erik Rediger daa0e2a47a Update documentation about the different implementations 
[doc only]
 2021-01-13 10:08:42 +01:00
Michael Droettboom 676c3fe53b
Bug 1683707: Add foreground count metric (#1418) 
* Bug 1683707: Add foreground count metric

* Remove extra explicit metrics ping
 2021-01-08 12:38:23 -05:00
Jan-Erik Rediger d32fc8f711 Publish the Rust crates from CI on every release 2021-01-06 17:59:41 +01:00
Beatriz Rizental 89f63c3d14
Have each tab constrain its height based on its own content [doc only] (#1415) 2021-01-06 11:37:23 +01:00
Jan-Erik Rediger 312b2ce74b
Merge pull request #1416 from mdboom/musl-build 2021-01-06 10:46:03 +01:00
Michael Droettboom 9b14fc8072
Bug 1680783: Increase the resolution of first_run_date (#1403) 
* Bug 1680783: Increase the resolution of first_run_date

* Update metrics.md

* Add CHANGELOG

* Make Android tests work

* Update glean-core/src/lib.rs

Co-authored-by: Chris H-C <chutten@users.noreply.github.com>

* Fix typo

* Simplify loop syntax

Co-authored-by: Chris H-C <chutten@users.noreply.github.com>
 2021-01-05 18:18:53 -05:00
Chris H-C 4d152fea69 bug 1680020 - Add C++ and JS docs for existing and incoming metric types 2021-01-05 17:06:35 -05:00
Michael Droettboom 6605e2d4de Add more detail to the docs about non-supported Linux platforms 2021-01-05 16:16:41 -05:00
Jan-Erik Rediger 89f0eef919 Add end-of-year TWiG 
[doc only]
 2020-12-18 17:10:26 +01:00
Alessio Placitelli 4430ac02ed Apply suggestions from code review 
Co-authored-by: Jan-Erik Rediger <badboy@archlinux.us>
 2020-12-15 18:13:55 +01:00
Alessio Placitelli 9220c62bc2 Update the docs 2020-12-15 18:13:27 +01:00
Chris H-C 16847b76e8 bug 1677456 - Timing Distribution Impl for RLB 2020-12-15 11:59:00 -05:00
Chris H-C d4d10b409b bug 1677447 - Implement Custom Distribution in the RLB 2020-12-15 11:59:00 -05:00
Jan-Erik Rediger 166b706bda Document that timespan doesn't overwrite and records `InvalidState` 2020-12-14 17:15:49 +01:00
Alessio Placitelli e5dd9643d8
Merge pull request #1384 from Dexterp37/rlb_datetime 
Bug 1677448 - Implement the datetime metric in the RLB
 2020-12-14 15:50:56 +01:00
Jan-Erik Rediger af10dd64f8
Update debug ping view URL 2020-12-14 14:46:11 +01:00
Alessio Placitelli f793b66e6b Update the docs 2020-12-14 11:22:33 +01:00
Michael Droettboom 555dbc1ad0
Bug 1677454: Implement the string list type in the RLB (#1380) 
* Bug 1677454: Implement the string list type in the RLB

* Test and fix up doc examples
 2020-12-11 09:38:38 -05:00
Michael Droettboom 141ae1da58
[doc only] Fix typo in memory distribution RLB doc example (#1381) 2020-12-10 15:25:16 -05:00
Chris H-C 5dc3b9690d Bug 1677451 - Implement Memory Distribution in the RLB 2020-12-09 13:56:46 -05:00
Jan-Erik Rediger 17633dca90
Merge pull request #1296 from brizental/1673392-log-levels 2020-12-09 14:46:39 +01:00
Michael Droettboom 2144da2021 Bug 1680015: Rationalize Python logging (as much as possible) 2020-12-09 14:41:04 +01:00
Jan-Erik Rediger 81b9afba40 Apply suggestions from code review 
[doc only]

Co-authored-by: Alessio Placitelli <alessio.placitelli@gmail.com>
 2020-12-07 12:47:51 +01:00
Jan-Erik Rediger 46639b8fac Add missing API doc links for events 2020-12-07 12:47:51 +01:00
Jan-Erik Rediger 876f16aea3 Use the right error type in examples for events 2020-12-07 12:47:50 +01:00
Jan-Erik Rediger 794f3de8e5 Implement the nice Rust API for events 2020-12-07 12:47:49 +01:00
Jan-Erik Rediger 5edad6496c Document Rust API for timespan 
[doc only]
 2020-12-02 12:17:22 +01:00
Jan-Erik Rediger 417b0653be
Merge pull request #1346 from mozilla/label-docs-invalid-other 
Bug 1677807 - Document that invalid labels result in recordings going to the `__other__` label
 2020-12-01 15:17:17 +01:00
Chris H-C fbbbe4ceae
Update twig.md 2020-12-01 09:15:46 -05:00
Chris H-C 90e3260e6e
Update twig.md 2020-12-01 09:15:00 -05:00
Jan-Erik Rediger f5b9cef851 Document that invalid labels result in recordings going to the `__other__` label 
[doc only]
 2020-12-01 15:02:28 +01:00
Michael Droettboom 836b196df5
Bug 1677453: Implement the Quantity type in the RLB (#1334) 
* Bug 1677453: Implement the Quantity type in the RLB

* Bug 1678634: Add API docs links

* Add dispatcher::block_on_queue()
 2020-11-30 17:08:19 -05:00
Michael Droettboom d13410ccc5
1678151: Record an error if UUID is invalid (affects only Python) (#1328) 
* 1678151: Record an error if UUID is invalid (affects only Python)

* Remove dead_code annotation
 2020-11-20 14:21:12 -05:00
Michael Droettboom 388b3e5ea4
Bug 1678635: Link from metrics pages to RLB API docs (#1335) 2020-11-20 13:47:52 -05:00
Alessio Placitelli 84048439b2 Add a changelog entry and update the docs 2020-11-20 18:12:49 +01:00
Chris H-C 50d2738ad5 bug 1677457 - Implement the UUID type in the RLB 2020-11-20 10:53:27 -05:00
Michael Droettboom fe55e7ff99
Add missing `div` for Java API in Quantity docs (#1332) 2020-11-20 09:56:17 -05:00
Alessio Placitelli f3cb3ac211 Fix a typo in the Counter metric type docs 2020-11-16 11:13:29 +01:00
Alessio Placitelli 6e923150d8 Add documentation 2020-11-13 19:35:53 +01:00
brizental a760d2357e Attend to review comments 2020-11-11 10:24:05 +01:00
Jan-Erik Rediger 2154e376f5
Merge pull request #1308 from mdboom/doc-automation-tag 
Bug 1672466: Document the automation sourceTag in generic debugging docs

[doc only]
 2020-11-10 10:33:55 +01:00
Michael Droettboom 94c2fe384c
[doc only] Remove obsolete note that quantity metrics are GeckoView-only (#1306) 2020-11-09 11:03:01 -05:00
Michael Droettboom 9961feb865
[doc only] Bug 1675792: Document that payload format is implementation (#1305) 
* [doc only] Bug 1675792: Document that payload format is implementation

* [doc only] Add note that applies to whole chapter
 2020-11-09 11:02:37 -05:00
Michael Droettboom b3e8496007
[doc only] Bug 1671621: Talk about write-only metric APIs (#1307) 2020-11-09 09:13:31 -05:00
Michael Droettboom c0765e8b84 Bug 1672466: Document the automation sourceTag in generic debugging docs 2020-11-06 18:17:07 -05:00
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
brizental 54552dc5d2 Add Rust log level guidelines to the book 
[doc only]
 2020-11-03 14:18:19 +01:00
Alessio Placitelli dfaa01a76c
Merge pull request #1287 from Dexterp37/rlb_bool_test_pingname 
Bug 1672990 - Make the ping name optional in the RLB testing APIs
 2020-11-03 13:50:10 +01:00
Beatriz Rizental e609819533
Update TWiG index with Glean.js blog post (#1293) 
[doc only]
 2020-11-03 10:09:36 +01:00
Jan-Erik Rediger 972d6dbc89
Merge pull request #1289 from fbertsch/bug_template_update 
Update bug template; require bugs for libraries

[doc only]
 2020-11-02 15:47:32 +01:00
William Lachance ec669ee423 Add a table of contents to the "adding new metrics" page 
This also changes some of the headings which were at the
wrong level (not really visible unless you have a toc).
 2020-10-28 12:09:11 -05:00
Frank Bertsch 2d300c139f Update bug template; require bugs for libraries 2020-10-28 12:07:59 -04:00
Alessio Placitelli 8aa7b068a4 Fixup the RLB BooleanMetric test API 
This allows the ping name for the boolean metric testing
API to be optional. If not provided, it will fall back to
the name of the first ping specified in `send_in_pings`.
 2020-10-28 12:08:40 +01:00
Jan-Erik Rediger 548b1ae9de
Merge pull request #1285 from mozilla/document-megazord 2020-10-28 10:09:49 +01:00
Alessio Placitelli b26dc61eb1 Bug 1664501 - Add better docs for special pings 
This adds better internal documentation and references
with respect to special ping names inside SDK-owned
registry files.
 2020-10-27 12:33:59 +01:00
Jan-Erik Rediger 3c1b53d19f Document how to use the iOS megazord 
[doc only]
 2020-10-27 11:05:47 +01:00
Jan-Erik Rediger 3e231a46c5 Call out to update the megazord 2020-10-27 11:05:46 +01:00
Alessio Placitelli 5a34deb783 Add documentation for the RLB 'BooleanMetric' 2020-10-22 16:02:02 +02:00
Jan-Erik Rediger a32e4cbd12
Merge pull request #1269 from mozilla/mdboom-patch-2 
Clarify when Glean.initialize must be called

[doc only]
 2020-10-22 14:13:57 +02:00
Travis Long a695d20629 Add latest TWiG 2020-10-21 09:43:00 -05:00
Alessio Placitelli b5f287c188 Update the "cut a new release" docs 2020-10-20 17:35:40 +02:00
Michael Droettboom a1bc8e25cb
Clarify when Glean.initialize must be called 2020-10-19 15:25:54 -04:00
Michael Droettboom 02b67f6831
[doc only] Remove "documentation documentation" (#1263) 2020-10-16 15:22:05 -04:00
Jan-Erik Rediger 1914bd1c07
Merge pull request #1257 from mdboom/document-metrics-and-events 2020-10-12 09:39:39 +02:00
Jan-Erik Rediger b9572bf212
Merge pull request #1255 from mdboom/memory-distribution-note 2020-10-12 09:39:04 +02:00
Jan-Erik Rediger f8713ca37b
Merge pull request #1256 from mdboom/timing-distribution-examples 
[doc only] Bug 1620939: Timing distributions record / test should match
 2020-10-12 09:38:33 +02:00
Michael Droettboom bff29bb762
Update docs/user/pings/index.md 
Co-authored-by: Chris H-C <chutten@users.noreply.github.com>
 2020-10-09 20:24:41 -04:00
Michael Droettboom 46edfaaec8
Update docs/user/pings/index.md 
Co-authored-by: Chris H-C <chutten@users.noreply.github.com>
 2020-10-09 20:24:18 -04:00
Michael Droettboom fc75395be3 Clean up grammar 2020-10-09 14:56:41 -04:00
Michael Droettboom 98aa3e0763 Fix link 2020-10-09 14:51:51 -04:00
Michael Droettboom 2c08fdf3b6 [doc only] Bug 1635377: Document metrics and events sections 
Also reorganizes document to describe experiments as a subsection of ping_info
 2020-10-09 14:42:33 -04:00
Michael Droettboom 89c27cf3a9
[doc only] Bug 1637661: Document category and name lengths (#1254) 2020-10-09 13:19:35 -04:00
Michael Droettboom 31b0a03342 [doc only] Bug 1620939: Timing distributions record / test should match 2020-10-09 12:38:10 -04:00
Michael Droettboom 64cb0e829a [doc only] Bug 1667825: Move note about input unit near API 2020-10-09 12:16:15 -04:00
Jan-Erik Rediger c5e1bdc576 Test that events in custom pings are flushed at startup. 
This also specifically points out in the docs that pings need to be
registered before initialization for this to work.
 2020-10-09 15:16:27 +02:00
Jan-Erik Rediger ac8353e4a1 Add newest TWiG 
[doc only]
 2020-10-06 17:00:49 +02:00
Jan-Erik Rediger 077b64a4f7 Document the pending ping file format 
[doc only]
 2020-10-06 14:24:46 +02:00
Jan-Erik Rediger 2595fccc10
Merge pull request #1238 from mozilla/new-mdbook-layout 2020-09-29 14:55:12 +02:00
Beatriz Rizental 628c4bec4a
Add a default transformation function to simulators code (#1237) 2020-09-29 13:41:19 +02:00
Jan-Erik Rediger 77af367d95 Split book into more explicit groups 
This results in some renumbering of the chapters, but overall gives a
better structure.
 2020-09-29 13:37:16 +02:00
Jan-Erik Rediger 5d2f1f780f
Merge pull request #1230 from mozilla/document-ci-full 
Document the special ci-full behavior
 2020-09-28 09:51:19 +02:00
Beatriz Rizental 65cd65f89a
Update TWiG index with "glean-core to Wasm experiment" blog post (#1231) 
* Update twig.md

* Add "Wasm" to .dictionary
 2020-09-25 12:00:29 -04:00
Jan-Erik Rediger b894c06b3e Document the special ci-full behavior 
[doc only]
 2020-09-25 09:41:50 +02:00
Alessio Placitelli 7633c3c721 Fix a typo in the docs 2020-09-22 14:21:32 +02:00
Alessio Placitelli 2731c7c5f1 Add a reference on local publishing for testing in A-C 
This is needed since the substitution approach won't work
for plugins.
 2020-09-22 14:21:20 +02:00
Jan-Erik Rediger db0d4ade2d Track the total number of pending pings at startup 
This introduces a new metric to do so.
 2020-09-17 16:43:17 +02:00
Jan-Erik Rediger 6f666a8b21 Document storage limitations based on number of pending pings 
[doc only]
 2020-09-17 16:43:17 +02:00
Jan-Erik Rediger 8d602d406c
Merge pull request #1215 from mozilla/errors-in-docs 2020-09-16 09:28:25 +02:00
Chris H-C d6887cb2c5 bug 1664306 - Update the checked-in metrics docs 2020-09-15 16:42:56 -04:00
Jan-Erik Rediger c0aecb553b Fill in correct version number when the error label was changed 
[doc only]
 2020-09-15 16:01:28 +02:00
Jan-Erik Rediger e543764792 Update error reporting example with correct error label 
[doc only]
 2020-09-15 15:58:06 +02:00
Beatriz Rizental ccf91a74dc
Bug 1658349 - Allow using the quantity metric type outside of Gecko (#1198) 2020-09-14 13:54:24 +02:00
Michael Droettboom 10e0d0d781
[doc only] Improve docs about what is recorded in an event. (#1207) 2020-09-11 09:37:26 -04:00
Michael Droettboom 4619da778b
1660120: Make Python bindings installable from source (#1203) 
* 1660120: Make Python bindings installable from source

* Add CHANGELOG

* Improve variable names

* Address comments in PR

* Update docs
 2020-09-09 11:01:39 -04:00
Alessio Placitelli 2322a5efae Mention ABI splits for Android projects 2020-09-08 18:33:57 +02:00
Alessio Placitelli e2d5ad83db Make the "enabling app id" requirement more visible 2020-09-08 18:17:13 +02:00
Alessio Placitelli 0f73cf90e7
Merge pull request #1199 from wlach/patch-5 
Add description field to "enable my glean application" bug template
 2020-09-08 11:05:23 +02:00
Alessio Placitelli a28b17c4bb Add an initial feature matrix 2020-09-07 10:18:54 +02:00
William Lachance 3252bf2754
Add description field to "enable my glean application" bug template 
See mozilla/probe-scraper#220
 2020-09-02 16:37:14 -04:00
Jan-Erik Rediger 45b829ddb4
Merge pull request #1178 from mozilla/dep-docs 
Document dependency updates for Rust deps
 2020-09-01 14:54:43 +02:00
Jan-Erik Rediger d4fe5750bb Add missign Twigs 
[doc only]
 2020-09-01 14:41:38 +02:00
Jan-Erik Rediger b01284569e Document dependency updates for Rust deps 
[doc only]
 2020-08-26 16:49:31 +02:00
Jan-Erik Rediger d956dbd015 Track the database size on initialization 2020-08-26 13:27:21 +02:00
Jan-Erik Rediger ad881c26ce Docs: Remove trailing whitespace 
[doc only]
 2020-08-24 14:08:08 +02:00
Jan-Erik Rediger 0ba835f173
Merge pull request #1164 from mozilla/no-more-format 
Don't require swiftformat to run anymore
 2020-08-24 13:38:31 +02:00
Jan-Erik Rediger 9370cf9d55 Don't require swiftformat to run anymore 
This was previously already removed from CI,
but we missed to remove the make task and documentation.

[doc only]
 2020-08-24 12:56:15 +02:00
Beatriz Rizental c459dd5a6a
Bug 1657112 - Add rust docs guidelines to the book and fix some consistency issues in the current docs (#1162) 2020-08-21 16:46:22 +02:00
Beatriz Rizental eda8c4c686
Bug 1654384 - Add a specific simulator to each of the distributions metrics on the book (#1150) 2020-08-19 10:19:43 +02:00
Jan-Erik Rediger 15bd281d3a
Merge pull request #1157 from mozilla/ci-setup 2020-08-19 09:29:04 +02:00
Jan-Erik Rediger d0149a5ac6
Merge pull request #1151 from mozilla/os-log 2020-08-19 09:28:43 +02:00
Jan-Erik Rediger d9896b838f Docs: Call out how to find the TaskCluster tasks 2020-08-18 13:33:58 +02:00
Jan-Erik Rediger a573385b99 Update docs to use the right link-checker 
[doc only]
 2020-08-18 10:48:02 +02:00
Jan-Erik Rediger 8a843aebf4 Re-order chapters 
Keep the most important ones first.

[doc only]
 2020-08-18 10:48:02 +02:00
Jan-Erik Rediger cdc87e1bd9 Document our CI setup 
[doc only]
 2020-08-18 10:48:02 +02:00
Michael Droettboom ccb6b163e5
Increase rate limiter to 15 pings per minute. (#1154) 
* Increase rate limiter to 15 pings per minute

* Update docs.
 2020-08-17 14:57:10 -04:00
Jan-Erik Rediger 7979515d1c Document how to access the Glean logs 
[doc only]
 2020-08-14 15:43:44 +02:00
Michael Droettboom 07f5210ae7
Bug 1657908: Use a better link checker in CI and fix links (#1146) 
* Bug 1657908: Use a better link checker in CI and fix links

The Python-based linkchecker had buggy checking of anchors within pages,
which has caused a number of our internal doc links to break.

This replaces it with a different link checking tool, and then corrects
all of the errors it found.

* sudo make me a sandwich

* Combine lines
 2020-08-10 08:15:49 -04:00
Alessio Placitelli 6db50e0411 Update the changelog and user docs for the C# experiments API 2020-08-07 18:37:02 +02:00
Beatriz Rizental e697751e18
Bug 1601550 - Enforce disk quota on pending pings directory (#1110) 2020-08-07 11:44:01 +02:00
Jan-Erik Rediger a2329debee
Merge pull request #1137 from mdboom/integration-checklist 
[doc only] Bug 1657598: Add Glean integration checklist
 2020-08-07 10:31:16 +02:00
Michael Droettboom 4cf4814b09 [doc only] Bug 1657598: Add Glean integration checklist 2020-08-06 10:00:21 -04:00
Michael Droettboom 76881c7fe5 Bug 1634626: Python: Add measure context manager 2020-08-06 09:19:56 -04:00
Alessio Placitelli e42be65caf Add user docs and update the changelog 2020-08-05 22:12:29 +02:00
Alessio Placitelli 3d776b09d4 Add user docs for the C# event metric type 
This additionally updates the changelog
 2020-08-05 12:10:04 +02:00
Michael Droettboom 8d0fa57eab
Bug 1651662: Support installing glean_parser in offline mode (#1065) 
* Bug 1651662: Support installing glean_parser in offline mode

Co-authored-by: Alessio Placitelli <alessio.placitelli@gmail.com>

* spellcheck

Co-authored-by: Alessio Placitelli <alessio.placitelli@gmail.com>
 2020-08-04 12:19:05 -04:00
Michael Droettboom 26a9a1adb9
Bug 1656580: Python: Remove glinter from load_metrics (#1124) 2020-08-04 12:00:05 -04:00
Alessio Placitelli 387ab68a8b Update the changelog and add user docs for the C# integration 2020-08-04 10:23:07 +02:00
Alessio Placitelli 5db6f8e91c
Merge pull request #1108 from daoshengmu/cSharpStringList 
Bug 1648441 - Implement string list in C#
 2020-08-04 10:15:06 +02:00
Michael Droettboom df96612f72
Bug 1655481, Bug 1655760: Add glean_parser version update script (#1116) 
* Bug 1655481, Bug 1655760: Add glean_parser version update script

Also, check the glean_parser version at runtime from the Python bindings.

* pythonlint

* Add docs

* Add __init__.py

* mypy fix
 2020-08-03 18:51:34 -04:00
Daosheng Mu a53558dac1 Update StringListMetricType documentation. 2020-08-03 15:20:33 -07:00
Michael Droettboom 45b8619062
[doc only] Bug 1589116: Remove old debug activity classpath (#1115) 
This has existed at the new name for 6 months, so fine to remove it now
 2020-08-03 10:10:06 -04:00
Jan-Erik Rediger 8c36947624
Merge pull request #1118 from mozilla/disable-swiftformat 
Bug 1656443 - CI: Don't run swiftformat
 2020-08-03 15:11:21 +02:00
Alessio Placitelli aac3839535 Require activities executed via `GleanDebugView` to be exported 
See bug 1656778 for additional context.
 2020-08-03 12:08:12 +02:00
Jan-Erik Rediger 36753eb2a4 CI: Don't run swiftformat 
[doc only]
 2020-08-03 12:00:03 +02:00
Alessio Placitelli 3e845b2b15
Merge pull request #1111 from Dexterp37/csharp_memory_distributio 
Bug 1648439 - Add the MemoryDistributionMetricType to C#
 2020-08-03 10:24:10 +02:00
Raphael Pierzina d10dc73eaf
Add @hackebrot's TWiG post about burnham (#1109) 2020-07-30 13:19:29 -04:00
Alessio Placitelli 2fee6e6798 Add usage docs for the C# memory distribution metric type 2020-07-30 17:42:20 +02:00
Michael Droettboom 388f78be19
1641148: Integrate Python and Rust logging (#1052) 
* 1641148: Integrate Python and Rust logging

This works by setting up a named pipe between Python and Rust logging.

This requires adding another thread to the Python side to read from the log.
The overhead of that *could* be problematic.

I have no idea if this approach will work on Windows.

This at least *does* work -- any callback-based approach has been ruled
out due to limitations of CFFI or the need to go to a compiling-against-
a-specific-version-of-Python approach (see details in bug).

* hangle -> handle

* Rename and better document function
 2020-07-29 14:22:23 -04:00
Beatriz Rizental 218ff33ed6
Bug 1597761 - Don't create PingRequest if body exceeds 1MB (#1098) 2020-07-29 12:27:10 +02:00