Ctrl K
ring2all.com

Log File Viewer Module Documentation

Table of Contents

  1. Module Overview (Technical)
  2. Module Overview (Commercial/Business)
  3. Module Overview (End User/Administrator)
  4. Available Logs
  5. Filtering & Search
  6. Common Scenarios & Examples
  7. Limitations & Important Notes
  8. Troubleshooting Tips
  9. Glossary

---

1. Module Overview (Technical)

What Is Log File Viewer?

Log File Viewer is a web-based interface for viewing system log files directly from the admin panel. It provides real-time log monitoring, filtering by severity level, search functionality, and auto-refresh capabilities.

Architecture

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│                  Log File Viewer System                         │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Admin Browser                         PBX Server               │
│  ┌────────────────────┐               ┌────────────────────┐   │
│  │  LogViewerPage.tsx │◄───REST API──►│  Backend API       │   │
│  │                    │               │                     │   │
│  │  ┌──────────────┐  │               │  ┌───────────────┐ │   │
│  │  │ Log Display  │  │               │  │ Log Reader    │ │   │
│  │  │              │  │               │  │ Service       │ │   │
│  │  │ [Filter]     │  │               │  └───────┬───────┘ │   │
│  │  │ [Search]     │  │               │          │         │   │
│  │  │ [Refresh]    │  │               │          ▼         │   │
│  │  │              │  │               │  /var/log/         │   │
│  │  └──────────────┘  │               │  ├─ freeswitch/    │   │
│  │                    │               │  │  └─ freeswitch.log│  │
│  └────────────────────┘               │  └─ fail2ban.log   │   │
│                                        └────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Features

FeatureDescription
Log SelectionChoose which log file to view
Level FilteringFilter by severity (Debug, Info, Warning, Error)
SearchText search within logs
Auto-refreshAutomatic 5-second refresh
DownloadDownload log file
ClearClear log contents

Key Files

FileDescription
modules/logViewer/LogViewerPage.tsxMain viewer component
modules/logViewer/api.tsAPI calls
i18n/en/logViewer.jsonTranslations
---

2. Module Overview (Commercial/Business)

Business Value

Log File Viewer provides convenient log access:

Without Log ViewerWith Log Viewer
SSH to serverBrowser access
Command-line toolsVisual interface
Manual filteringClick-to-filter
No searchFull-text search

Use Cases

  1. Troubleshooting Calls

- Search for caller ID

- View call flow logs

  1. Security Monitoring

- Check Fail2ban blocks

- Monitor failed registrations

  1. System Debugging

- Filter by error level

- Find specific warnings

  1. Audit & Compliance

- Review system activity

- Download logs for analysis

Feature Highlights

FeatureBenefit
Browser-BasedNo SSH needed
Level FilterFocus on errors/warnings
SearchQuick issue finding
Auto-refreshReal-time monitoring
DownloadArchive for analysis
---

3. Module Overview (End User/Administrator)

What Can You Do?

  • View system log files
  • Filter by log level
  • Search for specific text
  • Enable auto-refresh
  • Download log files
  • Clear log files

Log Viewer Interface

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│  Log File Viewer                                                │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Log: [FreeSWITCH ▼]   Level: [All Levels ▼]                   │
│                                                                 │
│  🔍 [Search in logs...                    ] [Apply]            │
│                                                                 │
│  [Refresh] [Auto-refresh (5s)] [Download] [Clear Log]          │
│                                                                 │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  2026-01-16 10:30:45 [INFO] sofia/internal: Registration       │
│  successful for 1001@domain.com                                 │
│                                                                 │
│  2026-01-16 10:30:46 [DEBUG] Dialplan: Processing call from    │
│  1001 to 2001                                                   │
│                                                                 │
│  2026-01-16 10:30:47 [WARNING] Gateway: Connection timeout     │
│  to provider1                                                   │
│                                                                 │
│  2026-01-16 10:30:48 [ERROR] Channel error: User not found     │
│                                                                 │
│  ... (more entries)                                             │
│                                                                 │
│  Showing 1000 lines                                             │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP
Auto-refresh: Enable for real-time monitoring during troubleshooting.
TIP
Filter First: Use level filter to reduce noise before searching.
CAUTION
Clear Log: This action cannot be undone. Download first if needed.

---

4. Available Logs

FreeSWITCH Log

PropertyValue
Path/var/log/freeswitch/freeswitch.log
ContentCall processing, SIP events, dialplan
LevelsDEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL
Common Log Entries:
  • SIP registrations
  • Call start/end
  • Dialplan actions
  • Gateway status
  • Lua script execution

Fail2ban Log

PropertyValue
Path/var/log/fail2ban.log
ContentSecurity blocks, IP bans
LevelsINFO, NOTICE, WARNING, ERROR
Common Log Entries:
  • IP ban events
  • Unban events
  • Jail status
  • Rule matches

---

Log Level Filters

LevelDescriptionColor
DebugDetailed debugging infoGray
InfoNormal operationsBlue
NoticeNotable eventsGreen
WarningPotential issuesYellow
ErrorError conditionsRed
CriticalCritical failuresDark Red

Search Tips

Search ForExample
Caller ID5558881234
Extension1001
Gatewayprovider1
Error typetimeout
SIP messageINVITE
IP address192.168.1.100
---

6. Common Scenarios & Examples

Scenario 1: Find Call Errors

  1. Select FreeSWITCH log
  2. Set Level to Error
  3. Search for extension number
  4. Review error messages

Scenario 2: Monitor Security

  1. Select Fail2ban log
  2. Enable Auto-refresh
  3. Watch for ban events
  4. Check blocked IPs

Scenario 3: Debug Registration

  1. Select FreeSWITCH log
  2. Set Level to Debug
  3. Search for extension
  4. Find registration messages

Scenario 4: Export for Analysis

  1. Select desired log
  2. Apply filters if needed
  3. Click Download
  4. Open in log analyzer tool

---

7. Limitations & Important Notes

Technical Notes

NOTE
Line Limit: Display is limited to prevent browser slowdown.
NOTE
Server-Side Reading: Logs are read from server filesystem.
WARNING
Large Logs: Very large log files may take time to load.

Best Practices

  1. Filter First: Apply level filter before search
  2. Use Auto-refresh: For live monitoring
  3. Download Regularly: Archive important logs
  4. Clear Carefully: Download before clearing
  5. Search Specific: Use specific search terms

---

8. Troubleshooting Tips

Common Issues

SymptomPossible CauseSolution
No entriesLog emptyCheck log exists on server
Load errorPermission deniedCheck backend permissions
Slow loadingLarge log fileFilter by level
Search no resultsWrong search termTry different keywords
Clear failsPermission deniedCheck write permissions

Log File Locations

LogPath
FreeSWITCH/var/log/freeswitch/freeswitch.log
Fail2ban/var/log/fail2ban.log

Server-Side Verification

Bash
# Check log exists and has content
ls -la /var/log/freeswitch/freeswitch.log
tail -n 50 /var/log/freeswitch/freeswitch.log

# Check permissions
ls -la /var/log/freeswitch/

---

9. Glossary

TermDefinition
Log LevelSeverity category of log entry
Auto-refreshAutomatic periodic update
TailView end of log file
FilterShow only matching entries
FreeSWITCHTelephony engine
Fail2banSecurity intrusion prevention
---

Lua Script Status ℹ️

No Lua Handler Required

ComponentStatus
Log File Viewerℹ️ Frontend-only module - reads logs via backend file API
Log File Viewer is a React-based frontend module. Log files are read by the backend service and sent to the browser. No Lua handlers are used.

---

Documentation last updated: January 2026
AI Assistant

👋 Hello! I'm your Ring2All documentation assistant. I can help you find information about configuring and using the Ring2All PBX platform.

How can I help you today?