Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

IoT/Community metrics

< IoT

In just a few years, Eclipse IoT has been very successful at growing a community of open-source projects that can be used for building M2M and IoT solutions.

In order to help project leads and the community at large to monitor the health and growth of their projects, this page lists past community reports together with some best practices to ensure metrics can be collected and analyzed.

Access community reports

You can access previous monthly reports directly from this Google Drive shared folder.

Project metrics

Eclipse Dashboard (Number of commits, Closed tickets, etc.)

The Eclipse Dashboard allows project to access metrics (including trends) such as # of commits per month, # of Bugzilla tickets closed, etc.

It is available at http://dashboard.eclipse.org.

Web traffic

If you run an Eclipse IoT project, you should make sure to use Google Analytics to monitor stats about the traffic on your webpage.

Here's how you would create and use a Google Analytics tracking code: link

You can embed the tracking code directly in your web pages or, if you website is powered by Phoenix/Solstice, you can use $App to do it more automatically (see the wiki page)

Note.png
In order to allow Eclipse Foundation's staff to consolidate statistics for all projects, please give eclipsefdn@gmail.com "Read & Analyze" access to your statistics.
This can be done from Google Analytics' Administration UI, in the User Management section of your account. More info: here.

Downloads

Hopefuly, your project is delivering artifacts (binaries, source code distributions, p2 repositories, ...), and it is a very good idea to make sure those deliverables' download stats are tracked.

If you provide zip files, debian packages, etc. you should make sure that they are actually served through Eclipse mirrors ; not only does it mean people will likely get faster download speeds, but also the downloads will be tracked. See this wiki page to learn how to use the so-called mirror script.

If you provide p2 repositories, you have to follow this documentation.

Eclipse committers can access download stats from the Portal.

Number of Lines of Code

A tool like cloc can be very useful to count the number of lines of code in your project. git-cloc-history can provide you with the history of the number of lines of code over the life of your project.

This Node.js script can also help you deal with multiple git repositories more easily, and produces CSV output that can easily be fed into a spreadsheet + pivot table. Note that it is a very experimental work :)


Consolidated metrics

In order to assess the success of Eclipse IoT at large, the following metrics will be consolidated across all projects and regular reports (monthly or quarterly) will be produced.

Web traffic

Eclipse Foundation consolidates Google Analytics statistics under a common umbrella. You can see the latest stats regarding using unique visitors per month here.

IoT Sandboxes

In order to monitor the popularity of the Eclipse IoT sandboxes, it is proposed to start tracking the following metrics:

  • MQTT / Mosquitto
    • Number of active clients
  • CoAP / Californium
    • what can we monitor???
    • proposition: using the logs, count the number of unique IPs who made a CoAP connection per month
  • Ponte
    • what can we monitor???
  • LwM2M / Leshan
    • Number of active clients
    • proposition: using the logs, count the number of unique IPs who made a LwM2M connection per month
  • M3DA

Copyright © Eclipse Foundation, Inc. All Rights Reserved.