A Library for Homemade Analytics with Elixir and Ecto

I recently read the wonderful article Homemade Analytics with Elixir and Ecto by @josevalim and decided on using the described approach in a couple of my projects. I didn’t want to copy&paste the code into every project and decided on creating a library instead.

Disclaimer: I absolutely do not want to take credit for José’s code, so I tried to reference his blog article everywhere I could. This library is simply meant as a helper for using his code in your project.

AnalyticsEx

GitHub: https://github.com/PJUllrich/analytics_ex
Hex: https://hexdocs.pm/analytics_ex/api-reference.html

A library tracking how many visitors a Phoenix-based application receives per day without collecting any data from the user. It encapsulates the Homemade Analytics code of José Valim and simply counts the page-requests per path per day. The collected data is stored in a configurable Ecto-repository.

I hope that you find this helpful. My next steps will be to create a nice UI for the collected data. Feel free to help and contribute :slight_smile:

18 Likes

Awesome work!

After I announced the blog post, I learned about Plausible.io, which is an open source analytics focused on privacy that is written in Elixir. We are using them since then and we are very happy with it, so I definitely recommend them.

So between analytics_ex and plausible, it seems we are well served in the analytics area. :slight_smile:

14 Likes

This was really helpful but I found that using it with liveview won’t work on routes that go though the socket connection on push_patches. Is there an idiomatic way of doing this that tracks all routes going through the router in a liveview project? @josevalim

I just released a small addition, which is bump_with_uri/1. You can now bump the metrics whenever you have a URI like in the handle_params/3 function of your LiveView. Simply call:

def handle_params(params, uri, socket) do
  AnalyticsEx.Metrics.bump_with_uri(uri)

  # Do other stuff here
end

If you really want to be sure that the metric was bumped, you can check the return value of bump_with_uri/1, which is either :ok or {:error, :path_not_found}, if URI.parse/1 doesn’t return a value for path.

If you want to use this functionality, simply update AnalyticsEx to 0.1.1.

@gordoneliel I hope this solves your problem as well. Sorry, I didn’t see your message until now.

2 Likes

I added a LiveDashboard-page to AnalyticsEx which gives you a quick overview of the counted requests per day, week, and month.

Simply update AnalyticsEx to 0.2.1 and include this in the live_dashboard route in your router.ex.

live_dashboard "/dashboard",
      additional_pages: [
        {:analytics, AnalyticsEx.LiveDashboard.AnalyticsPage}
      ]

You will then have a Tab called Analytics in your LiveDashboard!

If you want to always ignore certain routes in the overview, add them to the live_dashboard-route:

live_dashboard "/dashboard",
      additional_pages: [
        {:analytics, {AnalyticsEx.LiveDashboard.AnalyticsPage, ignore: ["/this-route", "/and-this-route-including-subpaths"]}
      ]

It’s been a bit tricky to add this tab to LiveDashboard using the predefined components, mostly because LiveDashboard was not yet refactored enough in order support adding custom pages with ease. I will create a GitHub ticket for the issues I had with adding this page, but in general, it only took me 1 day to include this page and that is without having any examples! So, it certainly is possible :slight_smile:

10 Likes