Quick Start Guide

Start-up

After completing the installation, to start Orbit Team:

  1. Validate that you are in the same Python environment that was used to run the installation script.
  2. Run orbit-server start.

Success

Validate that the GUI is running by going to the GUI. This is your centralized location to track all of your monitors.

Hello Orbit

Once Orbit is started up, follow the next few steps to launch your first Orbit Monitor:

  1. Navigate to where you'd like to create your Orbit project directory (e.g. your workspace directory).
  2. Ensure that you are in the environment that was used during the client installation.
  3. Create a directory called hello-orbit.
  4. Navigate into the newly created hello-orbit directory.
  5. Create a Python file called hello-orbit.py
  6. Copy and paste the following code into hello-orbit.py: 
    import foundations
print("hello orbit")
  7. Run foundations monitor create . hello-orbit.py to create a monitor within the hello-orbit project.
  8. Head to the GUI to see your project.
    hello-orbit Project
  9. On the GUI, click on the hello-orbit project. It should lead you to the Monitor Schedules tab.
    hello-orbit Monitor
  10. In the Monitor Schedules tab, you should see a monitor called hello-orbit. Clicking on the monitor will show you details about this monitor.
    hello-orbit Monitor Details
  11. Under Schedule Details, set the schedule to run the monitor (e.g. every minute at the 10th second).
    hello-orbit Monitor Schedule
  12. Once you click Save, the Monitor's status will become Active and times in Next Run will get updated.
    hello-orbit Monitor Active
  13. Click on the refresh button (Refresh icon) next to Monitor Jobs to see a list of jobs run at the scheduled times.
  14. When a job is being executed, Status will show a blinking green circle.
  15. When a job is completed, Status will show a solid green circle. Click the button on the right hand side of the table row (Open icon) to view the logs of the job. In our case, a modal will pop up and display the message hello orbit.
  16. You can pause the Monitor at any time by clicking on the pause button ( Pause icon ). Make sure that you do this to prevent jobs being run on your system forever!

You just created your first Orbit Monitor and scheduled it to run periodically. The Monitor is created from our hello-orbit.py script, which doesn't do much except print out "hello orbit" every time it is run.

Now, let's create a Data Contract against a dataset and see how Orbit can help monitor data quality issues.

Stopping Orbit

To stop Orbit Server:

  1. Validate that you are in the same Python environment that was used to run the installation script.
  2. Run orbit-server stop.