You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org
Analytics/Systems/Superset: Difference between revisions
imported>Imarlier (Add a note that auto account creation is currently broken, and directing people to the Analytics team.) |
imported>HaeB (context (Druid and Turnilo), start usage notes section) |
||
| Line 1: | Line 1: | ||
[https://superset.incubator.apache.org/ Superset] is an Apache incubator project, originally started at AirBnB. It enables visualizations and dashboards built from various analytics data sources. WMF's | [https://superset.incubator.apache.org/ Superset] is an Apache incubator project, originally started at AirBnB. It enables visualizations and dashboards built from various analytics data sources. WMF's Superset instance can be found at https://superset.wikimedia.org. Like [[Analytics/Systems/Turnilo-Pivot|Turnilo]], it provides access to various [[Analytics/Systems/Druid|Druid]] tables. | ||
== Access == | == Access == | ||
You need a wikitech login that is in the "wmf" or "nda" LDAP groups. If you don't have it, please create a task like [https://phabricator.wikimedia.org/T160662 T160662] | You need a wikitech login that is in the "wmf" or "nda" [[LDAP/Groups|LDAP groups]]. If you don't have it, please create a task like [https://phabricator.wikimedia.org/T160662 T160662]. | ||
Before requesting access, please make sure you: | Before requesting access, please make sure you: | ||
| Line 10: | Line 10: | ||
Once you are in either the wmf or nda LDAP groups, <s>Superset will automatically create an account for you. Just visit https://superset.wikimedia.org.</s> ('''NOTE''': As of September 24, 2018, there is a bug with Superset that means that user accounts are not automatically created. This bug manifests as a stack trace with the message "AttributeError: 'bool' object has no attribute 'login_count'" when attempting to access Superset. If you see this error, request that the Analytics team create your user for you.) | Once you are in either the wmf or nda LDAP groups, <s>Superset will automatically create an account for you. Just visit https://superset.wikimedia.org.</s> ('''NOTE''': As of September 24, 2018, there is a bug with Superset that means that user accounts are not automatically created. This bug manifests as a stack trace with the message "AttributeError: 'bool' object has no attribute 'login_count'" when attempting to access Superset. If you see this error, request that the Analytics team create your user for you.) | ||
== Usage notes == | |||
The [https://superset.wikimedia.org/druiddatasourcemodelview/list/ "Druid Datasources" list]shows ingested tables that are available for querying. As of October 2018, this includes e.g. daily and hourly [[Analytics/Data Lake/Traffic/Pageview hourly|pageviews data]] (the daily version is only updates once a month, but goes further back), a sampled excerpt of webrequest data, unique devices, and a few select EventLogging schemas. | |||
If a recently created Druid datasource is not yet visible in the list, try clicking [https://superset.wikimedia.org/druid/scan_new_datasources/ "Scan New Datasouces"]. | |||
... | |||
== Administration == | == Administration == | ||
Revision as of 01:39, 12 October 2018
Superset is an Apache incubator project, originally started at AirBnB. It enables visualizations and dashboards built from various analytics data sources. WMF's Superset instance can be found at https://superset.wikimedia.org. Like Turnilo, it provides access to various Druid tables.
Access
You need a wikitech login that is in the "wmf" or "nda" LDAP groups. If you don't have it, please create a task like T160662.
Before requesting access, please make sure you:
- have a functioning Wikitech login. Get one: https://toolsadmin.wikimedia.org/register/
- are an employee or contractor with wmf OR have signed an NDA
Depending on the above, you can request to be added to the wmf group or the nda group. Please indicate the motivation on the task about why you need access and ping the analytics team if you don't hear any feedback soon from the Opsen on duty.
Once you are in either the wmf or nda LDAP groups, Superset will automatically create an account for you. Just visit https://superset.wikimedia.org. (NOTE: As of September 24, 2018, there is a bug with Superset that means that user accounts are not automatically created. This bug manifests as a stack trace with the message "AttributeError: 'bool' object has no attribute 'login_count'" when attempting to access Superset. If you see this error, request that the Analytics team create your user for you.)
Usage notes
The "Druid Datasources" listshows ingested tables that are available for querying. As of October 2018, this includes e.g. daily and hourly pageviews data (the daily version is only updates once a month, but goes further back), a sampled excerpt of webrequest data, unique devices, and a few select EventLogging schemas.
If a recently created Druid datasource is not yet visible in the list, try clicking "Scan New Datasouces".
...
Administration
Account Creation
To create a user account, navigate to https://superset.wikimedia.org/users/list/, click the + in the upper right corner, and fill out the former. For most users, set the permission role to 'alpha'.
Upgrading
To upgrade, first follow the instructions in the analytics/superset/deploy README to update the deploy repository. Once deployed, activate the superset virtualenv, add /etc/superset to PYTHONPATH (to allow superset to pick up configuration) and follow the Superset upgrade instructions (minus the pip install superset --upgrade part). This should be something like:
. /srv/deployment/analytics/superset/venv/bin/activate
export PYTHONPATH=/etc/superset
superset db upgrade
superset init