keep track of your app distributions
to get downloads, :vita periodically scrys %cs /subs for each desk and caches the results.
:vita accepts foreign pokes attesting to activity on a desk.
/lib/vita-client.hoon helps any agent send vita activity pokes.
it sends a maximum of one poke per day, and allows users to opt-in / opt-out depending on developer preference.
on-init, vita will fetch 'downloader' metrics on all of your published desks and print them out to dojo.
vita: our %basket has 20 subs
vita: our %noodle has 12 subs
vita: our %houston has 133 subs
vita: our %radio has 326 subs
this tells you how many active urbit ships are signed up for OTAs for each desk.
you can run this routine whenever you want with :vita|g
:vita automatically checks :treaty for published desks.
to register a different desk (e.g. %kids), do :vita|g %kids
vita: our %kids has 0 subs
> :vita|g %kids
>=
now, whenever :vita does its full routine, %kids will be included.
vita: our %kids has 0 subs
vita: our %basket has 20 subs
vita: our %noodle has 12 subs
vita: our %houston has 133 subs
vita: our %radio has 326 subs
> :vita|g
>=
to unregister a desk: :vita|d %kids. WARNING: all data collected on an unregistered desk will be lost.
once every 24 hours, :vita grabs downloads metrics on each registered desk using .^((set ship) %cs /=mydesk=/subs). every time this scry is performed, :vita logs the size of the set with a timestamp. :vita keeps one copy of the latest full set of downloaders, and a cumulative set of all unique downloaders.
when users unsync from your local desk, latest.downloads wont go down until your next |commit to the desk.
cumulative.downloads only goes up.
to see all cumulative sizes: =t +vita!total
vita: %basket has 24 cumulative downloads
vita: %noodle has 14 cumulative downloads
vita: %houston has 139 cumulative downloads
vita: %radio has 359 cumulative downloads
> =t +vita!total
over time, :vita accumulates a history=(list [time=@da size=@ud]) for each desk.
to change the interval for automatic collection: :vita|i ~h8 will change it to 8 hours from the default 24
to turn off the interval: :vita|i (no arg)
:vita is also capable of collecting daily-active-users.
vita accepts vita-action+[%activity =desk] pokes from any source. it logs daily active users by adding users to a latest=(set ship).
this set is cleared once a day. vita keeps record of the max size of this set each day in history.activity
now you just need users to poke :~your-planet/vita &vita-action [%activity %yourdesk] every time they use your app.
/lib/vita-client/hoon has a wrapper agent which does just that.
to use it, copy over <this_repo>/vita-client/* into your app desk, then /+ vita-client and wrap your agent with
%- %- agent:vita-client
:: data collection on/off by default
:- &
:: @p of your distributor ship
~sampel-palnet
...you will also need to give the (active:vita-client bowl) card somewhere in your agent where real user activity can be detected (e.g. on-watch for a frontend subscription path). this card will induce vita-client to send activity upstream to the parent vita.
vita-client is initialized with a boolean (sets collection on/off by default), and the @p of your distributor ship (running vita, with the app registered).
users can turn vita-client data collection on/off with :myagent +mydesk!enable-vita or :tenna +mydesk!disable-vita.
this uses some generators packaged with vita-client. the actual poke is just :myagent &vita-client [%set-enabled |]
vita-client sends a max of one activity poke per-day.
the frontend is implemented in sail. it displays the latest downloads and activity data, and provides some links to the historical csv data.
it shows the src.bowl and now.bowl from :vita at http request time.
a screenshot of the frontend is a sufficient way to store and share your analytics.
for convenience, vita exports its state as CSV. two files are available: downloads.csv and activity.csv.
these tables chart changes over time, and can be visualized as multiple line graphs.
this reduces a more complex dataset (stored as an app-metrics noun, see /sur/vita.hoon) into common rows.
https://yourship.com/~/scry/vita/activity.csv
https://yourship.com/~/scry/vita/downloads.csv
please reference /app/vita/hoon +on-peek. for ergonomic access, data is available as noun marks rather than just a bespoke type.
that way you can scry out some info you need without having to build the sur file and climb down the tree.
e.g. .^((set ship) %gx /=vita=/activity/latest/radio/noun)
the full dataset for any given desk can be scryd as json in case anyone wants to do finer analysis.
|install ~nodmyn-dosrux %vita
- create a blank
%vitadesk. - copy in basic app dependencies.
|mount %vita- cd
<this_repo>/vita ./install.sh -w <my_pier>/vita|commit %vita|install our %vita