зеркало из https://github.com/mozilla/gecko-dev.git
Bug 1648959 - Done internal linking in docs in toolkit Directory,DONTBUILD.r=championshuttler
Differential Revision: https://phabricator.services.mozilla.com/D81464
This commit is contained in:
Родитель
9f398ab019
Коммит
9455a91500
|
@ -122,21 +122,18 @@ reported under the key ``normandy/recipe/<recipe id>``:
|
|||
Normandy failed to verify the signature of the recipe.
|
||||
|
||||
|
||||
Additionally, Normandy reports a `keyed scalar`_ to measure recipe
|
||||
Additionally, Normandy reports a :ref:`keyed scalar <Scalars>` to measure recipe
|
||||
freshness. This scalar is called ``normandy.recipe_freshness``, and it
|
||||
corresponds to the ``last_modified`` date of each recipe (using its ID
|
||||
as the key), reported as seconds since 1970 in UTC.
|
||||
|
||||
.. _keyed scalar: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/scalars.html
|
||||
|
||||
|
||||
Enrollment
|
||||
-----------
|
||||
Normandy records enrollment and unenrollment of users into studies, and
|
||||
records that data using `Telemetry Events`_. All data is stored in the
|
||||
records that data using :ref:`Telemetry Events <eventtelemetry>`. All data is stored in the
|
||||
``normandy`` category.
|
||||
|
||||
.. _Telemetry Events: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/events.html
|
||||
|
||||
Enrollment IDs
|
||||
^^^^^^^^^^^^^^
|
||||
|
|
|
@ -230,6 +230,8 @@ Optional. This is one of:
|
|||
|
||||
Every new or changed data collection in Firefox needs a `data collection review <https://wiki.mozilla.org/Firefox/Data_Collection>`__ from a Data Steward.
|
||||
|
||||
.. _histogram-products:
|
||||
|
||||
``products``
|
||||
-------------
|
||||
Required. This field is a list of products this histogram can be recorded on. Currently-supported values are:
|
||||
|
|
|
@ -84,6 +84,9 @@ Example:
|
|||
// Now scalars can be recorded.
|
||||
Services.telemetry.scalarSet("myAddon.category.counter_scalar", 37);
|
||||
|
||||
|
||||
.. _scalars-c++-API:
|
||||
|
||||
C++ API
|
||||
-------
|
||||
Probes in native code can use the more convenient helper functions declared in `Telemetry.h <https://dxr.mozilla.org/mozilla-central/source/toolkit/components/telemetry/core/Telemetry.h>`_:
|
||||
|
@ -151,6 +154,8 @@ A probe can be defined as follows:
|
|||
notification_emails:
|
||||
- telemetry-client-dev@mozilla.com
|
||||
|
||||
.. _scalars-required-fields:
|
||||
|
||||
Required Fields
|
||||
---------------
|
||||
|
||||
|
@ -193,7 +198,7 @@ String type restrictions
|
|||
To prevent abuses, the content of a string scalar is limited to 50 characters in length. Trying
|
||||
to set a longer string will result in an error and no string being set.
|
||||
|
||||
.. _scalars.keyed-scalars:
|
||||
.. _scalars-keyed-scalars:
|
||||
|
||||
Keyed Scalars
|
||||
-------------
|
||||
|
|
|
@ -80,7 +80,7 @@ Considerations for all changes
|
|||
|
||||
- Does this need documentation updates?
|
||||
|
||||
- To the `in-tree docs <https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/>`_?
|
||||
- To the :ref:`in-tree docs <Telemetry>`?
|
||||
- To the `firefox-data-docs <https://docs.telemetry.mozilla.org/>`_ (`repository <https://github.com/mozilla/firefox-data-docs>`_)?
|
||||
- To the `glean documentation <https://github.com/mozilla-mobile/android-components/tree/master/components/service/glean>`_?
|
||||
|
||||
|
|
|
@ -24,7 +24,7 @@ Exfiltrating existing histograms is a relatively straightforward process made up
|
|||
Tag histograms in ``Histograms.json``
|
||||
-------------------------------------
|
||||
Accumulations to non-tagged histograms are ignored if streaming Telemetry is enabled.
|
||||
To tag a histogram you must add the `geckoview_streaming` product to the `products list <https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/histograms.html#products>`__ in the `Histograms.json file <https://hg.mozilla.org/mozilla-central/file/tip/toolkit/components/telemetry/Histograms.json>`__ .
|
||||
To tag a histogram you must add the `geckoview_streaming` product to the :ref:`products list <histogram-products>` in the `Histograms.json file <https://hg.mozilla.org/mozilla-central/file/tip/toolkit/components/telemetry/Histograms.json>`__ .
|
||||
|
||||
Add Glean metrics to ``metrics.yaml``
|
||||
-------------------------------------
|
||||
|
@ -161,7 +161,7 @@ Exfiltrating existing boolean, string or uint scalars, or adding new ones, is a
|
|||
Tag scalars in ``Scalars.yaml``
|
||||
----------------------------------
|
||||
Accumulations to non-tagged scalars are ignored if streaming Telemetry is enabled.
|
||||
To tag a scalar you must add the `geckoview_streaming` product to the `products list <https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/collection/scalars.html#required-fields>`__ in the `Scalars.yaml file <https://hg.mozilla.org/mozilla-central/file/tip/toolkit/components/telemetry/Scalars.yaml>`__ .
|
||||
To tag a scalar you must add the `geckoview_streaming` product to the :ref:`products list <scalars-required-fields>` in the `Scalars.yaml file <https://hg.mozilla.org/mozilla-central/file/tip/toolkit/components/telemetry/Scalars.yaml>`__ .
|
||||
|
||||
Add Glean metrics to ``metrics.yaml``
|
||||
-------------------------------------
|
||||
|
@ -254,6 +254,6 @@ Unsupported features
|
|||
====================
|
||||
This is the list of the currently unsupported features:
|
||||
|
||||
* `keyed scalars <https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/collection/scalars.html#keyed-scalars>`__ are not supported and there are no future plans for supporting them;
|
||||
* uint scalar operations other than `set <https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/collection/scalars.html#id2>`__ are not supported and there are no future plans for supporting them.
|
||||
* `events <https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/collection/events.html>`__ are not supported and there are no future plans for supporting them.
|
||||
* :ref:`keyed scalars <scalars-keyed-scalars>` are not supported and there are no future plans for supporting them;
|
||||
* uint scalar operations other than :ref:`set <scalars-c++-API>` are not supported and there are no future plans for supporting them.
|
||||
* :ref:`events <eventtelemetry>` are not supported and there are no future plans for supporting them.
|
||||
|
|
Загрузка…
Ссылка в новой задаче