Documentation
User Registration
- A user have to login to UpDownTime to use the system.
- A new user should register with UpDownTime with their Email, password and contact details.
- Go to register section on right top corner of the home page to register.
- Click on the register button and fill the required fields on the displayed page.
- Then press Register.
Registration
- After registration a verification Email will be sent to registered Email address. User have to verify the Email by clicking on Verify Email Address button.
- After the verification the page will be automatically redirected to the dashboard of UpDownTime.
- User can re-login to the system with this Email address and password from login page.
User login
Dashboard
- The user is provided with a dashboard which enables them to analyse Updowntime details and Incident details quickly
Monitor Details
- The user can easily check the Updowntime details of Servers, Webpage and APIs.
- They can also get the count of up and down status.
Server Monitor
One of the core features of Updowtime is server Updowntime. This feature allows user to get:
- Up and Down status of the server.
- Total up and down time percentage.
- Avg.response time
- Weekly status and all other features associated with the server.
- Public page feature to analyse data for users, etc.
- The picture shown above is the listing of servers. The basic information like up and down status, average response time and other details of the server is given here.
- The green circle indicates that the server is up and the red circle indicates that the server is down.
- A user can access this page by clicking the "Servers" link on the monitor section.
- There are some links also to add a server, view details of a server, view public page of a server and updating and deleting of the server.
- User can filter servers by searching with server address or related keywords.
Add a Server
- User can add a server by clicking "Add Server" link given in the servers page.
- User have to provide server address, port, ping interval (status check interval), and server email (optional).
- Server Address can be website domain or IP address.
- User can provide an email address to receive the server status updates. If no email is mentioned, the mail will be sent to the user's email address.
- If the server is down at the time of adding (if the details given are incorrect or if the server is actually down), a warning message will appear at the top. If you still need to add, you can check the checkbox appeared at the bottom and click the add button again.
Update a Server
- User can update a server by clicking edit link given in the servers page.
- User have to provide the updated details as done at the time of adding server.
- As in the case of add server, if the server is down at the time of updating (if the details given are incorrect or if the server is actually down), a warning message will appear at the top. If you still need to update, you can check the checkbox appeared at the bottom and click the update button again.
View a Server Details
- To get a server's detailed information, click on the view link from servers page.
- User can get up time and down time percentage, current status, avg response time, last checked time and last five logs of checking status from this page.
- User can also access the public page from this page.
Webpage Monitor
As servers, user can also monitor webpages using this software. The user can get:
- Up and Down status of the webpage.
- Total up and down time percentage.
- Avg.response time
- Weekly status and all other features associated with the server.
- Public page feature to analyse data for users, etc.
- The picture shown above is the listing of webpages. The basic information like up and down status, average response time and other details of the webpage is given here.
- The green circle indicates that the webpage is up and the red circle indicates that the webpage is down.
- User can access this page by clicking "Webpages" link in monitor section.
- There are some links in this page also to add a webpage, view details of a webpage, view public page of a webpage, updating and deleting of the webpage.
- User can filter webpages by searching with webpage name, URL and related keywords.
Add a Webpage
- User can add a webpage by clicking "Add Webpage" link given in the webpages page.
- User have to provide a name for the webpage, URL of the webpage, Expected HTTP response status code of the URL, ping interval(status check interval), and webpage email(optional).
- User can provide an email address to receive the webpage status updates. If no email is mentioned, the mail will be sent to the user's email address.
- If the webpage is down at the time of adding (if the details given are incorrect or if the webpage is really down), a warning message will appear at the top. If you still need to add, you can check the checkbox appeared at the bottom and click the add button again.
Update a Webpage
- User can update a webpage by clicking edit link given in the webpages page.
- User have to provide the updated details as done at the time of adding webpage.
- As in the case of add server, if the webpage is down at the time of updating (if the details given are incorrect or if the webpage is really down), a warning message will appear at the top. If you still need to update, you can check the checkbox appeared at the bottom and click the update button again.
View Webpage Details
- To get a webpage's detailed information, click on the view link from webpages page.
- User can get up time and down time percentage, current status, avg. response time, Last checked time and last five logs of checking status from this page.
- User can also access the public page from this page.
API Monitor
As servers and webpages, user can also monitor APIs using this software. The user can get:
- Up and Down status of the APIs.
- Total up and down time percentage.
- Avg.response time
- Weekly status and all other features associated with the API.
- Public page feature to analyse data for users, etc.
- The picture shown above is the listing of APIs. The basic information like up and down status, average response time and other details of the APIs is given here.
- The green circle indicates that the API is up and the red circle indicates that the API is down.
- User can access this page by clicking "APIs" link in monitor section.
- There are some links in this page also to add an API, view details of an API, view public page of an API, updating and deleting of the API.
- User can filter APIs by searching with API name, URL and related keywords.
Add an API
- User can add an API by clicking "Add API" link given in the APIs page.
- User have to provide a name for the API, URL of the API, Expected HTTP response status code of the URL, HTTP method to be performed on the object identified by the URL (GET, POST, PUT or DELETE), ping interval(status check interval), and an API email(optional).
- User can provide an email address to receive the API status updates. If no email is mentioned, the mail will be sent to the user's email address.
- If an API is down at the time of adding (if the details given are incorrect or if the API is really down), a warning message will appear at the top. If you still need to add, you can check the checkbox appeared at the bottom and click the add button again.
Update an API
- User can update an API by clicking edit link given in the APIs page.
- User have to provide the updated details as done at the time of adding API.
- As in the case of add API, if the API is down at the time of updating (if the details given are incorrect or if the API is really down), a warning message will appear at the top. If you still need to update, you can check the checkbox appeared at the bottom and click the update button again.
View Api Details
- To get an API's detailed information, click on the view link from APIs section.
- User can get up time and down time percentage, current status, avg response time, Last checked time and last five logs of checking status from this page.
- User can also access the public page from this page.
Public Pages
A public status page is a specialized monitoring dashboard designed to publicly showcase the availability status of a server, webpage, or API being monitored. Here you can add and show the public page of a server, Webpage or API and separate links for each types are provided. User can access these from public pages section in the panel.
- The picture shown above is the listing of public pages. The basic information like name or address of the monitor type (Server, Webpage or Api), name of the public page etc. is given here.
- The green tick and red cross indicates the active and inactive states of the public page respectively.
- There are some links in this page also to add, view, update and deleting of a public page.
- User can filter public pages by searching with monitor name (address in the case of servers), public page name and related keywords.
Add a Public Page
- User can add public page by clicking "Add Public Page" link given in the public pages section.
- There must be at least one data in monitor section to add a public page.
- User have to select the server/webpage/Api (Note that each type have separate links) and have to provide a name for the public page. Note that no two public pages can have the same name
- It is mandatory to enable the public page in order to show it to the public.
Update a Public Page
- User can update a public page by clicking edit link given to them.
- User have to provide the updated details as done at the time of adding public page.
- From there, you can also enable or disable the public page.
Public Page Details
- User can see your public page data from both public page section and monitor section. There is a link provided in both cases to view the public pages.
- User must provide the link of each public pages in order to show it to the public.
- A lot of details are given in this page like:
- Up time percentage of the last 7 days (day wise and total).
- All time up time percentage.
- Average response Time.
- Total number of incidents.
- Also the incidents and it's updates (Refer section 9 for more details).
Incidents
Incidents are the unintended event that disturbs normal operations. If there is an issue in your server, webpage or API, you can add it to inform your users or public.
There are separate links to add incidents for each monitor types (server, webpage or API). User can access these from the incidents section in the panel.
- The picture shown above is the listing of incidents. The basic information like name or address of the monitor type (Server, Webpage or Api) and subject and description of the incident associated with it, status of the incident et. is given here.
- There are some links in this page also to add, view, update and deleting the incident.
- User can filter incidents by monitor name (address in the case of servers) and status (pending or resolved).
Add an Incident
- User can add an incident by clicking "Add Incident" link given in the incidents section.
- User have to select the server/webpage/Api first(Note that each type have separate links).
- Also the subject and the detailed description should be given in the corresponding fields.
- After an incident is added, the status of the incident will be "Pending".
Update an Incident
- User can update an incident by clicking edit link given to them.
- User have to provide the updated subject and description as done at the time of adding incident.
Update Incident Details
- After adding an incident, a user can add updates of the incident by clicking on follow up link given for each incidents.
- User should select a status (monitoring , Identified, update and Resolved) and add the description of the status.
- If the selected incident details status is "resolved", The status of the incident will also change to "Resolved".
- Previous updates and details of the selected incident is also listed in this page