Getting Started Tutorial

    What you are going to learn:

  • How to get started with Obkio Network Performance Monitoring Solution
  • How to add a public monitoring agent.
  • How to add a software monitoring agent.
  • How to create a first network monitoring session.

This documentation article is the first one everyone should read when getting started with Obkio's solution. It is a step-by-step tutorial on configuring the solution to help new users understand the basics and get everything up and running quickly. Throughout this article, there are links to more detailed articles that explain how things work in greater detail. You don't need to follow and read all these articles to finish this tutorial as they are listed only as references for later.

The tutorial will guide you through the first steps to configure:

  • 1x Public Monitoring Agent
  • 1x Software Monitoring Agent (Windows or Linux)
  • 1x Network Monitoring Session

At the end of this tutorial, you will have two monitoring agents (one public and one software) and a monitoring session between these agents. The monitoring session will collect network performance metrics such as packet loss, latency, jitter and VoIP quality.

Sign Up
Sign Up

The first thing to do is to sign up for our free 14-day trial (more info on the Free 14-day Trial page). Once you've signed up, you will be automatically redirected to our Web App. If you have been referred here from the App

Screencapture Sign Up

We understand that a 14-day trial might be short in some cases. If you need to extend your trial period or postpone your trial to another time, just contact us and we will work that out for you.

Create the Public Monitoring Agent
Create the Public Monitoring Agent

Once you have an account within the Obkio App, the next step is to create monitoring agents. The monitoring agents are in charge of running tests to measure network and application performance. We have several agent types but in this tutorial, we will focus on two types, the public monitoring agent that is hosted by Obkio at a public cloud and the software agent which can be installed on either Windows or Linux.

Screencapture Add Public Monitoring Agent

To create your first monitoring agent in the Web App:

  • Click on Agents in the left menu
  • Click on the Create new agent button in the middle of the screen.

You are now in the agent type selection screen. For this tutorial, select Public then Next. Select a public monitoring agent of your choice (ex: at AWS or Azure), then click on Next.

Now it's time to give the agent a name. Let's call it Public. No need to change any advanced parameters for this tutorial so let's click Create.

Woohoo, you just created your first monitoring agent!

Create and Install the Software Monitoring Agent
Create and Install the Software Monitoring Agent

To monitor network performance, we need two agents. This is required to be able to measure performance metrics such as packet loss, latency and jitter. Learn more at Network Performance Monitoring.

To create the software agent, click on the + icon at the top right corner of the agents list page, then click Create new agent.

This time, select Software then Next. You are now in the Agent Mode selection screen. For this tutorial, select Client Only since a public monitoring agent can only be configured as the server. This can be changed later on if you want to change the configuration to accept incoming connection on the agent.

Now it's time to give the agent a name. Let's call it Software. No need to add a location or contact details for this tutorial so let's click Create.

Screencapture Add Software Monitoring Agent

You should now see the Installation Instructions page. For this tutorial, let's focus on the Windows Installation but you can give the Linux version a try if you want. You can take a look at the complete Windows Installation Guide but for this quick tutorial, we recommend that you stay on this page and follow the installation instructions below:

  1. Write down the Agent ID that you see in the Windows tab of the page.
  2. Download the installation wizard for x86 64-bits.
  3. Run the installation wizard and type the Agent ID you wrote down in step 1 when asked for it.

Screencapture Windows Installation

That's it! The agent is now installed on your computer. At this point, both monitoring agents in the App should be green and a public IP address should be available for the Software agent. If this is not the case, your firewall might have strict outbound security rules that need to be changed. Learn more by visiting the Firewall Configurations page.

Create the Network Monitoring Session
Create the Network Monitoring Session

Let's create a first monitoring session. Since all the network monitoring sessions are created through templates, let's start with your first Network Monitoring Template:

  • click on Monitoring in the left-hand menu
  • click on the Create new monitoring template button in the middle of the screen
  • give the template a name (ex: First Template)
  • select the agent Software in the first list
  • select the agent Public in the second list
  • click Create

Screencapture Network Monitoring Template

It's done, you've created your first network monitoring template!

View the Network Performance Metrics
View the Network Performance Metrics

If you click on Monitoring in the left-hand menu, you should see your first network monitoring session. The status icon might be grey but after about 5 minutes, it should be green. Click on the session to see the details.

Screencapture Network Monitoring Session Graph

If you don't see any data, your firewall might have strict outbound security rules that need to be changed in order to allow the monitoring traffic (port 23999/UDP) to go out. Learn more by visiting the Firewall Configurations page.

Summary
Summary

That's the end of this first tutorial but not the end of your Obkio journey. With this tutorial, you were able to create two monitoring agents, one public and one software. You were also able to create a network monitoring template that automatically created a network monitoring session. At this point, you can install more public and software monitoring agents and add them in the same template. In the template, make sure you keep the public monitoring agents in one list and the software monitoring agents in the other list.

With more monitoring agents and sessions, it will become easier for you to understand where a network issue is located when it occurs. Take a look at the related articles below that will help you understand more about how this all works.

Finally, if you need any help, get in touch with our Support Team.