User Guide

​

Table of Contents

1. Getting Started
   • Creating an Account
   • Dashboard Overview
   • Navigation
2. Managing Projects
   • Creating Projects
   • Project Settings
   • Team Collaboration
3. Setting Up Monitors
   • Basic Monitor Configuration
   • Advanced Monitor Settings
   • Managing Existing Monitors
4. Monitoring Results
   • Understanding Check Results
   • Performance Metrics
   • Regional Performance
   • SSL Certificate Information
5. Incident Management
   • Incident Detection
   • Updating Incidents
   • Incident History
6. Status Pages
   • Creating Status Pages
   • Customizing Status Pages
   • Public vs. Private Status Pages
7. Configuring Notifications
   • Email Notifications
   • Slack Integration
   • Discord Integration
   • Microsoft Teams Integration
   • Webhook Configuration
   • Telegram Notifications
   • WhatsApp Notifications
   • PagerDuty Integration
8. Maintenance Windows
   • Scheduling Maintenance
   • Recurring Maintenance
9. Subscription Management
   • Understanding Plan Limits
   • Upgrading Your Subscription
10. Account Settings
    • Profile Management
    • Security Settings
    • Teams and Permissions

​

Getting Started

​

Creating an Account

1. Visit the Uptime Monitor login page
2. Click on “Sign Up” to create a new account
3. You can register using:
   • Email and password
   • Google OAuth
   • GitHub OAuth
4. Complete the registration form
5. Verify your email address if required
6. Log in with your new credentials

​

Dashboard Overview

After logging in, you’ll see the main dashboard that displays:

• Monitor status summary
• Recent incidents
• Uptime statistics
• Performance trends
• Quick access to common actions

The dashboard provides an at-a-glance view of your monitoring environment and highlights any issues that need attention.

​

Navigation

The main navigation menu includes:

• Dashboard: Home screen with overview statistics
• Monitors: List and manage your monitors
• Projects: Organize monitors into projects
• Incidents: View and manage service incidents
• Status Pages: Configure public or private status pages
• Maintenance: Schedule maintenance windows
• Settings: Configure account and application settings

​

Managing Projects

​

Creating Projects

Projects help you organize related monitors and control access permissions. To create a new project:

1. Navigate to the Projects section
2. Click “Create New Project”
3. Enter project details:
   • Name
   • Description (optional)
   • Team members (if on Pro plan)
4. Click “Create Project”

​

Project Settings

Each project has configurable settings:

1. Navigate to the project details page
2. Click on “Settings”
3. You can modify:
   • Project name and description
   • Default alert settings
   • Team member access

​

Team Collaboration

On the Pro plan, you can invite team members to collaborate on projects:

1. Go to the project settings
2. Click “Manage Team”
3. Enter email addresses of team members
4. Assign roles (Admin, Project Manager, or User)
5. Click “Send Invitations”

Team members will receive email invitations to join the project.

​

Setting Up Monitors

​

Basic Monitor Configuration

To create a new monitor:

1. Navigate to Monitors section
2. Click “Add Monitor”
3. Enter basic details:
   • Monitor name
   • URL to monitor
   • Check interval (how often to check)
   • Project association

​

Advanced Monitor Settings

Expand your monitor configuration with advanced settings:

1. HTTP Method: GET, POST, PUT, etc.
2. Request Headers: Add custom headers
3. Request Body: For POST/PUT requests
4. Expected Response: HTTP status code, content match
5. Timeout: Maximum time to wait for response
6. Retries: Number of attempts before marking as down
7. Alert Threshold: Consecutive failures before alerting
8. Regions: Geographic locations to check from

​

Managing Existing Monitors

For each monitor, you can:

1. Edit configuration
2. Pause/resume monitoring
3. View detailed history
4. Perform manual checks
5. Delete the monitor

​

Monitoring Results

​

Understanding Check Results

Each check provides detailed information:

• Response time
• HTTP status code
• Success/failure status
• Error message (if applicable)
• Response body (if configured to capture)
• Regional information

​

Performance Metrics

Performance metrics help you understand trends:

1. Average response time
2. Uptime percentage
3. Response time trends
4. Latency breakdown
5. Apdex score (application performance index)

Access performance metrics from the monitor details page by clicking “Performance”.

​

Regional Performance

For monitors configured with multiple regions:

1. Navigate to the monitor details
2. Click on “Regional Data”
3. View a comparison of performance across regions
4. Identify region-specific issues

​

SSL Certificate Information

For HTTPS monitors, you can view SSL certificate details:

1. Go to monitor details
2. Click “SSL Information”
3. View certificate:
   • Validity period
   • Issuer
   • Encryption details
   • Common name
   • Expiration warning

​

Incident Management

​

Incident Detection

Incidents are automatically created when:

1. A monitor fails the configured number of consecutive checks
2. The failure meets the alert threshold criteria

You can also manually create incidents:

1. Go to the Incidents section
2. Click “Create Incident”
3. Select the affected monitor(s)
4. Enter incident details
5. Set severity level

​

Updating Incidents

Keep your team and users informed with updates:

1. Navigate to the incident details
2. Click “Add Update”
3. Enter update information:
   • Status change (Investigating, Identified, Monitoring, Resolved)
   • Update message
   • Internal notes (optional)
4. Click “Post Update”

Updates appear on the incident timeline and status pages.

​

Incident History

Review past incidents to identify patterns:

1. Navigate to Incidents section
2. Use filters to narrow down by:
   • Date range
   • Monitors
   • Status
   • Severity
3. Click on any incident for detailed information

​

Status Pages

​

Creating Status Pages

Status pages provide transparency to your users:

1. Navigate to Status Pages section
2. Click “Create Status Page”
3. Configure basic settings:
   • Name
   • URL slug (for public access)
   • Description
   • Logo (optional)
4. Select monitors to include
5. Click “Create”

​

Customizing Status Pages

Personalize your status page appearance:

1. Go to status page settings
2. Customize:
   • Header and footer content
   • Color scheme
   • Company information
   • Custom CSS (Pro plan)
   • Incident display settings

​

Public vs. Private Status Pages

Choose the visibility of your status page:

• Public: Accessible to anyone with the URL
• Private: Requires authentication to view

For private status pages:

1. Set visibility to “Private”
2. Manage access permissions
3. Share secure access links with stakeholders

To use a custom domain for your status page (Pro plan):

1. Go to status page settings
2. Enter your custom domain
3. Configure DNS settings as instructed
4. Verify domain ownership

​

Configuring Notifications

​

Email Notifications

Set up email alerts:

1. Navigate to Notification settings
2. Click “Add Email Notification”
3. Enter email addresses
4. Configure notification triggers:
   • Monitor down/up events
   • SSL certificate warnings
   • Incident updates
5. Set delivery schedule and quieting hours (optional)

​

Slack Integration

Connect to Slack for real-time alerts:

1. Go to Notification settings
2. Click “Add Slack Integration”
3. Authorize the Uptime Monitor app in Slack
4. Select the channel for notifications
5. Configure notification triggers
6. Customize message format (optional)

​

Discord Integration

Set up Discord notifications for your monitors:

1. Go to Notification settings
2. Click “Add Discord Integration”
3. Create a webhook in your Discord server:
   • Open Server Settings > Integrations > Webhooks
   • Click “New Webhook”
   • Name it “Uptime Monitor”
   • Select the channel for notifications
   • Copy the webhook URL
4. Paste the webhook URL in the Uptime Monitor settings
5. Configure notification triggers:
   • Monitor down/up events
   • Incident updates
   • Maintenance notifications
6. Customize message format (optional)
7. Click “Save Integration”

​

Microsoft Teams Integration

Connect to Microsoft Teams for alerts:

1. Go to Notification settings
2. Click “Add Teams Integration”
3. Create an incoming webhook in Teams:
   • Navigate to the channel where you want to receive notifications
   • Click the ”…” menu > Connectors
   • Find “Incoming Webhook” and click Configure
   • Name the webhook and upload an icon (optional)
   • Click Create and copy the webhook URL
4. Paste the webhook URL in the Uptime Monitor settings
5. Configure notification triggers
6. Customize message appearance
7. Test the integration

​

Webhook Configuration

Send notifications to your own systems:

1. Navigate to Notification settings
2. Click “Add Webhook”
3. Enter webhook URL
4. Configure payload format
5. Select notification triggers
6. Test the webhook integration

​

Telegram Notifications

Set up Telegram notifications:

1. Navigate to Notification settings
2. Click “Add Telegram Integration”
3. Follow the instructions to:
   • Start a chat with the Uptime Monitor bot
   • Get your chat ID
   • Enter the chat ID in the settings
4. Configure notification triggers
5. Customize message format
6. Test the integration

​

WhatsApp Notifications

Configure WhatsApp for critical alerts:

1. Go to Notification settings
2. Click “Add WhatsApp Integration”
3. Complete the verification process:
   • Enter your phone number
   • Verify with the code received on WhatsApp
4. Configure notification preferences:
   • Select priority level for WhatsApp alerts
   • Choose which events trigger notifications
5. Test the integration

​

PagerDuty Integration

Connect to PagerDuty for incident management:

1. Navigate to Notification settings
2. Click “Add PagerDuty Integration”
3. Set up the integration:
   • Enter your PagerDuty API key
   • Select the PagerDuty service
   • Configure severity mapping
4. Set notification rules:
   • Determine which incidents create PagerDuty alerts
   • Configure auto-resolution settings
5. Test the integration

​

Maintenance Windows

​

Scheduling Maintenance

To prevent false alerts during planned maintenance:

1. Navigate to Maintenance section
2. Click “Schedule Maintenance”
3. Configure:
   • Start and end time
   • Affected monitors
   • Description
   • Public notification (for status pages)
4. Click “Schedule”

During maintenance, monitoring continues but alerts are suppressed.

​

Recurring Maintenance

For regular maintenance activities:

1. Create a new maintenance window
2. Enable “Recurring” option
3. Set recurrence pattern:
   • Daily, weekly, monthly
   • Specific days of week
   • Time window
4. Configure end date or number of occurrences

​

Subscription Management

​

Understanding Plan Limits

Each subscription plan has specific limits:

• Free Plan:
  • 5 monitors
  • 1 status page
  • Email notifications only
  • 30-day data retention
  • Single user
• Pro Plan:
  • Unlimited monitors
  • Multiple status pages
  • All notification channels
  • 1-year data retention
  • Team collaboration

View your current usage and limits in the Subscription section.

​

Upgrading Your Subscription

To access additional features:

1. Navigate to Subscription settings
2. Review available plans
3. Click “Upgrade to Pro”
4. Complete the payment process
5. Enjoy immediate access to Pro features

​

Account Settings

​

Profile Management

Update your account information:

1. Go to Account Settings
2. Update profile details:
   • Name
   • Email
   • Avatar
   • Time zone
   • Contact information

​

Security Settings

Manage security options:

1. Navigate to Security settings
2. Change password
3. Configure two-factor authentication (if available)
4. Review connected OAuth providers
5. View session history

​

Teams and Permissions

Manage team members and access:

1. Go to Teams settings
2. View all team members
3. Adjust user roles and permissions
4. Remove users if needed
5. Send new invitations