Hello Orbit example

After completing the start-up section, 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 installation.
  3. Create a directory called hello-orbit.
  4. Navigate into the newly created hello-orbit directory.
  5. Create a python file call hello-orbit.py
  6. Put the following code in 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
  9. On the GUI, click on the hello-orbit project, it should lead you to the Monitor Schedules tab
  10. In the Monitor Schedules tab, you should see a monitor called hello-orbit. Click on the monitor will show you details about this monitor
  11. Under Schedule Details, set the schedule to run the monitor (e.g. let's run it every minute at the 10th second)
  12. Under Schedule Details, set the "Ending on" date and time to a future time
  13. Once you click "Save", the Monitor's status will becomes Active and times in Next Run will get updated
  14. At the scheduled times (shown under Next Run), you can see list of jobs under the Monitor Jobs section (you will need to click the refresh button)
  15. When a job is being executed, under status it will show a blinking green circle
  16. When a job is done, under status it will show a solid green circle. Click the button on the right hand side of the table, a modal will pop up and display the message hello orbit

Note

When you run a job for the first time, it will download the appropriate worker image needed.
This will take roughly 2 to 3 minutes.

There you go, you just created your first Orbit Monitor and schedule it to run periodically. The Monitor is created from our hello-orbit.py script, which doesn't do much except printing out "hello orbit" everytime it is run.

Next, let's do something more interesting: using Orbit Monitor to monitor data quality, input and concept drifts.