The Analytics Events Archive¶
BinderHub emits an event each time a repository is launched. They are recorded as JSON, and made available to the public at archive.analytics.mybinder.org.
This page describes what is available in the Events Archive & how to interpret it.
All data files are in jsonl format. Each line,
delimited by a
\n is a is a well formed JSON object. These files can
be read / written in a streaming fashion, one line at a time, without
having to read the entire file into memory.
Launch data by date¶
For each day since we started keeping track (2018-11-03), there is a
events-<YYYY>-<MM>-<DD>.jsonl that contains data for
all the launches performed by mybinder.org on that date. All timestamps
and dates are in UTC.
Each line is a JSON object that conforms to this JSON Schema. A description of these fields is provided below.
schema and version
Currently set to
1respectively. These identify the kind of event this is (a launch event from BinderHub) and the current version of the event schema. This lets us evolve the format of the events emitted without breaking existing analytics code. New versions of the launch schema may add additional fields, or change meanings of current ones. We will definitely add other events that are available here too - for example, successful builds.
Your analytics code must make sure the event you are parsing has the schema and version you are expecting before proceeding. If you don’t do this, your code might fail in unexpected ways in the future.
ISO8601 formatted timestamp when the event was emitted. These are rounded down to the closest minute. The lines in the file are ordered by timestamp, starting at the earliest.
Where the launched repository was hosted. Current options are
Specification identifying the repository / commit immutably & uniquely in the provider.
For GitHub, it is
<repo>/<commit-spec>. Example would be
yuvipanda/example-requirements/master. For GitLab, it is
repois URL escaped. For raw Git repositories, it is
repo-urlis full URL escaped to the repo and
commit-specis a full commit hash.
Wether the launch succeeded (
success) or failed (
failure). Currently only successful launches are recorded.
Some popular ways of reading this event data into a useful data structure are provided here.
import pandas as pd df = pd.read_json("https://archive.analytics.mybinder.org/events-2018-11-05.jsonl", lines=True) df
import requests import json response = requests.get("https://archive.analytics.mybinder.org/events-2018-11-05.jsonl") data = [json.loads(l) for l in response.iter_lines()]
The index.jsonl file lists all the dates an event archive is available for. The following fields are present for each line:
The UTC date the event archive is for
The name of the file containing the events. This is a relative path - since we got the
index.jsonlfile from https://archive.analytics.mybinder.org, that is the base URL used to resolve these. For example when
events-2018-11-05.jsonl, the full URL to the file is
Total number of events in the file.