Faros-canonical-reports NPM

Canonical Reports

This repository contains configuration for a data pipeline that extracts data from a Faros graph and renders a summary of it to dashboards. The configuration is organized into three subdirectories of the resources directory:

Queries are GraphQL queries that will be made against a Faros graph, and whose results will be flattened and loaded into a PostgreSQL table.
Transformations are a full-fledged dbt project. The project uses the tables created in the previous step as sources for derived tables and views.
Dashboards pair SQL queries on these tables with a visualization of the results. They are described by an adaptation of the Metabase API's card and dashboard JSON.

This package also includes a library for running the pipeline against a graph.

Usage

Install dbt:

$ pip install dbt==0.21.1 MarkupSafe==2.0.1

Install:

npm i

Run the dbt command to configure the dbt project:

$ npm run dbt

Spin up and configure PostgreSQL and Metabase containers:

$ npm run docker
# Or... if you want to run Metabase with premium features,
# then provide an enterprise license token
$ METABASE_LICENSE=<metabase-license> npm run docker

Run the pipeline on a specific graph:

$ npm run report -- \
  --faros-url https://dev.api.faros.ai \
  --faros-api-key $FAROS_API_KEY \
  --faros-graph mygraph

View dashboards in Metabase at http://localhost:3000. Log in with credentials: admin@faros.ai / pass123.

Additional scripts

Archive a dashboard in Metabase

$ npm run dashboard archive -- \
  --url http://localhost:3000 \
  --username admin@faros.ai \
  --password pass123 \
  --dashboard 8 \
  --cascade true

Export a dashboard in Metabase

$ npm run dashboard export -- \
  --url http://localhost:3000 \
  --username admin@faros.ai \
  --password pass123 \
  --dashboard 8 \
  --output resources/dashboards/mydashboard.json

Releasing

In order to release a new package you'll need to bump the version. Once the version change is merged to main, our CI pipeline will publish the new package to the npm registry.

To bump the version, run the following command in the root directory, commit the changes, and open a PR:

$ npm run bump <bump> # major, minor, patch, prerelease, ...

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago