1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# Welcome to Libusermetrics
Libusermetrics enables apps to locally store interesting numerical data
for later presentation. For example in the Ubuntu Greeter "flower"
infographic.
- All data is stored locally in /var/usermetrics/.
- No data is centrally collected via a web-serivice or otherwise, and
no data is sent over the internet.
The only data that can be stored is numerical, for example "number of
e-mails" or "number of pictures taken". No personally identifying
information is stored using this library.
**WARNING:** This API should be considered private, and is only for use by
first party applications at present. It may change or be removed at any
time.
## Getting and installing libusermetrics
### Using pre-built packages
If you just want to try out libusermetrics, or write user metrics sources,
then the easiest way is to use the [pre-built packages](doc/pages/installing_prebuilt.md).
### Building and installing from source
If you are curious about libusermetrics's internals or intend to contribute to
it, you should [get the source and build it](doc/pages/building_source.md).
Getting involved
----------------
The best place to ask questions and discuss about libusermetrics is the \#ubuntu-touch
IRC channel on freenode.
The libusermetrics project is hosted on GitLab: https://gitlab.com/ubports/core/libusermetrics
Please file bug reports at: http://gitlab.com/ubports/core/libusermetrics/-/issues
Writing metric data sources
---------------------------
- \ref UserMetricsInput "Libusermetrics Input API Documentation"
For simple metrics which only want to increment a counter, see the following examples:
- \subpage MetricManagerIncrementToday.cpp "MetricManagerIncrementToday.cpp: A simple Qt-based metric"
- \subpage MetricManagerIncrementTodayCAPI.c "MetricManagerIncrementTodayCAPI.c: A simple C-based metric"
For simple metrics which only want to update today's value, but cannot simply increment it,
see the following examples:
- \subpage MetricManagerUpdateToday.cpp "MetricManagerUpdateToday.cpp: A simple Qt-based metric"
- \subpage MetricManagerUpdateTodayCAPI.c "MetricManagerUpdateTodayCAPI.c: A simple C-based metric"
For more sophisticated metrics, which wish to update the history of the metric, for
example if the user has been offline for a week. Please see the following examples:
- \subpage MetricManagerAdvanced.cpp "MetricManagerAdvanced.cpp: A Qt-based metric"
- \subpage MetricManagerAdvancedCAPI.c "MetricManagerAdvancedCAPI.c: A C-based metric"
Writing a presentation application
----------------------------------
To write a metric presentation application, there is a Qt API.
- \ref UserMetricsOutput "Libusermetrics Output API Documentation"
- A good example to refer to is the
[infographics](https://gitlab.com/ubports/core/lomiri/-/blob/main/qml/Greeter/Infographics.qml)
for the Lomiri greeter.
|
