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

639 Коммитов

Автор SHA1 Сообщение Дата
Jan-Erik Rediger dd2cd46190 Reference an actual alphabet for the ping name constraints 
The same wording is used on https://docs.telemetry.mozilla.org/cookbooks/new_ping.html
 2019-12-19 15:29:25 +01:00
Jan-Erik Rediger a9c399cd87 Document the limits for ping names 2019-12-19 11:59:14 +01:00
Jan-Erik Rediger aff57407c4 Call out the new ping 2019-12-19 11:59:14 +01:00
Jan-Erik Rediger 0f8061ee32 Prepare documentation for Swift/Python example code 2019-12-19 11:59:14 +01:00
Jan-Erik Rediger 14585b39e9 Use dashes in custom ping shown in examples 2019-12-19 11:35:36 +01:00
Jan-Erik Rediger b80aba7c6d Add missing Swift example for custom pings 2019-12-19 11:34:05 +01:00
Jan-Erik Rediger 81547170a9
Choose a random port in the UI tests (#588) 
Choose a random port in the UI tests
 2019-12-17 16:47:35 +01:00
Jan-Erik Rediger b49bba04d5 Add missing anchor 2019-12-17 16:32:34 +01:00
Jan-Erik Rediger 4bfa09e474
Split out control API into its own chapter (#584) 
Split out control API into its own chapter
 2019-12-17 16:26:09 +01:00
Alessio Placitelli 193a8a252b
Merge pull request #587 from Dexterp37/release_docs_update 
Clarify the release docs
 2019-12-17 16:02:45 +01:00
Jan-Erik Rediger a4d504eda7 Rename the file 
[doc only]
 2019-12-17 15:42:36 +01:00
Jan-Erik Rediger 6a5b39a9cc
Update docs/user/control-api.md 
Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>
 2019-12-17 15:42:32 +01:00
Alessio Placitelli 544bb50047 Clarify the release docs 2019-12-17 15:18:16 +01:00
Jan-Erik Rediger d445ca998f Add note about login requirement 2019-12-17 15:05:45 +01:00
Jan-Erik Rediger 7fb710463f Use a relative link 
mdbook doesn't play nice with absolute links
 2019-12-17 15:02:27 +01:00
Jan-Erik Rediger 11fd84a0d0
Apply suggestions from code review 
Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>
 2019-12-17 14:50:57 +01:00
Jan-Erik Rediger ba372e59a5 List out the available API 
[doc only]
 2019-12-17 11:57:29 +01:00
Jan-Erik Rediger 272822b27a Move metrics codegen section to match other languages 
[doc only]
 2019-12-17 11:45:51 +01:00
Jan-Erik Rediger 4cce68d4e8 Split out control API into its own chapter 
[doc only]
 2019-12-17 11:45:50 +01:00
Jan-Erik Rediger 48a14f3f73 Document debug pings and the HTTP header 
[doc only]
 2019-12-17 11:30:45 +01:00
Jan-Erik Rediger 21ac13655b
Merge pull request #578 from mozilla/platform-specific-debugging 
Platform specific debugging
 2019-12-17 10:37:13 +01:00
Alessio Placitelli 4295386b2b
Merge pull request #571 from Dexterp37/timing_distribution_overflow 
Introduce the `InvalidOverflow` error
 2019-12-16 18:41:05 +01:00
Alessio Placitelli f68d464f74 Update the metrics files and the docs 
This also adds a small note in the
Rust code to mention that all these
things need to be updated.
 2019-12-16 18:11:30 +01:00
Jan-Erik Rediger dbeaf3e6fe
Update docs/user/adding-glean-to-your-project.md 
Co-Authored-By: Michael Droettboom <mdboom@gmail.com>
 2019-12-16 18:07:57 +01:00
Jan-Erik Rediger 37cc67d451 Indicate that registering a new product requires a bug filed 
[doc only]
 2019-12-16 17:54:59 +01:00
Alessio Placitelli 072569b177 Update the docs 2019-12-16 17:54:52 +01:00
Jan-Erik Rediger a6ba0f7a70 Word change to indicate it's debugging the usage of Glean 2019-12-16 17:50:43 +01:00
Jan-Erik Rediger b134f533e8 Document general commands for debugging 2019-12-16 17:47:57 +01:00
Jan-Erik Rediger a265a70ed8 Split debugging chapter into Android and iOS parts 2019-12-16 17:45:06 +01:00
Michael Droettboom efd231968a
1583514: Rename send -> submit (#570) 
* 1583514: Rename send -> submit

* detekt

* Add additional missed changes

* Run cbindgen

* Add more missing changes

* Rename local variable

* Fix after rebase
 2019-12-16 19:20:05 +05:30
Jan-Erik Rediger cc4bc7952c Rename `deletion_request` ping to `deletion-request` ping 2019-12-13 11:50:30 +01:00
Jan-Erik Rediger a29cf80cba Use all-pings everywhere 2019-12-13 11:42:45 +01:00
Jan-Erik Rediger 5f77fac09c Update glean_parser 2019-12-13 11:42:45 +01:00
Michael Droettboom 9f667c7b99
1602786: Remove *_ping_count metrics (#564) 2019-12-11 19:13:15 +05:30
Travis Long ca574acedb Bug 1586736 - Add Glean iOS debug functionality 
This adds the custom URL handling to provide the Glean debug functionality.  This also adds the functionality to the glean-sample-app and the documentation on how to add and use this in a consuming application.
 2019-12-10 09:08:30 -06:00
Jan-Erik Rediger 64a36a4838 Document how to add Glean to an iOS project 2019-12-10 10:42:04 +01:00
Michael Droettboom b71a9ceb84
1592006: Implement events for Python bindings (#553) 
* 1592006: Implement events for Python bindings

* Update type of function

* Add CHANGELOG
 2019-12-09 20:46:13 +05:30
Jan-Erik Rediger ec66257b7c
Merge pull request #555 from mdboom/update-string-length-docs 
Update string length docs
 2019-12-09 13:32:29 +01:00
Beatriz Rizental 92fb5e5def
Add new blog post 2019-12-06 22:45:08 +01:00
Michael Droettboom d78226cafe [skip ci] Remove documentation about Kotlin string truncation 2019-12-06 11:49:59 -05:00
Jan-Erik Rediger ce75dc2932 Document send_if_empty for pings 
[doc only]
 2019-12-06 12:27:01 +01:00
Jan-Erik Rediger 7b74c57ce5 Link deletion_request ping from overview 2019-12-06 12:22:45 +01:00
Jan-Erik Rediger 3229c2a11d
Update docs/user/pings/deletion_request.md 
[doc only]

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>
 2019-12-06 11:49:03 +01:00
Jan-Erik Rediger 690646d0fd Document deletion_request ping 
[doc only]
 2019-12-06 11:39:32 +01:00
Jan-Erik Rediger 6662471941 Regenerate auto-documentation from pings.yaml 2019-12-06 11:34:06 +01:00
Jan-Erik Rediger 9a8413d5b3
Implement the deletion request ping in Glean (#526) 
Implement the deletion request ping in Glean
 2019-12-03 10:09:25 +01:00
Alessio Placitelli b7390e8db1
Merge pull request #533 from Dexterp37/force_close_metric 
Count the number of times a Glean product was force-closed
 2019-12-02 16:11:12 +01:00
Alessio Placitelli ef8f22ba56 Link to the data-review response 2019-12-02 15:59:00 +01:00
Jan-Erik Rediger 1d6c7aa677 Add new blog post 2019-11-29 12:41:25 -05:00
Alessio Placitelli 1338a1dbbd Count the number of times a Glean product was force-closed 2019-11-29 17:47:12 +01:00
Jan-Erik Rediger f359ef547f Do not add a dummy metric to the deletion-request ping anymore 
This for now also removed the auto-generated documentation for the ping.
That's a bug in the glean_parser and will be fixed later.
 2019-11-28 13:12:11 +01:00
Jan-Erik Rediger 0ca9d0d1cb Document more clearly why a second directory is needed 2019-11-28 13:01:39 +01:00
Jan-Erik Rediger b8ebdcb1cd Write the deletion ping into a separate directory 2019-11-28 13:01:39 +01:00
Jan-Erik Rediger 6cef1713f9 Generate documentation for new ping 2019-11-28 13:01:39 +01:00
Jan-Erik Rediger 3b4fe4448c
Merge pull request #522 from mozilla/local-glean-dev 
Local glean dev
 2019-11-25 10:48:22 +01:00
Alessio Placitelli 79837c3d7f
Merge pull request #523 from mdboom/python-binding-status 
[doc only] Add note about the status of the Python bindings
 2019-11-25 08:53:05 +01:00
Chris H-C ff27ed0ffc Add this week's TWIG to the Index 2019-11-22 13:44:02 -05:00
Michael Droettboom 222b42afe7 [doc only] Add note about the status of the Python bindings 2019-11-22 11:28:55 -05:00
Jan-Erik Rediger 942c1c6c1a Rename the internal project to the simpler "glean" 2019-11-22 17:24:38 +01:00
Jan-Erik Rediger 5f762c2fcc Remove unneeded statements. 
We're only dealing with android-components here, so no transitive
substitutions needed.
 2019-11-22 17:09:33 +01:00
Jan-Erik Rediger 4ce980a67c Make it more clear where to run those tasks 2019-11-22 17:08:26 +01:00
Jan-Erik Rediger f3b952231e Use markdown footnotes 2019-11-22 17:06:09 +01:00
Jan-Erik Rediger 8f4055c376 Fix link structure 2019-11-22 15:56:06 +01:00
Jan-Erik Rediger 7cd6521d4b Remove mention of megazording 2019-11-22 15:52:15 +01:00
Jan-Erik Rediger 9d0b62d22b Document how to use locally-published Glean in Fenix 2019-11-22 15:14:55 +01:00
Jan-Erik Rediger 709abeae81 Document on how to work on unreleased Glean code in android-components 2019-11-22 15:14:48 +01:00
Jan-Erik Rediger 999338edc2
Cargo release (#435) 
Cargo release
 2019-11-22 10:34:48 +01:00
Alessio Placitelli 0922afd7de
Add the logo blog post to the twig 2019-11-21 19:15:19 +01:00
Jan-Erik Rediger e39102873e Add a list of TWiG blog posts 
[doc only]
 2019-11-21 16:17:27 +01:00
Jan-Erik Rediger 0caeb45ebb List published artifacts 2019-11-21 14:58:50 +01:00
Jan-Erik Rediger d7c23aeb86 Do not create a tag, let the user do that 2019-11-21 14:54:06 +01:00
Jan-Erik Rediger c5280f378c Update docs/dev/cut-a-new-release.md 
Co-Authored-By: Michael Droettboom <mdboom@gmail.com>
 2019-11-21 14:53:10 +01:00
Jan-Erik Rediger e2d0901152 Document how and when to release Rust crates 
[doc only]
 2019-11-21 13:17:54 +01:00
Jan-Erik Rediger c24e83c446 Mention that iOS artifacts will be available soon 2019-11-21 13:17:54 +01:00
Jan-Erik Rediger 24b83235ae Document for point-releases to earlier versions 2019-11-21 13:17:54 +01:00
Jan-Erik Rediger c394fadb8e Update documentation of the release process 2019-11-21 13:17:54 +01:00
Michael Droettboom 29dc99b5d5
Add markdown docs for "metrics about pings" (#507) 
This was missed in #498
 2019-11-20 16:25:07 -05:00
Michael Droettboom d0c011e49e
1597703: Use keyword-only arguments for Glean.initialize (#504) 2019-11-20 13:46:24 -05:00
Michael Droettboom f5d6d5a0e9
Add support for Python code coverage (#494) 2019-11-20 13:16:13 -05:00
Michael Droettboom 8b511a346a
Document all the Python things (#491) 
* Document all the Python things

* Address low-hanging fruit comments in the PR

* Update test fixture instructions

* Clarify events ping

* Typo

* Fix typo

* Add link to other docs.

* Add note about Python data directory

* Update docs/user/testing-metrics.md

Co-Authored-By: Raphael Pierzina <raphael@hackebrot.de>
 2019-11-20 13:11:31 -05:00
Michael Droettboom a995c2ca7e
Create 21.1.0 release (#499) 
* Create 21.1.0 release

* Add missing step
 2019-11-20 11:24:57 -05:00
Michael Droettboom 6fbab1dd31
1591197: Deploy binary Linux wheels of Python bindings (#472) 
* 1591197: Deploy binary Linux wheels of Python bindings

* Produce manylinux wheels

* Add auditwheel

* Downgrade wheel

* Prepare things for "real" deployment
 2019-11-18 18:27:49 -05:00
Michael Droettboom b19dd84cae
1591194: Implement experiments support for Python bindings (#471) 
* 1591194: Implement experiments support for Python bindings

* Update docs
 2019-11-18 09:50:27 -05:00
Michael Droettboom 5ec5b8e956
1595486: Make app_id and app_version required (#469) 
* 1595486: Make app_id and app_version required

* glean-python -> glean-python-test
 2019-11-13 11:21:40 -05:00
Michael Droettboom e9f853077d
1591190, 1591189: Implement labeled counters for Python (#467) 2019-11-12 09:26:20 -05:00
Michael Droettboom 26baf8dec1
Fix and disallow mdbook errors (#466) 2019-11-11 11:49:04 -05:00
Michael Droettboom ad6a2327c0
1588062: Add metrics usage documentation for Java. (#460) 
* 1588062: Add metrics usage documentation for Java.

This doesn't include metrics that are GV-only (since it's unlikely they'll
be needed from Java), and doesn't include event or string_list where the
conversion to Java is more complex and I'd need to fire up the compiler to
check my work.

* Update docs/user/metrics/datetime.md

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>

* Update docs/user/metrics/uuid.md

Co-Authored-By: Alessio Placitelli <alessio.placitelli@gmail.com>
 2019-11-11 11:48:16 -05:00
Michael Droettboom 6079510536
1587136: Document difference between duration and start/end_time (#459) 
* 1587136: Document difference between duration and start/end_time

* Use footnote notation
 2019-11-11 11:47:57 -05:00
Michael Droettboom ff9e73b764
20.2.0 release (#465) 2019-11-11 10:16:32 -05:00
Michael Droettboom 7406630c7e
Include version in Glean plugin (#449) 2019-11-11 08:59:49 -05:00
Michael Droettboom 3b0d442400
20.0.0 release (#462) 2019-11-11 08:43:54 -05:00
Michael Droettboom da87c8e446
Implement string metric type for Python bindings (#454) 
* Implement string metric type for Python bindings

* Add docs
 2019-11-08 11:28:29 -05:00
Michael Droettboom 0b2f2ceea6
1591188: Implement metrics.yaml/pings.yaml loader for Python bindings (#450) 
* 1591188: Implement metrics.yaml/pings.yaml loader for Python bindings

* Address comments in the PR
 2019-11-07 11:57:54 -05:00
Michael Droettboom 98963c3c0a
Document counter metric for Python (#451) 2019-11-07 07:53:25 -05:00
Michael Droettboom 1f06101e4d
Share metrics.yaml and pings.yaml content across platforms. (#448) 
* Share metrics.yaml and pings.yaml content across platforms.

This will be really handy as we add our third platform (Python).

This also adds a metric for `glean.error.invalid_state`, which wasn't added
when that feature was implemented.  (Missed because that metric is generated
"manually", but we still should have it in the metrics.yaml for documentation
purposes).

* Add correct data review link

* Correct typo.
 2019-11-06 13:46:02 -05:00
Michael Droettboom 10ce93001c
1593056: Implement testGetNumRecordedErrors for iOS (#438) 
* 1593056: Implement testGetNumRecordedErrors for iOS

* Update glean-core/ios/GleanTests/Metrics/TimingDistributionMetricTests.swift

Co-Authored-By: Travis Long <tlong@mozilla.com>

* Attempt to fix test
 2019-11-05 13:22:52 -05:00
Michael Droettboom ddc0ada0e3
Implement counter metric type for Python bindings. (#439) 
* Implement counter metric type for Python bindings.

It's pretty helpful to have type annotations for the documentation, if nothing
else, so additionally, this adds support for mypy type annotations.

* Simplify CircleCI task name

* Add a bug number
 2019-11-05 11:05:06 -05:00
Michael Droettboom cf7ede1a94
WIP: 1591185: Set up basic Python project structure (#423) 
* 1591185: Set up basic Python project structure

* Fix typo

* Clarify

* Correct emails

* Add docstrings

* Don't raise exception on no handle

* Handle shared objects on multiple platforms

* Improve docstring

* Fix __version__

* Attempt to fix on Windows
 2019-11-04 13:18:03 -05:00
Michael Droettboom 6f5259ea6d 1593055: Add testGetNumRecordedErrors to labeled metrics 2019-11-01 10:16:42 -04:00
Michael Droettboom 2536903087
Expose testGetNumRecordedErrors (#401) 2019-11-01 09:19:41 -04:00
Michael Droettboom f40897af22
1541820: Implement a Gradle plugin for Glean (#421) 
* 1541820: Implement a Gradle plugin for Glean

* Address comments in the PR

* Backport 382cb4b

* Fix path to plugin

* Update docs/user/adding-glean-to-your-project.md

Co-Authored-By: Travis Long <tlong@mozilla.com>

* Update docs/user/adding-glean-to-your-project.md

Co-Authored-By: Travis Long <tlong@mozilla.com>

* Fix documentation nit
 2019-10-31 08:13:56 -04:00
Jan-Erik Rediger fe47b4121f Link to both standard distribution metric types 
(and fix stray closing-parenthesis)
 2019-10-31 10:22:23 +01:00
Jan-Erik Rediger 0a8b0e7c95 Implement String List metric for Swift 2019-10-30 09:04:47 +01:00
Travis Long 7c20f191b2 1582479 - Document Glean crash capabilities as a focused use-case 2019-10-29 08:52:58 -05:00
Jan-Erik Rediger 76239c8062 Document how to use Mozilla's maven repository 
[doc only]
 2019-10-28 14:31:35 +01:00
Jan-Erik Rediger ebd3200146
Merge pull request #413 from mdboom/single-implementation 
Remove unnecessary mentions of "legacy" glean-ac.
 2019-10-25 13:04:01 +02:00
Michael Droettboom 8fb3f1c3d7 Remove unnecessary mentions of "legacy" glean-ac. 
Also adds our newest team member, brizental.
 2019-10-24 12:50:24 -04:00
Jan-Erik Rediger e06653e1ac Record new error type "invalid state" to accurately describe the error 
CAUTION: This might change error reporting for existing metrics.
 2019-10-24 15:44:28 +02:00
Jan-Erik Rediger d3bdc9a3b5
Prepare for next release cycle (#408) 
Prepare for next release cycle
 2019-10-24 15:42:34 +02:00
Michael Droettboom 345288b354
1588452: Don't crash TimingDistribution.start() prior to Glean.init (#400) 
* 1588452: Don't crash TimingDistribution.start() prior to Glean.init

* iOS fixes

* Add docs

* Fix docs, update CHANGELOG
 2019-10-24 09:20:47 -04:00
Jan-Erik Rediger 03a77c7d0e Document pre-release bumping in release process 2019-10-24 15:04:27 +02:00
Michael Droettboom 8252e2f997 1589677: Fix jumping around when switching language tabs 2019-10-21 08:26:07 -04:00
Jan-Erik Rediger 891e9df38f Split 'Get started' into Android and iOS parts 
[doc only]
 2019-10-18 15:02:52 +02:00
Jan-Erik Rediger a2bcaee197 Testing examples for both languages 
[doc only]
 2019-10-18 15:02:52 +02:00
Jan-Erik Rediger 83f7b19203 Add case inflection examples for both languages 
[doc only]
 2019-10-18 15:02:52 +02:00
Jan-Erik Rediger 491790d33a Mention that Experiments are not yet supported on iOS 
[doc only]
 2019-10-18 15:02:37 +02:00
Jan-Erik Rediger ece77688e6 Use correct path for GleanTimerId in docs 
[doc only]
 2019-10-18 15:02:37 +02:00
Jan-Erik Rediger 879a67c660 Link to Swift API reference for every metric type 
[doc only]
 2019-10-18 15:02:37 +02:00
Jan-Erik Rediger d27e4ce99e
Merge pull request #381 from mozilla/rename-debugactivity-in-docs 
Use glean-core specific full path for debug activity in the docs
 2019-10-17 15:15:50 +02:00
Jan-Erik Rediger 545ff8d011
Add missing Swift docs for UUID (#387) 
Add missing Swift docs for UUID
 2019-10-17 15:13:20 +02:00
Jan-Erik Rediger dff752320f Bug 1587110 - Correct path for import statement 
[doc only]
 2019-10-17 14:04:24 +02:00
Jan-Erik Rediger 748f917d9b Bug 1587149 - Inline expire date, it's not a list 
[doc only]
 2019-10-17 14:04:15 +02:00
Jan-Erik Rediger 4fbb07533b Add missing Swift docs for UUID 
[doc only]
 2019-10-17 13:59:55 +02:00
Travis Long 4f1040f696 1584203 - Document how to build against a specific version of Glean 2019-10-16 10:32:51 -05:00
Jan-Erik Rediger 1af190b4ca Add note about the old name 2019-10-16 16:45:40 +02:00
Jan-Erik Rediger c87fffac90 Use glean-core specific full path for debug activity in the docs 
BREAKING CHANGE:

When used through Android Components,
previously users had to use the `mozilla.components.service.glean.debug.GleanDebugActivity` name.

It's now required to use `mozilla.telemetry.glean.debug.GleanDebugActivity``

[doc only]
 2019-10-16 16:07:45 +02:00
Jan-Erik Rediger d5311e5b72
Implement memory distribution in Swift (#375) 
Implement memory distribution in Swift
 2019-10-14 16:01:57 +02:00
Jan-Erik Rediger 79d64c53cd
Implement timing distribution in Swift (#369) 
Implement timing distribution in Swift
 2019-10-14 15:49:32 +02:00
Jan-Erik Rediger c12b545495 Implement memory distribution in Swift 2019-10-14 15:48:18 +02:00
Jan-Erik Rediger 7b518f525a Implement timing distribution in Swift 2019-10-14 15:38:10 +02:00
Michael Droettboom 64dd7c4faf
1575049: Document how to remove metrics (#371) 
* 1575049: Document how to remove metrics

* Add link to custom pings docs
 2019-10-14 08:53:18 -04:00
Michael Droettboom d2e73e3267 [doc only] 1583511: Document the directory structure 2019-10-14 10:55:19 +02:00
Jan-Erik Rediger 3c1f448b52 Upgrade to Android NDK r20 
Now there's no need to generate Android toolchains anymore.
 2019-10-09 15:13:28 +02:00
Michael Droettboom 4fc6f83a12
Fix typo (#362) 2019-10-08 15:05:09 -04:00
Alessio Placitelli 76a3be9367
Merge pull request #354 from Dexterp37/generate_glean_autodocs 
Generate glean autodocs
 2019-10-08 15:49:03 +02:00
Alessio Placitelli 0bb22ae5e6 Bump glean_parser version to 1.9.2 2019-10-08 15:18:26 +02:00
Jan-Erik Rediger 1bcddc5d6f
Add documentation for iOS development & review (#342) 
Add documentation for iOS development & review
 2019-10-08 15:12:32 +02:00
Alessio Placitelli c0a617eddf Link metrics in the Glean docs 2019-10-08 10:42:47 +02:00
Alessio Placitelli 68c98e9b30 Rename the metrics docs directory to 'collected-metrics' 2019-10-08 10:42:47 +02:00
Alessio Placitelli 1b08384da1 Commit the generated docs 2019-10-08 10:42:41 +02:00
Jan-Erik Rediger 7ccbfb51e2 Document additional tools for iOS development 
[doc only]
 2019-10-07 14:55:21 +02:00
Jan-Erik Rediger f6127db8fa Mention `make` commands in contribution guidelines 
[doc only]
 2019-10-07 14:55:21 +02:00
Jan-Erik Rediger 61cab7f2fc Clean up makefile and separate into logical categories 
[doc only]
 2019-10-07 14:55:21 +02:00
Jan-Erik Rediger 0664c20967
Document the (current) release process (#343) 
Document the (current) release process
 2019-10-07 11:03:20 +02:00
Michael Droettboom d5ea36bd5d [doc only] Update documentation about bug references. 2019-10-04 12:12:40 -04:00
Jan-Erik Rediger 09233cbf64 Name the full command. 
[doc only]
 2019-10-03 20:51:09 +02:00
Jan-Erik Rediger 77c8ccbeef Link to Swift API docs 
[doc only]
 2019-10-03 20:51:09 +02:00
Jan-Erik Rediger 78b1252c64 Mention how to run swift tests 
[doc only]
 2019-10-03 20:51:09 +02:00
Jan-Erik Rediger 078196bb51 Describe iOS build env setup 
[doc only]
 2019-10-03 20:51:09 +02:00
Jan-Erik Rediger 942493e651
Update docs/dev/cut-a-new-release.md 
Co-Authored-By: Michael Droettboom <mdboom@gmail.com>
 2019-10-03 17:22:43 +02:00
Jan-Erik Rediger d6f02f14b4 Document the (current) release process 
[doc only]
 2019-10-03 14:47:09 +02:00
Jan-Erik Rediger 11b2784336 Add info where to find Swift code coverage 
[doc only]
 2019-10-03 14:45:07 +02:00
Jan-Erik Rediger b806b0c701 Clearly document review policy 
[doc only]
 2019-10-03 14:45:05 +02:00
Chris H-C 1c4c8d4dd6 Update the comment in the swift datetime example 
Eating some copypasta.
 2019-09-30 10:31:26 -04:00
Travis Long c5094d4032 Add Swift example to boolean metric docs 2019-09-30 08:35:34 -05:00
Jan-Erik Rediger f4b7429c3a Sanitize documentation for nicer rendered docs 
[doc only]
 2019-09-30 10:17:45 +02:00
Jan-Erik Rediger 3031fecaf4
Merge pull request #260 from mdboom/document-duplicate-metrics 
1523977: Document the issues with duplicate metric names
 2019-09-30 10:06:29 +02:00
Jan-Erik Rediger 6fc51c96a9
1581556: Register lifecycle observers on the main thread (#310) 
1581556: Register lifecycle observers on the main thread
 2019-09-30 10:05:45 +02:00
Jan-Erik Rediger 8607b2d847
Implement labeled metrics (#314) 
Implement labeled metrics
 2019-09-30 09:45:48 +02:00
Michael Droettboom 4b59cb8f40 that that -> that the 2019-09-27 14:15:49 -04:00
Michael Droettboom db3cac324a Add a bug about build-time duplicate detection. 2019-09-27 14:15:08 -04:00
Michael Droettboom 529f0e7f6d 1523977: Document the issues with duplicate metric names 2019-09-27 14:15:08 -04:00
Michael Droettboom 808c8d2a4c Only allow the registration of lifecycle observers on the main thread 2019-09-27 14:12:21 -04:00
Travis Long ba19c6ff00 Add Swift Datetime metric examples to documentation 2019-09-27 12:50:41 -05:00
Jan-Erik Rediger 4b14648135 Implement labeled metrics 
Currently supported:
* Labeled counters
* Labeled strings
 2019-09-27 17:33:08 +02:00
Michael Droettboom 8d511cdb41
We're not just mobile... (#304) 2019-09-18 13:18:43 -04:00
Jan-Erik Rediger bde2a4c337 Migrate existing docs to language tabs 
[doc only]
 2019-09-18 18:10:16 +02:00
Jan-Erik Rediger 652ee0ffc1 Don't use (unique) ids, use data attributes 
[doc only]
 2019-09-18 18:10:12 +02:00
Jan-Erik Rediger 7f1ecf915e
Implement String metric type (#297) 
Implement String metric type
 2019-09-18 17:40:14 +02:00
Jan-Erik Rediger 5476e207d3
Merge pull request #302 from mdboom/multi-language-docs 
Support displaying examples in multiple languages
 2019-09-18 17:30:02 +02:00
Jan-Erik Rediger 64e6775871 Document String metric API for Swift 2019-09-18 17:19:29 +02:00
Michael Droettboom c810bbb0a1 Support displaying examples in multiple languages 2019-09-18 11:16:51 -04:00
Jan-Erik Rediger 562b3fc47a
Implement timespan metric type (#300) 
Implement timespan metric type
 2019-09-18 17:07:09 +02:00
Jan-Erik Rediger e84e33e1f7 Implement timespan metric type 2019-09-18 16:48:04 +02:00
Jan-Erik Rediger 025662fa26 Document Swift API for counters 
[doc only]
 2019-09-18 16:22:38 +02:00
Jan-Erik Rediger 19aefcd030 Document timespan API for Swift 2019-09-18 15:51:49 +02:00
Jan-Erik Rediger 5b5ebf3f19
1569342: Make the necessity to check testGetValue clearer from t… (#290) 
1569342: Make the necessity to check testGetValue clearer from the docs
 2019-09-17 12:22:41 +02:00
Jan-Erik Rediger b2ad635e69 Convert a bool to its byte equivalent 2019-09-17 10:39:15 +02:00
Michael Droettboom 23618bfcba 1569342: Make the necessity to check testGetValue clearer from the docs 2019-09-16 14:43:44 -04:00
Jan-Erik Rediger 389bd228f0 Move counter recording off the main thread 2019-09-13 14:53:59 +02:00
Jan-Erik Rediger d20116366a
Remove error on destroyers (#280) 
Remove error on destroyers
 2019-09-13 09:54:40 +02:00
Jan-Erik Rediger 286cc1a9b2 Remove RustError from all Kotlin wrappers 2019-09-12 16:38:38 +02:00
Jan-Erik Rediger 2fa2606bea Keep test-only functions internal 2019-09-12 16:36:03 +02:00
Jan-Erik Rediger 2a68eb141c Typo 
[doc only]
 2019-09-12 16:16:36 +02:00
Jan-Erik Rediger f7771b4515 Add docu on how to create a swift wrapper 
This also splits the chapter into subchapters to make it more
approachable than one huge multi-page chapter.
 2019-09-12 16:16:36 +02:00
Alessio Placitelli 18040bc108 Mention the Glean Debug View in the GleanDebugActivity docs 2019-09-06 11:02:22 +02:00
Alessio Placitelli 95c5648b05 Fix typo in the docs 2019-09-05 16:56:09 +02:00
Alessio Placitelli 2a15d890f9 Tweak the docs for clarity 2019-09-05 11:21:33 +02:00
Alessio Placitelli 832f150a76 Document the new docs build time options 2019-09-05 10:47:38 +02:00
Jan-Erik Rediger ae5147f6bc Test snapshotting of sparse histogram and fix documentation accordingly 2019-08-26 11:47:33 -07:00
Michael Droettboom 39ae10e31b Address comments in PR 2019-08-22 15:19:01 -04:00
Michael Droettboom 562c88cb29 1573516: Add a QuantityMetricType 2019-08-22 15:19:01 -04:00
Travis Long 4b4d4b6d7f Bug 1574468 - Add experiments limits violations error reporting 2019-08-21 09:01:34 -05:00
Travis Long 6296cabc06 Bug 1566001 - Add limits for the experiment's extra HashMap 2019-08-16 10:25:09 -05:00
Jan-Erik Rediger b73e71b0df
Merge pull request #246 from mdboom/document-sdk-generator-options 
[doc only] 1568767: Document `sdk_generator.gradle` options
 2019-08-16 15:33:10 +02:00
Michael Droettboom ad41fdbd30 [doc only] 1568767: Document `sdk_generator.gradle` options 2019-08-16 07:44:09 -04:00
Michael Droettboom 864aa9a239
[doc only] Document memory distribution metric type (#243) 
* [doc only] Document memory distribution metric type

* Fix copy-pasta

* Better describe the filling in of missing values in payloads

* Address comments in the PR

* Update docs/user/metrics/memory_distribution.md

Co-Authored-By: Jan-Erik Rediger <badboy@archlinux.us>
 2019-08-14 10:12:53 -04:00
Michael Droettboom be9c92b9c2 [doc only] Make the custom distribution example self-consistent 2019-08-13 18:44:18 -04:00
Travis Long 5009d7e703 Bug 1556995 - Fix Glean storing/sending of empty StringListMetricType 2019-08-13 11:46:37 -05:00
Michael Droettboom 02c35b9a2b
[doc only] 1571744: Document the custom distribution type (#241) 
Fix issues mentioned in the PR

Change datatypes
 2019-08-12 12:32:41 -04:00
Michael Droettboom a53f12bb6f
[doc only] 1564989: Document functional timing distributions (#240) 2019-08-12 11:52:15 -04:00
Jan-Erik Rediger da709e6f31 Fix small typo. 
Found after merge by @mdboom. Sorry about merging before your review. :D
 2019-08-12 10:14:46 +02:00
Jan-Erik Rediger 9ab03edf69 Make it clear that it expects a string 
[doc only]
 2019-08-09 17:57:48 +02:00
Jan-Erik Rediger 20b3059a97 Fix url to experiments API 
[doc only]
 2019-08-09 15:28:57 +02:00
Jan-Erik Rediger 43b353883c Typo 2019-08-09 15:25:35 +02:00
Jan-Erik Rediger 30c75eb47d We removed labeled timespans 
[doc only]
 2019-08-09 14:49:45 +02:00
Jan-Erik Rediger 39247d201e Link to license website 2019-08-09 14:46:51 +02:00
Jan-Erik Rediger 71bb8036e3 Make it easier for possible contributors and link to both bug trackers 2019-08-09 14:45:07 +02:00
Jan-Erik Rediger c80c62d9e5 Annotate Kotlin code as such 2019-08-09 14:37:42 +02:00
Jan-Erik Rediger 8d904d3cee Link back to the experiments API 2019-08-09 14:36:34 +02:00
Jan-Erik Rediger 7d6c4383c1 Turn stmo into a link 2019-08-09 14:36:26 +02:00
Jan-Erik Rediger 7da6226459 Add missing characters 2019-08-09 14:29:58 +02:00
Jan-Erik Rediger b10eebe580 Slight rephrasing and closing parenthesis 2019-08-09 14:28:00 +02:00
Jan-Erik Rediger b81125e3aa Reoder pings in the same order as the table of contents 2019-08-09 14:26:31 +02:00
Jan-Erik Rediger b9c21f32cb Turn notes into proper quoted blocks 2019-08-09 14:25:42 +02:00
Jan-Erik Rediger d0d83824d1 Reoder metrics in the same order as the table of contents lists 2019-08-09 14:22:24 +02:00
Jan-Erik Rediger 5ac2e1f1f1 Link pings 2019-08-09 14:18:09 +02:00
Jan-Erik Rediger 248b68cfc0 Typo and slight rephrasing 2019-08-09 14:16:13 +02:00
Jan-Erik Rediger 521cf4e24a Fix typo 2019-08-09 14:14:40 +02:00
Jan-Erik Rediger 22d9422a2f Link MPL 2019-08-09 14:11:40 +02:00
Jan-Erik Rediger 5b2165adf3 Add missing word 2019-08-09 14:11:15 +02:00
Jan-Erik Rediger 5066c88a60
Merge pull request #232 from mozilla/are-we-covered-yet 
Upload code coverage
 2019-08-08 18:18:09 +02:00
Alessio Placitelli 83f231df15
Update docs/user/experiments-api.md 
Co-Authored-By: Jan-Erik Rediger <badboy@archlinux.us>
 2019-08-08 16:01:11 +02:00
Alessio Placitelli 7817ccf834
Update docs/user/experiments-api.md 
Co-Authored-By: Jan-Erik Rediger <badboy@archlinux.us>
 2019-08-08 16:01:05 +02:00
Alessio Placitelli f00d1a17d5 Mention that Glean SDK does not persist experiment data 2019-08-08 15:51:20 +02:00
Jan-Erik Rediger 2a318abb38 Document how to generate code coverage 2019-08-08 13:03:31 +02:00
Michael Droettboom a680881bfd
Update integration docs to be more appropriate for glean-ac (#218) 
* Update integration docs to be more appropriate for glean-ac

* Add comments in the PR
 2019-08-05 09:15:54 -04:00
Jan-Erik Rediger ce72704dd4 Update docs to current way of providing implementation of a metric type 
[doc only]
 2019-08-05 11:20:00 +02:00
Jan-Erik Rediger d3d00169c7
1569765: Add "all_pings" to handle metrics that are sent on all… (#206) 
1569765: Add "all_pings" to handle metrics that are sent on all pings
 2019-08-05 10:11:55 +02:00
Michael Droettboom 2d638ea6b8 Don't mention all_pings in user docs 2019-07-31 10:50:11 -04:00
Michael Droettboom 640319a548 Add docs about the special ping name. 2019-07-31 10:48:44 -04:00
Alessio Placitelli d414f74220 Improve the GleanTestRule docs [doc only] 2019-07-31 12:29:03 +02:00
Alessio Placitelli d51eaec604 Add a missing @Test tag to the docs [doc only] 2019-07-31 11:42:33 +02:00
Alessio Placitelli f1ed56da33
Merge pull request #211 from Dexterp37/gleantestrule_and_docs 
Add the `GleanTestRule` and update the docs
 2019-07-31 11:25:58 +02:00
Alessio Placitelli a3b7cf3a5c Fixup the docs 2019-07-31 11:15:01 +02:00
Alessio Placitelli 7f276c7146 Update the docs and examples to the GleanTestRule 2019-07-31 10:44:53 +02:00
Travis Long 29099e092d 1569603 - Remove `glean_*_should_record` functions from FFI 2019-07-30 14:40:00 -05:00
Jan-Erik Rediger 96f84a0cbe Make it clear that filtering by just Glean should work 
[doc only]
 2019-07-30 17:06:18 +02:00
Jan-Erik Rediger f181810be5 Apply suggestions from code review 
Co-Authored-By: Travis Long <tlong@mozilla.com>
 2019-07-30 17:05:50 +02:00
Jan-Erik Rediger 939db891ea Document how to view application-specific logs throug Android Studio/adb 2019-07-30 17:05:50 +02:00
Jan-Erik Rediger 5f0484f946
Merge pull request #204 from mozilla/1564486-disallow-labeled-timespan 
Bug 1564486 - Remove labeled timespans docs
 2019-07-30 15:16:09 +02:00
Michael Droettboom 58d7851276 1569765: Add "all_pings" to handle metrics that are sent on all pings 2019-07-29 17:53:28 -04:00
Jan-Erik Rediger 82bc8b7152 Bug 1564486 - Remove labeled timespans docs 
[doc only]
 2019-07-29 15:35:03 +02:00
Alessio Placitelli 2ef0f3746e Clarify the experiment id, branch id and extra values 2019-07-29 11:58:05 +02:00
Alessio Placitelli d0fc193ec7 Fix the Kotlin API link 2019-07-29 11:54:06 +02:00
Alessio Placitelli 4d21fb9690 Add documentation for the experiments API 2019-07-26 17:56:01 +02:00
Michael Droettboom a3795dcce9
[doc only] 1562681: Add missing "type" parameter to docs (#198) 2019-07-24 14:04:17 -04:00
Jan-Erik Rediger 37cd2e7224
Describe how to add a new metric type using the macro (#197) 
Describe how to add a new metric type using the macro
 2019-07-24 17:28:06 +02:00
Jan-Erik Rediger 5100c3289b
Update docs/dev/core/new-metric-type.md 
Co-Authored-By: Michael Droettboom <mdboom@gmail.com>
 2019-07-24 16:46:07 +02:00
Jan-Erik Rediger 9b6ab16eb6
Update docs/dev/core/new-metric-type.md 
Co-Authored-By: Michael Droettboom <mdboom@gmail.com>
 2019-07-24 16:46:00 +02:00
Jan-Erik Rediger c0acc89ff1 Describe how to add a new metric type using the macro 2019-07-24 16:41:58 +02:00
Jan-Erik Rediger 7bb4a4ec93 Use correct name for environment variable 2019-07-24 16:27:08 +02:00
Michael Droettboom 24955fee46
1566047: Rename category -> ping_section (#194) 
* 1566047: Rename category -> ping_section

* Add documenation updates
 2019-07-23 08:11:56 -04:00
Michael Droettboom 71f4f09e18 [doc only] Reformat the event payload description 2019-07-22 14:01:48 -04:00
Michael Droettboom 104d49e8d9
[doc only] 1557700: Document some best practices for metrics (#191) 
* [doc only] 1557700: Document some best practices for metrics

* Reorder lifetimes
 2019-07-22 09:09:41 -04:00
Jan-Erik Rediger f41278d283 Make the example a subsection 2019-07-19 10:30:41 +02:00
Jan-Erik Rediger 252038848a Document payload of the missing metric types 
Co-Authored-By: Michael Droettboom <mdboom@gmail.com>
 2019-07-19 10:30:41 +02:00
Jan-Erik Rediger 5e008ed409 Document timespan & timing distribution payload format 2019-07-19 10:30:41 +02:00
Jan-Erik Rediger e5ef8bfc2e
1557046: Document more about event payload (#183) 
1557046: Document more about event payload
 2019-07-18 17:14:51 +02:00
Jan-Erik Rediger 7e9d193ecb
Skip Android tests if commit contains marker (#181) 
Skip Android tests if commit contains marker
 2019-07-18 17:14:03 +02:00
Alessio Placitelli 4688e68207 Mention that labels are expected to be lowercase 2019-07-18 17:02:51 +02:00
Michael Droettboom 2cd6ea5c49 Link to event metrics docs 2019-07-18 09:51:49 -04:00
Alessio Placitelli abbff28dbb Address the nits in the review 2019-07-18 15:22:27 +02:00
Alessio Placitelli 14ff4f84e4 Update the user facing docs 2019-07-18 13:48:26 +02:00
Michael Droettboom d15ea146c5 Address comments in the PR 2019-07-17 16:11:16 -04:00
Michael Droettboom 238479f2c0
Update docs/dev/core/internal/payload.md 
Co-Authored-By: Jan-Erik Rediger <badboy@archlinux.us>
 2019-07-17 13:52:33 -04:00
Alessio Placitelli 12e07fe394
Merge pull request #182 from Dexterp37/docs_custom_pings_testing 
Add documentation for custom ping testing
 2019-07-17 17:36:04 +02:00
Alessio Placitelli 3c96b981b5 Add the setup glean function 2019-07-17 17:26:35 +02:00
Jan-Erik Rediger 19b9633a42
Update docs/dev/testing.md 
Co-Authored-By: Michael Droettboom <mdboom@gmail.com>
 2019-07-17 16:48:52 +02:00
Michael Droettboom 8db234a3f6 [doc only] 1557046: Document more about event payload 2019-07-17 10:43:40 -04:00
Jan-Erik Rediger 10fa233663 Skip Android tests if commit contains marker 
For doc-only changes we might not require the full CI run.
The Android tests are what's taking the longest, so let's make this
easily skippable.

[doc only]
 2019-07-17 16:28:41 +02:00
Alessio Placitelli 031ed27e10 Address review feedback 2019-07-17 16:10:10 +02:00
Alessio Placitelli a0f56f4487 Add user docs for testing custom pings 2019-07-17 15:18:31 +02:00
Alessio Placitelli a1a37d306a Bonus: add a note about the mdbook requirement 2019-07-17 15:18:19 +02:00
Jan-Erik Rediger d3cb42dfd9 Document raw API on timespans for users. 2019-07-17 13:07:50 +02:00
Jan-Erik Rediger 13cfa316d6 List all possible recorded errors for a timespan 2019-07-17 11:34:09 +02:00
Jan-Erik Rediger 4b89ec4885 Document new behavior for timing distributions. 
The code example currently applies to Glean AC, where the import for
GleanTimerId is different from what it is in glean-core.
 2019-07-11 14:44:28 +02:00
Jan-Erik Rediger 20315a8165
Fill all sections with at least some basic content (#167) 
Fill all sections with at least some basic content
 2019-07-11 14:34:52 +02:00
Jan-Erik Rediger 2f98acc7c9 Android component -> Android binding 2019-07-11 14:03:05 +02:00
Alessio Placitelli 39d0abdfa5 Restrict Glean to only init on the main process. 
This additionally clarifies the documentation about the lack
of support for multiple application processes and what happens
in case an initialization is attempted on non-main processes.
 2019-07-11 12:13:20 +02:00
Alessio Placitelli 97df9d97ac Update docs for the metrics ping. 
This is a port of just the documentation part of
https://github.com/mozilla-mobile/android-components/pull/3204

The code parts of that PR are not relevant since we don't yet have a metrics
ping scheduler in glean-core.
 2019-07-10 13:15:14 -07:00
Jan-Erik Rediger a230114b16 Fill all sections with at least some basic content 2019-07-10 18:57:10 +02:00
Jan-Erik Rediger 9b4aaa3159 Put baseline.duration into the right category 
Thanks for @tdsmith for noticing.
 2019-07-09 17:25:48 +02:00
Alessio Placitelli 3fcaf3ec64 Tweak the 'baseline' crash behavior doc 2019-07-09 11:18:30 +02:00
Alessio Placitelli d14b0d62d1 Document the behavior of Glean pings on crash 2019-07-08 17:34:07 +02:00
Jan-Erik Rediger 967a8d3d78 Implement a timespan metric 
We rely on start and stop passed as an integer due to FFI requirement.

In a world where we wouldn't need a dispatch queue on the Kotlin side we
could rely on `Instant` and `Duration` only on the Rust side, making
this all much nicer.
Until then we take integer timestamps.
 2019-07-04 17:04:00 +02:00
Michael Droettboom f79c69244d 1559133: Make landing page less confusing 2019-07-02 13:44:21 -04:00
Michael Droettboom bd654ad5ce
1560030: Be clear about Glean SDK vs. other parts of Glean (#152) 2019-07-02 09:24:56 -04:00
Michael Droettboom bd7956dd76
1555976: Link to probe_scraper docs (#144) 
* 1555976: Link to probe_scraper docs

This also refactors the existing documentation -- since Glean can be used by
an application or a library, this hopefully makes it clear that most of this
applies to either, but there are some additional application-specific steps.

* Address comments in the PR
 2019-07-01 11:31:39 -04:00
Georg Fritzsche fac7e568ac
Fix showing "not implemented" status in docs (#150) 
Fix showing "not implemented" status where a-c glean sdk has it.
We point to these docs from the a-c glean sdk readme. This is actually in use by Mozilla engineers, so we need to make sure the docs here match its behavior.

* Fix last status bits
 2019-06-25 06:47:33 -07:00
Jan-Erik Rediger 6ef9680f65 Add modified highlightjs to support required languages 
Downloaded from https://highlightjs.org/download/ with:

HTTP
JavaScript
Objective-C
Python
Bash
Ini/Toml
Makefile
Diff
JSON
Markdown
SQL
C++
HTML/XML
Java
Shell Session
Gradle
Groovy
Kotlin
Swift
Rust
YAML
 2019-06-19 17:03:16 -04:00
Georg Fritzsche 6226f9ee3a Add link to Glean overview documentation 2019-06-13 16:57:45 -05:00
Georg Fritzsche d0be482a77 Name the Glean SDK more clearly 2019-06-13 16:54:23 -05:00
Jan-Erik Rediger 9a36d62621
[branding] Capitalize Glean where appropriate (#143) 
[branding] Capitalize Glean where appropriate
 2019-06-13 10:37:46 +02:00
Michael Droettboom c371871c42
1557396: Port over labeled metric changes to glean-core. (#140) 
See https://github.com/mozilla-mobile/android-components/pull/3273 for the
original changes to glean-ac.
 2019-06-12 13:09:11 -04:00
Chris H-C 30bdaf7102 [branding] Capitalize Glean where appropriate 2019-06-12 12:44:23 -04:00
Chris H-C fe063f5109 Highglight that JSON strings are okay for test-only FFI 2019-06-12 12:44:14 -04:00
Chris H-C 8b246632b2 Expand a little on the Android Studio setup instructions 2019-06-12 12:44:14 -04:00
Michael Droettboom dd0703b597
1557734: Reinstate dependency instructions (#141) 2019-06-12 11:54:02 -04:00
Jan-Erik Rediger d6cfaa7ea3 Mention new module structure for ffi component in the docs 2019-06-12 11:13:55 +02:00
Chris H-C f7eb6c301f Remove 'not implemented' notice from stringlist docs 2019-06-07 15:16:49 -04:00
Jan-Erik Rediger 4247d39a57 Add docs about reserved ping names 2019-06-06 13:44:02 +02:00
Jan-Erik Rediger 14bdd52ded
Initialize the logger for all (integration) tests (#119) 
Initialize the logger for all (integration) tests
 2019-06-06 13:28:07 +02:00
Jan-Erik Rediger bd07642a86 Remove unneeded whitespace 2019-06-06 11:28:34 +02:00
Michael Droettboom 7ddff55f26
1552774: Document more complex serialization (#125) 2019-06-05 12:39:44 -04:00
Jan-Erik Rediger b69efffe27 typo: ouptut -> output 2019-06-05 17:02:40 +02:00
Jan-Erik Rediger 5b9bff386d Describe how to enable logging in tests in the docs 2019-06-05 15:47:56 +02:00
Michael Droettboom 57c6e83d6d
1552842: Document how to run tests (#117) 
* 1552842: Document how to run tests

* Update docs/dev/testing.md

Co-Authored-By: Chris H-C <chutten@users.noreply.github.com>

* Add notes about Windows
 2019-06-05 09:36:52 -04:00
Michael Droettboom 25b97d6ccf
1555975: Move markdown docs from glean-ac to glean-core (#113) 
* 1555975: Move markdown docs from glean-ac to glean-core

* Don't use makefile for linkcheck

* Address comments in the PR

* Use semantic line endings

* More private functions

* Fix a couple more links
 2019-06-05 08:02:12 -04:00
Alessio Placitelli 232eab55e9
Merge pull request #114 from mozilla/labeled-metrics-with-overhead 
Store an instance of the underlying metric and clone it on request
 2019-06-04 10:27:03 +02:00
Chris H-C 96cef895fa Small copypasta fix to contribution docs. 2019-06-03 16:35:10 -04:00
Jan-Erik Rediger c1c51aa5e5 Store an instance of the underlying metric and clone it on request 
This has the overhead of storing a metric instance per labeled metric.
However, these should be rather small.

And on the upside this allows us to store metric-type-specific data
(e.g. the time unit for DateTime) for that metric only instead of inside
the common metric data.
 2019-06-03 16:52:04 +02:00
Michael Droettboom b5c24899bd
Add Kotlin docs to CI (#101) 2019-05-30 10:49:05 -04:00
Jan-Erik Rediger b10b6ac0a9 Adjust documentation to mention new trait 2019-05-29 09:52:45 +02:00
Alessio Placitelli 04bd2b0341
Add how to publish new metric types in the module 
Add the missing steps for properly exposing a new metric type. Without these steps, build will fail.
 2019-05-28 12:09:24 +02:00
Jan-Erik Rediger bd7f5217b3 Mention trait implementation in docs 2019-05-22 11:16:44 +02:00
Jan-Erik Rediger f49b9a5c00 Add missing finalizer 
This is a follow-up from a previous bug
 2019-05-21 17:36:43 +02:00
Jan-Erik Rediger 1c5ec07f20 Include `should_record` implementation in the docs 2019-05-21 17:36:09 +02:00
Jan-Erik Rediger d2aef29503 Make it clear that the struct should not hold the data directly 2019-05-20 11:42:11 +02:00
Jan-Erik Rediger 2d67de7b1a Simplify lifetime conversion 2019-05-20 11:42:08 +02:00
Jan-Erik Rediger 1f23ebc05b
Apply suggestions from code review 
Co-Authored-By: Michael Droettboom <mdboom@gmail.com>
 2019-05-20 10:13:17 +02:00
Jan-Erik Rediger 458a775acc Document how to add a new metric type in the code 2019-05-17 15:13:12 +02:00
Jan-Erik Rediger ce797e9191 Update links and naming across the repository 2019-05-15 10:59:28 +02:00
Alessio Placitelli 08224a823f Remove the TOC and the untested maven bits 2019-05-13 11:26:56 +02:00
Alessio Placitelli b3727d43bf Update the developer setup notes 2019-05-13 11:07:16 +02:00
Jan-Erik Rediger a4b4069145 Add new chapters for adding/testing metrics 2019-05-02 13:22:26 +02:00
Jan-Erik Rediger fdb79822b5 Start ping docs 2019-05-02 13:18:13 +02:00
Jan-Erik Rediger 0417da3c82 Start additional docs 2019-05-02 13:12:14 +02:00
Jan-Erik Rediger 565cc7b773 Document boolean type 2019-05-02 12:15:46 +02:00
Jan-Erik Rediger 969f92ac5c Document methods 2019-05-02 12:15:46 +02:00
Jan-Erik Rediger 3b8ac29017 Document counter type 2019-05-02 12:15:46 +02:00
Jan-Erik Rediger f100884ec5 Document string list type 2019-05-02 12:15:46 +02:00
Jan-Erik Rediger 882938d02b Start docs for string type 2019-05-02 12:15:46 +02:00
Jan-Erik Rediger 48a803d751 List all metric types 2019-05-02 12:15:46 +02:00
Michael Droettboom cd31d715ac Branding is important (#4) 2019-04-30 14:30:48 +02:00
Jan-Erik Rediger 7f5b7e8687 Move Android docs to subfolder 2019-04-05 14:19:59 +02:00
Jan-Erik Rediger 0abd3234b8 Start docs readme 2019-03-19 16:26:15 +01:00
Jan-Erik Rediger 78ca696dbd Add documentation as a book 2019-03-19 14:41:38 +01:00
Jan-Erik Rediger 6b4f263ef0 Add initial docs 2019-03-19 14:15:42 +01:00