Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add Tableau dashboard metadata extractors (#333)
Signed-off-by: Tao Feng <fengtao04@gmail.com>
- Loading branch information
1 parent
60c837d
commit 46207ee
Showing
15 changed files
with
1,725 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
12 changes: 12 additions & 0 deletions
12
databuilder/extractor/dashboard/tableau/tableau_dashboard_constants.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| API_VERSION = 'api_version' | ||
| TABLEAU_HOST = 'tableau_host' | ||
| SITE_NAME = 'site_name' | ||
| TABLEAU_ACCESS_TOKEN_NAME = 'tableau_personal_access_token_name' | ||
| TABLEAU_ACCESS_TOKEN_SECRET = 'tableau_personal_access_token_secret' | ||
| EXCLUDED_PROJECTS = 'excluded_projects' | ||
| EXTERNAL_CLUSTER_NAME = 'external_cluster_name' | ||
| EXTERNAL_SCHEMA_NAME = 'external_schema_name' | ||
| EXTERNAL_TABLE_TYPES = 'external_table_types' | ||
| CLUSTER = 'cluster' | ||
| DATABASE = 'database' | ||
| VERIFY_REQUEST = 'verify_request' |
134 changes: 134 additions & 0 deletions
134
databuilder/extractor/dashboard/tableau/tableau_dashboard_extractor.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| import logging | ||
| from typing import Any, Dict, Iterator, List | ||
|
|
||
| from pyhocon import ConfigFactory, ConfigTree | ||
|
|
||
| import databuilder.extractor.dashboard.tableau.tableau_dashboard_constants as const | ||
| from databuilder import Scoped | ||
| from databuilder.extractor.base_extractor import Extractor | ||
| from databuilder.extractor.dashboard.tableau.tableau_dashboard_utils import TableauGraphQLApiExtractor,\ | ||
| TableauDashboardUtils | ||
| from databuilder.extractor.restapi.rest_api_extractor import STATIC_RECORD_DICT | ||
| from databuilder.transformer.base_transformer import ChainedTransformer | ||
| from databuilder.transformer.base_transformer import Transformer | ||
| from databuilder.transformer.dict_to_model import DictToModel, MODEL_CLASS | ||
| from databuilder.transformer.timestamp_string_to_epoch import TimestampStringToEpoch, FIELD_NAME | ||
|
|
||
|
|
||
| LOGGER = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class TableauGraphQLApiMetadataExtractor(TableauGraphQLApiExtractor): | ||
| """ | ||
| Implements the extraction-time logic for parsing the GraphQL result and transforming into a dict | ||
| that fills the DashboardMetadata model. Allows workbooks to be exlcuded based on their project. | ||
| """ | ||
|
|
||
| CLUSTER = const.CLUSTER | ||
| EXCLUDED_PROJECTS = const.EXCLUDED_PROJECTS | ||
| TABLEAU_HOST = const.TABLEAU_HOST | ||
|
|
||
| def execute(self) -> Iterator[Dict[str, Any]]: | ||
| response = self.execute_query() | ||
|
|
||
| workbooks_data = [workbook for workbook in response['workbooks'] | ||
| if workbook['projectName'] not in | ||
| self._conf.get_list(TableauGraphQLApiMetadataExtractor.EXCLUDED_PROJECTS)] | ||
|
|
||
| for workbook in workbooks_data: | ||
| data = { | ||
| 'dashboard_group': workbook['projectName'], | ||
| 'dashboard_name': TableauDashboardUtils.sanitize_workbook_name(workbook['name']), | ||
| 'description': workbook.get('description', ''), | ||
| 'created_timestamp': workbook['createdAt'], | ||
| 'dashboard_group_url': 'https://{}/#/projects/{}'.format( | ||
| self._conf.get(TableauGraphQLApiMetadataExtractor.TABLEAU_HOST), | ||
| workbook['projectVizportalUrlId'] | ||
| ), | ||
| 'dashboard_url': 'https://{}/#/workbooks/{}/views'.format( | ||
| self._conf.get(TableauGraphQLApiMetadataExtractor.TABLEAU_HOST), | ||
| workbook['vizportalUrlId'] | ||
| ), | ||
| 'cluster': self._conf.get_string(TableauGraphQLApiMetadataExtractor.CLUSTER) | ||
| } | ||
| yield data | ||
|
|
||
|
|
||
| class TableauDashboardExtractor(Extractor): | ||
| """ | ||
| Extracts core metadata about Tableau "dashboards". | ||
| For the purposes of this extractor, Tableau "workbooks" are mapped to Amundsen dashboards, and the | ||
| top-level project in which these workbooks preside is the dashboard group. The metadata it gathers is: | ||
| Dashboard name (Workbook name) | ||
| Dashboard description (Workbook description) | ||
| Dashboard creation timestamp (Workbook creationstamp) | ||
| Dashboard group name (Workbook top-level folder name) | ||
| Uses the Metadata API: https://help.tableau.com/current/api/metadata_api/en-us/index.html | ||
| """ | ||
|
|
||
| API_VERSION = const.API_VERSION | ||
| CLUSTER = const.CLUSTER | ||
| EXCLUDED_PROJECTS = const.EXCLUDED_PROJECTS | ||
| SITE_NAME = const.SITE_NAME | ||
| TABLEAU_HOST = const.TABLEAU_HOST | ||
| TABLEAU_ACCESS_TOKEN_NAME = const.TABLEAU_ACCESS_TOKEN_NAME | ||
| TABLEAU_ACCESS_TOKEN_SECRET = const.TABLEAU_ACCESS_TOKEN_SECRET | ||
| VERIFY_REQUEST = const.VERIFY_REQUEST | ||
|
|
||
| def init(self, conf: ConfigTree) -> None: | ||
| self._conf = conf | ||
| self.query = """query { | ||
| workbooks { | ||
| id | ||
| name | ||
| createdAt | ||
| description | ||
| projectName | ||
| projectVizportalUrlId | ||
| vizportalUrlId | ||
| } | ||
| }""" | ||
|
|
||
| self._extractor = self._build_extractor() | ||
|
|
||
| transformers: List[Transformer] = [] | ||
| timestamp_str_to_epoch_transformer = TimestampStringToEpoch() | ||
| timestamp_str_to_epoch_transformer.init( | ||
| conf=Scoped.get_scoped_conf(self._conf, timestamp_str_to_epoch_transformer.get_scope()).with_fallback( | ||
| ConfigFactory.from_dict({FIELD_NAME: 'created_timestamp', }))) | ||
| transformers.append(timestamp_str_to_epoch_transformer) | ||
|
|
||
| dict_to_model_transformer = DictToModel() | ||
| dict_to_model_transformer.init( | ||
| conf=Scoped.get_scoped_conf(self._conf, dict_to_model_transformer.get_scope()).with_fallback( | ||
| ConfigFactory.from_dict( | ||
| {MODEL_CLASS: 'databuilder.models.dashboard.dashboard_metadata.DashboardMetadata'}))) | ||
| transformers.append(dict_to_model_transformer) | ||
| self._transformer = ChainedTransformer(transformers=transformers) | ||
|
|
||
| def extract(self) -> Any: | ||
| record = self._extractor.extract() | ||
| if not record: | ||
| return None | ||
|
|
||
| return self._transformer.transform(record=record) | ||
|
|
||
| def get_scope(self) -> str: | ||
| return 'extractor.tableau_dashboard_metadata' | ||
|
|
||
| def _build_extractor(self) -> TableauGraphQLApiMetadataExtractor: | ||
| """ | ||
| Builds a TableauGraphQLApiMetadataExtractor. All data required can be retrieved with a single GraphQL call. | ||
| :return: A TableauGraphQLApiMetadataExtractor that provides core dashboard metadata. | ||
| """ | ||
| extractor = TableauGraphQLApiMetadataExtractor() | ||
| tableau_extractor_conf = \ | ||
| Scoped.get_scoped_conf(self._conf, extractor.get_scope())\ | ||
| .with_fallback(self._conf)\ | ||
| .with_fallback(ConfigFactory.from_dict({TableauGraphQLApiExtractor.QUERY: self.query, | ||
| STATIC_RECORD_DICT: {'product': 'tableau'} | ||
| } | ||
| ) | ||
| ) | ||
| extractor.init(conf=tableau_extractor_conf) | ||
| return extractor |
Oops, something went wrong.