Analytics/Systems/Dashiki/Configuration

From Wikitech
Jump to navigation Jump to search

The Dashiki dashboarding system depends on articles on meta.wikimedia.org to configure dashboards and related metadata, such as annotations. Here we describe these configuration files and the schemas they use. Currently, these schemas are not enforced when you save an article, so users are responsible for making sure the configuration works.

Annotations

Articles that specify annotations to use on dashboards need to have a path such as

Config:Dashiki:Annotations/<<project name>>/<<metric name>>

Where <<project name>> is something like Wikistats and <<metric name>> is something like editors. So, a concrete example is https://meta.wikimedia.org/wiki/Config:Dashiki:Annotations/Wikistats/totalPageViews. Annotations can be defined here in the following format:

description: -- text describing this set of annotations
documentation: -- link to the metric's research page or other context
annotations: -- a list of annotations using one of these patterns:
    - date:
      title: 
      note: 

    - date:
      title:
      note: 
      relevantBreakdowns: -- list of splits to limit annotations to
          - dimension: -- the split (eg. editor_type) or "total" for no breakdown
            values: -- list of breakdown values to limit to, eg.:
                - group-bot
                - anonymous

Take a look at the examples or ask questions on the talk page here. The slightly complicated thing is that if you choose to use relevantBreakdowns, you need to include the "total" dimension in the list, with values: [ "total" ] if you want to also show the breakdown on the main, un-split graph.

Dashboards

Articles that specify dashboard configurations need to have a path such as

Config:Dashiki:<<dashboard name>>

The format for the configuration depends on what type of layout your dashboard is using. These are detailed below:

Tabs Layout

Compare Layout

Metric by Project Layout