hashmapinc / snowflake-inspector Goto Github PK

View Code? Open in Web Editor NEW

16.0 3.0 6.0 4.15 MB

Web tool for visualizing your Snowflake Data Platform instance.

License: Apache License 2.0

HTML 27.17% JavaScript 65.12% CSS 7.09% Makefile 0.62%

snowflake-inspector's Introduction

Snowflake Inspector

Welcome to the Snowflake Inspector project!

You can access a live version of the tool at http://snowflakeinspector.com

How to Build:

To build the project, ensure you have npm installed and do the following:

run npm i to install dependencies
run npm run build to build the static website. The files will show up in dist/

Alternatively, you can make use of the Makefile:

Run make to install all dependencies and build the production bundle of the inspector site

How to run locally for development

Run npm i to install dependencies
Run npm start and visit http://localhost:9000/bundle.html

How to build and run with Docker

Run npm i to install dependencies
Run npx webpack --mode=production to build the production distribution of the static site files
Run docker build -t snowflake-inspector . to build the image locally.
Run docker run -it -p 8083:80 snowflake-inspector to run a container based on the image you just built.
Access the site at http://localhost:8083/bundle.html

Alternatively, you can make use of the Makefile:

Run make install && make container to install npm modules, generate the production build of Snowflake Inspector, create a local snowflake-inspector Docker image (based on nginx), and start that container on port 8083
Access the site at http://localhost:8083/bundle.html

Providing default hierarchy data on load.

This tool now supports dynamic reading of hierarchy data on load for internal hosting of hierarchy visualizations on load without needing to run SQL manually each time.

To change or updated the default data at runtime, do the following:

Find the current default-data.csv at /dist/default-data.csv after building the project. If you are running the project docker container, the csv file is at /usr/share/nginx/html/default-data.csv.
Replace the contents of this file with the desired default hierarchy data.
Reload the Inspector tool. No rebuilding of the project is required - this is a hot update capability!

Future releases may include a config file for Snowflake access details that will allow the Inspector to update the hierarchy on a schedule, but for now the recommended approach is to scp your updated file into your running server environment to update the default-data.csv.

Reach out + Feedback

You can contact us at https://www.hashmapinc.com/reach-out if you want to learn more about Hashmap.

You can also provide feedback on this tool at https://forms.gle/42ACP1waPistVdTu9

snowflake-inspector's People

Contributors

Stargazers

Watchers

Forkers

ganeshx ranjith520 kgtdbx tusharkalecam sreenivaskalahasti ryandataengineergit

snowflake-inspector's Issues

Add readme with project details, build instructions, and instructions for contributing.

As a user, I can change the colors used in the hierarchy visualizations

As a User, when I upload an empty CSV to visualize, I do not want the app to crash

add an `about` section on the site to explain what the tool is. This can be a modal

As a user, when I click on a role or user, the Object Hierarchy view filters to the objects that the selected user/role and all of it's children can access in any way.

Add appropriate icons to the hierarchy viz to show different types of objects

As a user, I can filter the objects I see in the object hierarchy vis by providing a case-insensitive search string and hitting filter in a filter menu. The matching objects should also show their parents (if a table matches, show it's shema and DB even if they do not match)

As a user, I would like parent nodes and edges to be a different color than child nodes and edges

In the event that there is overlap from parents and children (a cycle exists in the hierarchy), then let the child relationship take precedence

A way to do this would be to first color all parents then color all children. The children coloring will overwrite the parent relationships as they go last.

This is because it is more important to call out what nodes a specific node can access rather than what other nodes can access the clicked node.

As a user, when I load my custom heirarchy CSV for visualization, I should not see search results from the sample visualization that loads by default when the Inspector is first loaded.

As a user, when I click on an object in the Object Hierarchy view, the user/roles view filters to only those users/roles that can access the selected object in any way

As a user, when I am filtering after clicking on either a Snowflake Object or Role/User, a context menu shows that allows me to select the level of access I want to use for filtering (e.g. usage, select, create)

  USE ROLE ACCOUNTADMIN;

  WITH 
  ROLE_GRANTS AS (
    SELECT
      PRIVILEGE,
      GRANTED_ON    AS GRANTED_ON_TYPE,
      TABLE_CATALOG AS GRANTED_ON_DATABASE,
      TABLE_SCHEMA  AS GRANTED_ON_SCHEMA,
      NAME          AS GRANTED_ON_NAME,
      GRANTED_TO    AS GRANTED_TO_TYPE,
      GRANTEE_NAME  AS GRANTED_TO_NAME
    FROM
      SNOWFLAKE.ACCOUNT_USAGE.GRANTS_TO_ROLES
    WHERE
      DELETED_ON IS NULL
  ),

  USER_GRANTS AS (
    SELECT
    'USAGE'      AS PRIVILEGE,
    'ROLE'       AS GRANTED_ON_TYPE,
    NULL         AS GRANTED_ON_DATABASE,
    NULL         AS GRANTED_ON_SCHEMA,
    ROLE         AS GRANTED_ON_NAME,
    GRANTED_TO   AS GRANTED_TO_TYPE,
    GRANTEE_NAME AS GRANTED_TO_NAME
    FROM
      SNOWFLAKE.ACCOUNT_USAGE.GRANTS_TO_USERS
    WHERE
      DELETED_ON IS NULL
  ),

  GRANTS AS (
    SELECT * FROM ROLE_GRANTS 
    UNION ALL 
    SELECT * FROM USER_GRANTS
  ),

  GRANTS_JSON AS (
    SELECT
      OBJECT_CONSTRUCT(*) AS GRANT_OBJ
    FROM
      GRANTS
  ),

  GRANTS_JSON_ARR AS (
    SELECT
      ARRAY_AGG(*) AS GRANTS
    FROM
      GRANTS_JSON
  )

  SELECT * FROM GRANTS_JSON_ARR;