Document labeled metrics types as separate individual types (bug 1553445) [ci skip] #3273
Conversation
|
I'd like to get a first set of eyes on it, there are some clearly marked TODOs in it still.
|
georgf
changed the title
|
@georgf can you kindly file a bug for backporting these changes to glean-core? |
As I've brought docs over to glean-core, I've been very careful in the user docs to make sure it applies equally to glean-ac and glean-core. So at some point, maybe even before the code migration, we can probably replace all the docs in glean-ac with a link to the glean-core docs. |
|
This is up for review now. |
| @@ -80,15 +80,27 @@ Views.loginOpened... | |||
| There are different metrics to choose from, depending on what you want to achieve: | |||
|
|
|||
| * [Events](#Events): Records events e.g. individual occurences of user actions, say every time a view was open and from where. | |||
There was a problem hiding this comment.
I'm not sure where it should fit, but I now realize that we really want to express our opinion with respect to metric names: maybe we should explain why events.button_event isn't a good naming scheme (e.g. event is redundant as a category name and button_event doesn't really explain what the event is about). Any chance you can tackle this here on file a follow-up for it?
There was a problem hiding this comment.
That sounds orthogonal to the PR here.
Can you file a follow-up on what your intent there is @Dexterp37 ?
There was a problem hiding this comment.
This makes them easier to explain and reason about them.
See mozilla-mobile/android-components#3273 for the original changes to glean-ac.
See mozilla-mobile/android-components#3273 for the original changes to glean-ac.
See mozilla-mobile/android-components#3273 for the original changes to glean-ac.
This clearly calls out the labeled metric types as separate, individual types in the documentation.
Pull Request checklist