Skip to main content

OmniHSS Control Panel Guide

← Back to Operations Guide


Table of Contents


Control Panel Overview

The OmniHSS Control Panel is a web-based monitoring interface that provides real-time visibility into system status, subscriber activity, and Diameter connectivity. Built with Phoenix LiveView, it automatically updates without requiring page refreshes.

Key Features

  • Real-time Updates - Auto-refreshes every second
  • Subscriber Monitoring - View active subscribers and their current state
  • Diameter Status - Monitor peer connections in real-time
  • System Resources - Track application performance
  • Configuration Viewer - Inspect runtime configuration

Access Information

URL: https://[hostname]:7443
Protocol: HTTPS Only
Port: 7443 (configurable)
Certificate: Configured in config/config.exs

Control Panel Architecture


Accessing the Control Panel

Initial Access

  1. Open a web browser
  2. Navigate to https://[hostname]:7443
  3. Accept the TLS certificate (if self-signed)
  4. You will be presented with the Overview page by default

TLS Certificate Warnings

If using self-signed certificates, browsers will show security warnings. This is expected for internal deployments.

For Production: Use certificates signed by a trusted Certificate Authority.

Network Requirements

  • Port 7443 must be accessible from your management network
  • HTTPS is mandatory - HTTP is not supported
  • Firewall rules must allow traffic to port 7443

Browser Compatibility

The Control Panel uses modern web technologies (LiveView, WebSockets):

  • Chrome/Chromium (recommended)
  • Firefox
  • Safari
  • Edge

Note: Internet Explorer is not supported.


Overview Page

URL: https://[hostname]:7443/overview

The Overview page displays all subscribers and their real-time state information.

Page Layout

Table Columns

ColumnDescriptionValues
IDSubscriber database IDInteger
EnabledService status✓ (enabled) / ✗ (disabled)
IMSIInternational Mobile Subscriber Identity14-15 digits
ICCIDSIM card ID19-20 digits or "N/A"
EPC ProfileData service profile nameProfile name or ID
IMS ProfileVoice service profile nameProfile name, ID, or "N/A"
Roaming ProfileRoaming policy nameProfile name, ID, or "N/A"

Expandable Row Details

Click on any row to expand and view detailed subscriber state:

Location Information

Fields:

  • MCC - Mobile Country Code (3 digits)
  • MNC - Mobile Network Code (2-3 digits)
  • TAC - Tracking Area Code
  • Cell ID - Serving cell identifier
  • eNodeB ID - Base station identifier
  • ECI - E-UTRAN Cell Identifier

Network Information

Fields:

  • Last Seen MME - Current serving MME hostname
  • Last Seen Realm - Diameter realm of MME
  • RAT Type - Radio Access Technology (e.g., "E-UTRAN" for LTE)
  • Last Seen At - Timestamp of last Diameter message

IMS Information

Fields:

  • Assigned S-CSCF - Currently assigned S-CSCF SIP URI
  • IMS Public Identity - SIP URI (e.g., sip:+14155551234@ims.example.com)
  • Last Seen P-CSCF - Last P-CSCF that contacted HSS
  • Last Seen I-CSCF - Last I-CSCF that contacted HSS

Session Information

Fields:

  • PDN Sessions - Number of active data connections
  • Active Calls - Number of active VoLTE calls

State Indicators

How to identify state:

  • Idle: No location information, no MME
  • Attached: Last Seen MME present, location info available
  • PDN Active: PDN sessions count > 0
  • IMS Registered: Assigned S-CSCF present
  • In Call: Active calls count > 0

Auto-Refresh

The Overview page automatically refreshes every 1 second to show real-time updates.

Visual indicators:

  • New data appears without page reload
  • Timestamps update in real-time
  • No manual refresh needed

Use Cases

  1. Monitor Active Subscribers

    • See which subscribers are currently attached
    • Check current serving network (for roaming)
    • Verify IMS registration status
  2. Troubleshooting

    • Verify subscriber is enabled
    • Check last seen timestamp (is subscriber responsive?)
    • Confirm profile assignments
    • View current location information
  3. Capacity Monitoring

    • Count total attached subscribers
    • Monitor PDN session counts
    • Track active VoLTE calls

Diameter Page

URL: https://[hostname]:7443/diameter

The Diameter page shows real-time status of all Diameter peer connections.

Page Layout

Table Columns

ColumnDescriptionValues
HostnameDiameter peer hostnameFQDN
RealmDiameter realmDomain name
IP:PortNetwork addressIP address and port
TransportTransport protocolTCP or SCTP
StatusConnection statusConnected / Disconnected

Connection Status

Expandable Row Details

Click on any peer to view additional information:

Connection Information:

  • Connection Type - Initiated by HSS or peer
  • Product Name - Peer's product identification
  • Application IDs - Supported Diameter applications

Application ID Examples:

  • 16777251 - S6a (MME)
  • 16777238 - Gx (P-GW)
  • 16777216 - Cx (I-CSCF, S-CSCF)
  • 16777217 - Sh (Application Server)
  • 16777236 - Rx (P-CSCF)
  • 16777252 - S13 (EIR client, if external)

Peer Connection Flow

Auto-Refresh

The Diameter page automatically refreshes every 1 second.

Use Cases

  1. Verify Connectivity

    • Ensure all expected peers are connected
    • Identify disconnected peers immediately
    • Monitor for flapping connections
  2. Troubleshooting

    • Check if peer is reachable
    • Verify transport protocol (TCP vs SCTP)
    • Confirm application IDs match expectations
    • Identify which side initiated connection
  3. Capacity Planning

    • Count total connected peers
    • Monitor for connection stability
    • Plan for additional peer capacity

Common Issues

Peer Shows Disconnected

Possible Causes:

  1. Network connectivity issue
  2. Peer is down or restarting
  3. Firewall blocking traffic
  4. Diameter configuration mismatch
  5. Certificate issue (if using TLS)

Troubleshooting Steps:

  1. Check network connectivity: ping [peer-ip]
  2. Verify port is reachable: telnet [peer-ip] 3868
  3. Check firewall rules
  4. Review HSS logs for error messages
  5. Verify peer's Diameter configuration matches HSS

Peer Connects and Disconnects Repeatedly

Possible Causes:

  1. Network instability
  2. Keepalive timeout mismatch
  3. Peer resource issues
  4. Diameter application mismatch

Troubleshooting Steps:

  1. Check network stability
  2. Review keepalive timers on both sides
  3. Check peer system resources
  4. Verify application IDs match on both sides

Application Page

URL: https://[hostname]:7443/application

The Application page provides system-level monitoring and resource usage information.

Features

  • Process Information - Erlang VM process count and memory
  • System Memory - Total and used memory
  • Application Uptime - How long OmniHSS has been running
  • Erlang VM Version - Runtime version information

Key Metrics

Use Cases

  1. Health Monitoring

    • Verify application is running
    • Check for memory leaks (increasing memory over time)
    • Monitor process count growth
  2. Capacity Planning

    • Track memory usage trends
    • Plan for scale-out based on process count
    • Verify adequate system resources
  3. Troubleshooting

    • Identify resource exhaustion
    • Check if restart is needed
    • Verify Erlang VM version

Configuration Page

URL: https://[hostname]:7443/configuration

The Configuration page displays the current runtime configuration of OmniHSS.

Features

  • View Configuration - Inspect all configuration parameters
  • Search Configuration - Find specific settings
  • Environment Variables - See resolved values

Configuration Categories

Use Cases

  1. Configuration Verification

    • Verify runtime.exs settings are applied
    • Confirm database connection parameters
    • Check Diameter peer configuration
  2. Troubleshooting

    • Identify misconfiguration
    • Verify environment variables are set correctly
    • Compare expected vs actual configuration
  3. Documentation

    • Export current configuration for documentation
    • Share configuration with support team

Security Note: Configuration page may display sensitive information (database passwords, keys). Restrict access appropriately.


Top Navigation Bar

Navigation is always visible at the top of the page for quick access.

Keyboard Shortcuts

While the Control Panel doesn't implement custom keyboard shortcuts, standard browser shortcuts work:

  • Ctrl+R / F5 - Manual page refresh (though auto-refresh makes this unnecessary)
  • Ctrl+F - Search on page
  • Ctrl+T - Open new tab (for multiple pages)

Multi-Tab Monitoring

You can open multiple Control Panel pages in separate browser tabs for simultaneous monitoring:

Example Setup:

  • Tab 1: Overview page (monitor subscribers)
  • Tab 2: Diameter page (monitor connectivity)
  • Tab 3: Application page (monitor resources)

All tabs will auto-update independently.

Responsive Design

The Control Panel is optimized for desktop browsers. Mobile browsers are supported but may require horizontal scrolling for tables.

Recommended Resolution: 1920x1080 or higher for comfortable viewing.


Monitoring Best Practices

Daily Operations

  1. Start of Shift

    • Open Control Panel Overview page
    • Verify expected number of subscribers are attached
    • Check Diameter page - all peers connected
  2. During Shift

    • Keep Overview page open for real-time monitoring
    • Watch for unusual state changes
    • Monitor for disconnected peers on Diameter page
  3. End of Shift

    • Verify system is stable
    • Check Application page for resource usage trends
    • Document any anomalies

Troubleshooting Workflow

Alert Thresholds

Establish monitoring thresholds for proactive alerting:

MetricWarningCritical
Disconnected Diameter Peers1 peer2+ peers or critical peer
Memory Usage> 80%> 90%
Subscriber Authentication Failures> 5%> 10%
Process Count> 80% of limit> 95% of limit

← Back to Operations Guide | Next: Metrics & Monitoring →