Solid Pancakes is an event-based consumer that tracks usages on the TFS products.
npm ci
npm run start
npm run build
node dist/main.js
See the configuration keys with the Ansible playbook
To help you configure your local environment to generate a dotenv file you can use the configurator using this command:
node configurator.js create solid-pancake --conf-path [local copy of ansible volume]/conf --force-http true
Each tracking starts with a session. A session is considered to be a usage by anyone on a product. Each session is associated with a product, a version, and a date.
Next, the tracking goes with the events. An event can be anything (a view, a click, etc.) and is registered to record the actions of the user within the session. Each event are related to a session, not a user.
We do not known how the data collected is used through the Google's products. Moreover, the data is not stored in european databases, that can cause some legal problems.
Solid Pancake is a self-hosted service that can secure, provide and properly delete usage data.
There is NO user-related data in Solid Pancake. Each session is anonymous =)
sirup.js is a way to use the Solid Pacake API on a frontend interface.
Add the library to your code:
<script src="https://solid-pancake.thefirstspine.fr/sirup.js"></script>
Then, register the page:
<script>sirup.persistantSession('MY_SERVICE', navigator.platform).then(() => { sirup.event('viewPage', 'navigation', document.location.href); })</script>
Scenario: bootstrap(config)
Start the sirup.js library
Scenario: async persistantSession(product, label = '', version = '')
Looks for a session ID corresponding to product / label / version triplet. Store this ID if found, otherwise create the session to Solid Pancake.
Scenario: async session(product, label = '', version = '')
Creates a session in Solid Pancake.
Register an event in Solid Pancake
Scenario: event(event, category, action = '', label = '')
Call the Solid Pancake API
Scenario: async call(endpoint, data)