Getting Started

Now that you have successfully installed Meltano locally or in the cloud, you're ready to start connecting data soures, building pipelines, performing analysis and dashboarding.


The following instructions assume you are able to access Meltano's user interface locally from http://localhost:5000 or at http://YOUR_CLOUD_IP_ADDRESS:5000.

Connect a data source

You should see now see the Extractors page, which contains various options for connecting your data source.

Meltano UI with all extractors not installed initial loading screen

For this guide, we will be following the "Fast Path" to get you up and running as quickly as possible. So let's install tap-carbon-intensity by clicking on the Install button inside its card. Once it is complete, you should be greeted with the following modal:

Modal confirmation that tap-carbon-intensity is installed, doesn't require configuration and allow you to progress to the next step

Click Next to move on to the next step: "Entity Selection."

Select entities

Data sources can contain a lot of different entities. As a result, you might not want Meltano to pull every data source into your dashboard. As you can see on your screen, all of the entities are currently selected by default for tap-carbon-intensity.

Entity Selection Modal for tap-carbon-intensity

Since there are only a few available entities, let's leave it as is and click Save to finish configuring our extractor.

Determine where the data will live

Once you save your entities, you should be greeted with the Loaders page:

Loader page for Meltano project

Now that Meltano is pulling data in from your data source(s), you need to choose where and in what format you would like that data stored.

Let's use target-sqlite for this project by clicking Install in its card.

Once it is finished installing, you will see the following modal:

Modal dialogue for successful SQLite installation

By default, target-sqlite is configured with a database named warehouse that can be customized if desired. For this guide however, let's just use the default name and click Save.

Apply transformations as desired

With our extractor and loader configured, you should now see the following page:

Screenshot of Transform page on Meltano webapp

This page allows you to apply transformations to your data. This is not necessary for our current setup, but if you'd like to learn more about how transforms work in Meltano, check out our docs on Meltano transform.

By default, the Transform step is set to Skip, so all we need to is click Save.

Create a pipeline schedule

You should now be greeted with the Schedules page with a modal to create your first pipeline!

Create pipeline modal

Pipelines allow you to create scheduled tasks through Apache Airflow. For example, you may want a recurring task that updates the database at the end of every business day.

In the current form, you will see:

  • A pipeline name which has a default name that is dynamically generated, but can be easily changed if desired
  • The extractor the pipeline will use, which should be tap-carbon-intensity
  • The loader the pipeline will use, which should be target-sqlite
  • Whether the transform step should be applied, which should be skip
  • The interval at which the pipeline should be run, which is set by default to be @once

All we need to do is click Save to start our new pipeline! You should see a spinning icon as well as a badge next to the "Pipeline" navigation element in the header.

Screenshot of pipeline being run

Once it's complete, these indicators will disappear and you should see:

Screenshot of complete pipeline run

Congratulations! Now that you have connected a data source, configured a target database, and run a successful pipeline for the dataset, we are now ready to analyze the data!

Select a data model

Let's start by clicking on the Analyze button in our pipeline. This should bring us to the "Analyze: Models" page:

Screenshot of Analyze: Model page

Meltano Models determine how the data is defined and assists us with interactively generating SQL so that you can easily analyze and visualize your data. As you can see in the right column, tap-carbon-intensity already has the required models installed.

Let's move on to the next step by clicking Analyze in the model-carbon-intensity-sqlite card to move on to the next step.

Analyze the data

The Analyze page contains an interactive user interface to allow you to dynamically build queries and visualize your data.

Screenshot of Analyze page for Carbon Region

Now, let's explore and analyze our tap-carbon-intensity data by selecting the following attributes in the left column:

  • Geographical Region
    • Columns: Name
    • Aggregates: Count
  • Electricity Generation Sources
    • Columns: ID
    • Aggregates: Average Percent (%)

Screenshot of selected attributes for tap-carbon-intensity

And with that, the big moment is upon us, it's time to click Run to run our query!

Our query visualized as a bar graph!

You should now see a beautiful data visualization and a table below to see the data in detail!

Save a report

When we find an analysis that we want to reference in the future, we can easily do this by creating a report. This can be accomplished by clicking on the Save Report dropdown in the Analyze toolbar. This will open a dropdown with a default report name that is dynamically populated, but can be easily changed.

Save Report dialogue for naming the report you want to save

Once we click Save, we should see the upper left "Untitled Report" change to our new report name.

Saved report with a designated report name

And with that, our analysis has been saved!

Add a report to a dashboard

As you acquire more reports, you will probably want to organize them via dashboards. This can be done by clicking on the new Add to Dashboard dropdown in the toolbar.

Dropdown menu for adding report to dashboard

Since we have never created a dashboard, click on New Dashboard, which will trigger a modal that contains a dynamically generated dashboard name that can be customized as desired.

New dashboard dialog for configuring the dashboard

Once we click Create, we can now verify that the our report has been added to the Dashboard by clicking on the Add to Dashboard menu.

Confirmation that our report is added to the dashboard

We can also visit the Dashboard directly by clicking on the Dashboard navigation item in the header, which shows our newly created Dashboard and the associated Report.

Dashboard page with new dashboard and the associated Report

Next steps

And with that, you have now setup a complete end-to-end data solution with Meltano! 🎉

To learn about more Meltano recipes and functionality with our tutorials.

Last Updated: 10/7/2019, 3:29:04 PM