animeshinvinci/marquez

Collect, aggregate, and visualize a data ecosystem's metadata

Marquez is an open source metadata service for the collection, aggregation, and visualization of a data ecosystem's metadata. It maintains the provenance of how datasets are consumed and produced, provides global visibility into job runtime and frequency of dataset access, centralization of dataset lifecycle management, and much more.

Badges

Status

This project is under active development at WeWork (in collaboration with many other organizations).

Documentation

We invite everyone to help us improve and keep documentation up to date. Documentation is maintained in this repository and can be found under docs/.

Note: To begin collecting metadata with Marquez, follow our quickstart guide. Below you will find the steps to get up and running from source.

Requirements

• Java 8
• PostgreSQL 9.6

Note: To connect to your running PostgreSQL instance, you will need the standard psql tool.

Building

To build the entire project run:

$ ./gradlew shadowJar

The executable can be found under build/libs/

Configuration

To run Marquez, you will have to define config.yml. The configuration file is passed to the application and used to specify your database connection. The configuration file creation steps are outlined below.

Step 1: Create Database

When creating your database using psql, we recommend calling it marquez:

$ psql -c 'CREATE DATABASE marquez;'

Step 2: Create config.yml

With your database created, you can now copy config.example.yml:

$ cp config.example.yml config.yml

You will then need to set the following environment variables (we recommend adding them to your .bashrc): POSTGRES_DB, POSTGRES_USER, and POSTGRES_PASSWORD. The environment variables override the equivalent option in the configuration file.

By default, Marquez uses the following ports:

• TCP port 8080 is available for the HTTP API server.
• TCP port 8081 is available for the admin interface.

Note: All of the configuration settings in config.yml can be specified either in the configuration file or in an environment variable.

Running the Application

$ ./gradlew run --args 'server config.yml'

Then browse to the admin interface: http://localhost:8081

Related Projects

• marquez-web: Web UI used to view metadata collected and cataloged by Marquez.
• marquez-airflow: Airflow support for Marquez.
• marquez-java: Java client for Marquez.
• marquez-python: Python client for Marquez.

Getting Involved

• Website: https://marquezproject.ai
• Source: https://github.com/MarquezProject/marquez
• Chat: https://gitter.im/marquez-project/community
• Twitter: @MarquezProject

Contributing

See CONTRIBUTING.md for more details about how to contribute.