Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SLEEP-1499 Support embedding of Superset dashboard in Iaso #1698

Merged
merged 6 commits into from
Dec 16, 2024

Conversation

bramj
Copy link
Contributor

@bramj bramj commented Oct 10, 2024

This PR contains a v1 for embedding Superset dashboards in Iaso, using the Pages model.

Specifically:

  • Add a new pages template that supports embedding a new type of page "SUPERSET"
  • Add an API endpoint POST /api/superset/token that creates a Superset "guest token" for a specific dashboard

Related JIRA tickets : https://bluesquare.atlassian.net/browse/SLEEP-1499

Note that this is a v1. In order to make this properly usable for regular users, I think we should have a place where you can configure the connection to such a dashboard for a given account.

image

How to test

  1. Create a Superset dashboard, make it embeddable, this will give you a dashboard_id.
  2. Create an embedded page of type "Superset". Set the dashboard_id of the dashboard you want to embed.
  3. Visit the page, you should now see your dashboard.
  4. In the admin page you can configure the UI config options for your dashboard.
    example config:
{
  "hideTab": true,
  "hideTitle": true,
  "hideChartControls": true,
  "filters": {
    "visible": false,
    "expanded": false
  },
}

(On Trypelim, I have only the hideTab and hideTitle set. Filters are useful and chart controls allow things like exporting CSV data)

@beygorghor beygorghor requested a review from madewulf October 17, 2024 07:43
docker-compose.yml Outdated Show resolved Hide resolved
@bramj bramj self-assigned this Oct 22, 2024
- Add a new pages template that supports embedding a new type of page
"SUPERSET"
- Add an API endpoint POST /api/superset/token that creates a Superset
"guest token" for a specific dashboard
@bramj bramj force-pushed the SLEEP-1499-embed-superset branch from 86bf50d to c137bca Compare December 6, 2024 12:28
@bramj
Copy link
Contributor Author

bramj commented Dec 6, 2024

@beygorghor What do you think of this commit? 0ef8748

@madewulf Okay for re-review!

@bramj bramj requested a review from madewulf December 6, 2024 15:47
@beygorghor beygorghor self-requested a review December 11, 2024 08:51
@bramj bramj merged commit 6780f6b into main Dec 16, 2024
3 checks passed
@bramj bramj deleted the SLEEP-1499-embed-superset branch December 16, 2024 10:10
@tdethier tdethier added user tested Has already been tested on staging ok for release Released and removed ok for release labels Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Released user tested Has already been tested on staging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants