Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-htmltrue
scroll-epubtrue

Open in new tab

About Collectors

Insert excerpt
Collector Method
Collector Method
nameabout

...

Pre-requisites

Collector Server Minimum Requirements

...

Info

Lineage limitations in regards to Dataset Fields to Pages, lineage for this is dependant on the ability to export the PowerBI Report to analyse the pbix file. If we are unable to download the pbix file, this lineage will be missing for that report.
https://learn.microsoft.com/en-us/power-bi/create-reports/service-export-to-pbix

...

Step 1: Create the Source in K

Create a Power BI source in K

  • Go to Settings, Select Sources and click Add Source

  • Select “Load from File” option

  • Give the source a Name - e.g. PowerBI Production

  • Add the Host name for the PowerBI Server

  • Click Finish Setup

...

Step 2: Getting Access to the Source Landing Directory

Insert excerpt
Collector Method
Collector Method
namelanding

...

Step 3: Install the Collector

It is recommended to use a python environment such as pyenv or pipenv if you are not intending to install this package at the system level.

...

Code Block
pip install kada_collectors_lib-<version>-none-any.whl

...

Step 4: Configure the Collector

The collector requires a set of parameters to connect to and extract metadata from Power BI

...

Code Block
languagejson
{
    "client": "",
    "secret": "",
    "tenant": "",
    "output_path": "/tmp/output",
    "mask": true,
    "timeout": 20,
    "export_timeout": 120,
    "filter_flag": true,
    "filter_workspaces": []
    "mapping": {
        "myDSN": {
            "host": "myhost",
            "database": "mydatabase"
        }
    },
    "compress": true
}

...

Step 5: Run the Collector

The following code is an example of how to run the extractor. You may need to uplift this code to meet any code standards at your organisation.

...

client: The Client ID for the registered application for access to PowerBI APIs
secret: The Secret for the registered application for access to PowerBI APIs
tenant: The Tenant ID for the registered application for access to PowerBI APIs
mapping: Dict of DNS to database and hostnames
filter_flag: Should we be filtering out workspaces based on filter_workspaces as a whitelist
filter_workspaces: whitelist of workspaces
timeout: Timeout for the API call
export_timeout: Timeout in seconds for exporting pbix files, defaults to 120 seconds
output_path: full or relative path to where the outputs should go
mask: To mask the META/DATABASE_LOG files or not
compress: To gzip output files or not

...

Step 6: Check the Collector Outputs

K Extracts

A set of files (eg metadata, databaselog, linkages, events etc) will be generated. These files will appear in the output_path directory you set in the configuration details

...

A high water mark file is created in the same directory as the execution called powerbi_hwm.txt and produce files according to the configuration JSON. This file is only produced if you call the publish_hwm method.

...

Step 7: Push the Extracts to K

Once the files have been validated, you can push the files to the K landing directory.

You can use Azure Storage Explorer if you want to initially do this manually. You can push the files using python as well (see Airflow example below)

...

Example: Using Airflow to orchestrate the Extract and Push to K

Insert excerpt
Collector Method
Collector Method
nameairflow

...