Get Objectiv Up

Objectiv Up is a pre-packaged, dockerized version of Objectiv that's ready to use. Objectiv Up enables you to self-host Objectiv's open-source analytics platform in under five minutes - 100% free & open-source, and preconfigured with pre-built models & dashboards. A demo app instrumented with the Objectiv Tracker is also included for testing purposes.

Running Objectiv Up

Assuming you have Docker and Curl installed, run the following commands:

curl -o docker-compose.yaml https://raw.githubusercontent.com/objectiv/objectiv-analytics/main/docker-compose.yaml
docker-compose pull
docker-compose up -d

This will spin up the following containers:

  • objectiv_website A local version of the objectiv.io website, instrumented with the Objectiv Tracker.
  • objectiv_collector: An Objectiv Collector backend to validate & store event data from the Tracker.
  • objectiv_postgres: A PostgreSQL database, pre-filled with anonymized demo user data.
  • objectiv_notebook: A Jupyter Notebook environment with pre-built product & marketing notebooks.
  • objectiv_metabase: Open-source BI-tool Metabase with pre-built product & marketing dashboards.

Exploring & modeling data

Objectiv Up includes pre-built notebooks for product & marketing analytics. You can run these straight on the demo or later your own data. There are more example notebooks that go deeper. You can also run these as a Jupyter Notebook.

To explore & run the notebooks in Objectiv Up, open the following URL in your browser:

http://localhost:8888/lab/tree/basic-product-analytics.ipynb?token=objectiv

For detailed modeling instructions, check out our modeling docs.

BI dashboards

Objectiv Up includes Metabase as BI tool, but it will work with any SQL powered BI. There are two example dashboards that are pre-built for product & marketing analytics.

To open them in Metabase, go to http://localhost:3000.

Username:

demo@objectiv.io

Initial password:

metabase1

After the first login, you can change these details here.

Creating BI Dashboards

If you would like to change any of the dashboards, or create new ones, these are the steps to take:

  1. Create a new DataFrame in your notebook that gives the desired results, or change any of the pre-built ones in the product & marketing analytics notebooks.
  2. Generate the SQL for your DataFrame using:
display_sql_as_markdown(NAME_OF_YOUR_DATAFRAME)
  1. Open Metabase and in the top navigation, select "+ New" and then "SQL query".
  2. Copy-paste the generated SQL from your notebook into Metabase, execute it, and choose a visualization for a dashboard view.

If you run anything other than Metabase, this will also work with the same flow for any SQL-speaking BI tool.

Generating Events

To generate event data yourself, simply go to the local version of the Objectiv website and click around. When you trigger an event, you can see a request show up in your docker logs. If you used a terminal to spin up the containers, it shows there as well. Both notebooks will show the new events if you rerun any of the cells.

Instrument your own website or app

You can seamlessly switch Objectiv Up from the demo website to your own website or app; the steps to take:

  1. Clean up the demo data
echo "TRUNCATE data" | docker exec -i objectiv_postgres psql -U objectiv
  1. Instrument your app with the Objectiv tracker.
  2. Configure the tracker to use the Collector by setting the endpoint to http://127.0.0.1:8081; here is an example on how to do that for React Native.
note

Restarting the notebook container will reset (restore) the database, causing any generated data to be lost.

Set OBJECTIV_SKIP_IMPORT to true to prevent this.

To get help in setting this up, we are happy to get you going on Slack.

You can now reuse the notebooks and dashboards straight on your own data.

Get help

If you have any questions, please join us on Slack.

Run Objectiv fully managed

Check out Objectiv Cloud - run Objectiv at massive scale without worrying about the Ops part.