Deployment Statistics

[brianking]

Create scripts, store data, and create API endpoint where a client can get formatted statistics data about the site
Store in CSV format, and/or another appropriate format that is agreed on.

• The client specifies month and year when requesting the data
• When current month data is requested, calculations are done on the fly
• For past months the data is archived, so that the server doesn’t have to re-calculate the stats for every request.
• This is a scaled back version of the original intent if this issue, in that no front-end visualizations are necessary

Original Description
This is a feature request to add a new Admin feature.

This would be a Statistics section, which shows the following data.

• number of extensions in repo
• number of downloads per month (aggregrate of all extensions)
• Stats about contributors (publishers / extension authors) + companies

I suggest having two views:

• Real-time
• Monthly that can be easily presented as a report

This is a need for the open-vsx.org service, and I would see it as a useful feature for all deplyments.

[amvanbaren]

@brianking What stats about contributors (publishers / extension authors) + companies do you want to include in the report?

Download, user and namespace related data is stored without date and time info.
Do you want me to add date and time info to the data model?

[spoenemann]

I think it depends on what "real-time" means. For a monthly report, you could leave the data model as it is and just compute the difference of the stats to the previous month. That could even happen outside of the server, meaning that you'd just offer an export of the data.

[amvanbaren]

Yes, a scheduled job can be run every month that gets the absolute numbers and calculate the numbers relative to the previous month. Month can be replaced with any period (hour, day, week).

[spoenemann]

Ok. Would you schedule that internally (with Spring) or externally (by calling an API endpoint)? The latter could be feasible if we require an access token of an admin user, so the endpoint would be in AdminAPI.

[amvanbaren]

I'd schedule the job internally, store the data in the db and make it available through an endpoint that requires the admin role.

[brianking]

@brianking What stats about contributors (publishers / extension authors) + companies do you want to include in the report?

Download, user and namespace related data is stored without date and time info. Do you want me to add date and time info to the data model?

What would you suggest. I'm thinking:

• number of publishers
• number of publishers with 1, 2, 3 ... extensions listed
• number of publishers that have claimed their namespace
• number of extensions with each star rating
• average number of reviews per extension

I don't think there is a way to collect company information vs individual, because we can't distinguish this based on their account. Correct me if I am wrong.

If you think date and time info is useful, then yes please add it to the data model.

Are we able to detect if downloads/installs were successful?

[amvanbaren]

I don't think there is a way to collect company information vs individual, because we can't distinguish this based on their account.

Yes, there's no distinction between company vs individual.

Are we able to detect if downloads/installs were successful?

The best we can do is detect if the extension was downloaded from Azure blob storage.

[amvanbaren]

@brianking when is a publisher considered the claimer of a namespace?

[brianking]

@brianking when is a publisher considered the claimer of a namespace?

See https://github.com/eclipse/openvsx/wiki/Namespace-Access#how-to-claim-a-namespace