Skip to content

Latest commit

 

History

History
169 lines (117 loc) · 5.62 KB

monitoring_a_live_experiment.rst

File metadata and controls

169 lines (117 loc) · 5.62 KB
Raw

Monitoring a Live Experiment

There are a number of ways that you can monitor a live experiment:

Command line tools

dallinger summary --app {#id}, where {#id} is the id (w...) of the application.

This will print a summary showing the number of participants with each status code, as well as the overall yield:

status  | count
----------------
1   | 26
101 | 80
103 | 43
104 | 2

Yield: 64.00%

The Dashboard

The Dallinger experiment server provides a dashboard view for experiment administrators to monitor running experiments. The dasboard can be found at /dashboard, and requires login credentials that are provided by the commandline output when launching an experiment using dallinger debug, dallinger sandbox, or dallinger deploy.

When running under dallinger debug a browser window should open with the dashboard already logged in. When running on Heroku, the dashboard username and password can also be found in the heroku configuration parameters DASHBOARD_USER and DASHBOARD_PASSWORD.

Customizing the Dashboard

dallinger.experiment_server.dashboard

You can add custom tabs to the Dallinger Dashboard by adding and registering new Flask routes on the dashboard Blueprint, and resgistering the view as a dashboard_tab. For example in your experiment.py you could add the following code to add a "My Experiment" tab to the dashboard:

from dallinger.experiment_server.dashboard import dashboard, dashboard_tabs

@dashboard.route("my-experiment")
def my_experiment():
  return "Hello, World. This is some information about My Experiment"

dashboard_tabs.insert("My Experiment", "my-experiment")

The dashboard also supports nested tab/menus using the ~dallinger.experiment_server.dashboard.DashboardTab object:

from dallinger.experiment_server.dashboard import dashboard_tabs, DashboardTab

def child_tabs():
    return [DashboardTab('Child1', 'child1'), DashboardTab('Child2', 'child2')]

complex_tab = DashboardTab('Title', 'route_name', child_tabs)
dashboard_tabs.insert_tab(complex_tab)

The dashboard_tabs object supports the following methods for managing the available tabs on your experiment's dashboard:

DashboardTabs

insert

insert_tab

insert_before_route

insert_tab_before_route

insert_after_route

insert_tab_after_route

remove

The ~dallinger.experiment_server.dashboard.DashboardTab object used by the various insert_tab* methods provide the following API:

DashboardTab

__init__

The dashboard monitoring view can be extended by adding panes to the sidebar or extending the existing panes. This can be done customizing the ~dallinger.experiment.Experiment.monitoring_panels and/or ~dallinger.experiment.Experiment.monitoring_statistics methods of your experiment class. Additionally, you can customize the display of the selected nodes customizing the ~dallinger.experiment.Experiment.node_visualization_html method, or the ~dallinger.models.SharedMixin.visualization_html property on your model class:

dallinger.experiment

Experiment

monitoring_panels

monitoring_statistics

node_visualization_html

Papertrail

You can use Papertrail to view and search the live logs of your experiment. You can access the logs either through the Heroku dashboard's Resources panel (https://dashboard.heroku.com/apps/{#id}/resources), where {#id} is the id of your experiment, or directly through Papertrail.com (https://papertrailapp.com/systems/{#id}/events).

Setting up alerts

You can set up Papertrail to send error notifications to Slack or another communications platform.

  1. Take a deep breath.
  2. Open the Papertrail logs.
  3. Search for the term error.
  4. To the right of the search bar, you will see a button titled "+ Save Search". Click it. Name the search "Errors". Then click "Save & Setup an Alert", which is to the right of "Save Search".
  5. You will be directed to a page with a list of services that you can use to set up an alert.
  6. Click, e.g., Slack.
  7. Choose the desired frequency of alert. We recommend the minimum, 1 minute.
  8. Under the heading "Slack details", open (in a new tab or window) the link new Papertrail integration.
  9. This will bring you to a Slack page where you will choose a channel to post to. You may need to log in.
  10. Select the desired channel.
  11. Click "Add Papertrail Integration".
  12. You will be brought to a page with more information about the integration.
  13. Scroll down to Step 3 to get the Webhook URL. It should look something like https://hooks.slack.com/services/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.
  14. Copy this link to your clipboard.
  15. Change anything else you want and then scroll to the bottom and click "Save integration".
  16. Go back to Papertrail page that you left in Step 7.
  17. Paste the copied URL into the input text box labeled "Integration's Webhook URL" under the "Slack Details" heading.
  18. Click "Create Alert" on the same page.
  19. Victory.