Ctrl K
ring2all.com

Log Profiles Module Documentation

Table of Contents

  1. Module Overview (Technical)
  2. Module Overview (Commercial/Business)
  3. Module Overview (End User/Administrator)
  4. Configuration Sections
  5. Settings Reference
  6. Common Scenarios & Examples
  7. Limitations & Important Notes
  8. Troubleshooting Tips
  9. Glossary

---

1. Module Overview (Technical)

What Are Log Profiles?

Log Profiles is an audit configuration module that defines which user actions generate log entries and trigger system notifications. Each profile contains a matrix of modules with logging and notification settings for Create, Edit, and Delete operations.

Architecture

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│               Log Profiles Architecture                        │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Log Profile Definition                                         │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Log Profile: Standard Audit                       │   │
│  │                                                          │   │
│  │  Per-Module Settings:                                    │   │
│  │                                                          │   │
│  │  Module          │ Logs        │ Notifications           │   │
│  │  ─────────────────────────────────────────────────────── │   │
│  │  Extensions      │ C E D       │ - - D                   │   │
│  │  Ring Groups     │ C E D       │ - - -                   │   │
│  │  Queues          │ C E D       │ C - D                   │   │
│  │  System Settings │ C E -       │ C E -                   │   │
│  │  Users           │ C E D       │ C E D                   │   │
│  │                                                          │   │
│  │  C=Create, E=Edit, D=Delete                             │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Assigned to users                                      │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Users                                             │   │
│  │                                                          │   │
│  │  User: jsmith → Log Profile: Standard Audit             │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Actions trigger                                        │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Audit System                                      │   │
│  │                                                          │   │
│  │  ├─ Log entries → Audit Logs                            │   │
│  │  └─ Notifications → Email/Webhook                       │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

TablePurpose
public.log_profilesProfile definitions
public.log_permissionsModule settings matrix

Key Files

FileDescription
modules/logProfiles/Frontend module
---

2. Module Overview (Commercial/Business)

Business Value

Log Profiles provides audit control:

Without Log ProfilesWith Log Profiles
Log everythingSelective logging
No notificationsAction alerts
Storage bloatEfficient audit
NoiseRelevant records

Use Cases

  1. Compliance Auditing

- Log all critical changes

- Meet regulatory requirements

  1. Change Notifications

- Alert on user changes

- Alert on security events

  1. Selective Logging

- Log only important actions

- Reduce storage usage

  1. Per-User Audit

- Different logging levels

- Sensitive user tracking

Feature Highlights

FeatureBenefit
Per-Module ControlGranular logging
Action TypesCreate, Edit, Delete
Log ToggleEnable/disable logging
Notify ToggleEnable/disable alerts
User AssignmentPer-user profiles
InheritanceParent module settings
---

3. Module Overview (End User/Administrator)

What Can You Do?

  • Create custom log profiles
  • Set logging per module/action
  • Set notifications per module/action
  • Assign profiles to users
  • Duplicate existing profiles
  • Search modules in matrix

Log Profiles Interface

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Log Profiles                                       │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  [+ Create Profile]                                             │
│                                                                 │
│  [🔍 Search log profiles...]                                    │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Name            │ Description        │ Modules │ Users   │  │
│  ├─────────────────┼────────────────────┼─────────┼─────────┤  │
│  │ Full Audit      │ Log everything     │ 45      │ 2       │  │
│  │ Standard Audit  │ Log critical only  │ 20      │ 5       │  │
│  │ Minimal Audit   │ Security changes   │ 8       │ 3       │  │
│  │ Notifications   │ Alert on changes   │ 15      │ 1       │  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Create/Edit Log Profile

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Edit Log Profile                                   │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  ▼ Basic Information                                            │
│                                                                 │
│  Log Profile Name: [Standard Audit           ]                 │
│    Unique name for this logging profile                         │
│                                                                 │
│  Description: [Log critical changes only     ]                 │
│    Optional description                                         │
│                                                                 │
│  ──────────────────────────────────────────────────────────────│
│                                                                 │
│  ▼ Log and Notification Permissions                             │
│                                                                 │
│  Define which actions generate log entries or trigger           │
│  system notifications.                                          │
│                                                                 │
│  [🔍 Search permissions...]                                     │
│                                                                 │
│  ┌─────────────────────────────────────────────────────────────┐│
│  │ Module               │ Logs:        │ Notifications:       ││
│  │                      │ C   E   D    │ C   E   D            ││
│  ├──────────────────────┼──────────────┼──────────────────────┤│
│  │ ▼ Dashboard          │ ☐   ☐   ☐    │ ☐   ☐   ☐            ││
│  │ ▼ Telephony          │              │                      ││
│  │   ├─ Extensions      │ ✓   ✓   ✓    │ ☐   ☐   ✓            ││
│  │   ├─ Ring Groups     │ ✓   ✓   ✓    │ ☐   ☐   ☐            ││
│  │   ├─ Queues          │ ✓   ✓   ✓    │ ✓   ☐   ✓            ││
│  │   └─ Conferences     │ ✓   ☐   ✓    │ ☐   ☐   ☐            ││
│  │ ▼ System             │              │                      ││
│  │   ├─ System Settings │ ✓   ✓   ☐    │ ✓   ✓   ☐            ││
│  │   ├─ Users           │ ✓   ✓   ✓    │ ✓   ✓   ✓            ││
│  │   └─ Role Profiles   │ ✓   ✓   ✓    │ ✓   ✓   ✓            ││
│  └─────────────────────────────────────────────────────────────┘│
│                                                                 │
│  C = Create | E = Edit | D = Delete                            │
│                                                                 │
│  [Save] [Cancel]                                                │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP
Notifications: Use sparingly to avoid alert fatigue.
TIP
Security Focus: Always log Users and Role Profile changes.
NOTE
Inheritance: Blue dots indicate inherited settings.

---

4. Configuration Sections

Basic Information

FieldDescription
Log Profile NameUnique identifier
DescriptionPurpose explanation

Log and Notification Permissions

ColumnDescription
ModuleSystem module/feature
Logs: C E DCreate, Edit, Delete logging
Notifications: C E DCreate, Edit, Delete alerts
---

5. Settings Reference

Action Types

ActionCodeDescription
CreateCNew record created
EditERecord modified
DeleteDRecord removed

Toggle States

StateMeaning
✓Enabled
☐Disabled
🔵Inherited from parent

Notification Channels

ChannelPurpose
EmailAdmin email alerts
WebhookExternal integrations
In-AppDashboard notifications
---

6. Common Scenarios & Examples

Scenario 1: Full Audit Profile

  1. Click "Create Profile"
  2. Name = "Full Audit"
  3. Enable ALL logging checkboxes
  4. Disable most notifications
  5. Save

Scenario 2: Security Alert Profile

  1. Click "Create Profile"
  2. Name = "Security Alerts"
  3. Focus on Users, Role Profiles
  4. Enable all logs: C E D
  5. Enable all notifications: C E D
  6. Save

Scenario 3: Minimal Logging

  1. Click "Create Profile"
  2. Name = "Minimal Audit"
  3. Only enable Delete logging
  4. Only critical modules
  5. Save

Scenario 4: Change Notifications

  1. Create new profile
  2. Name = "Change Alerts"
  3. Disable all logs (handled elsewhere)
  4. Enable Edit notifications on critical modules
  5. Save

---

7. Limitations & Important Notes

Technical Notes

NOTE
User Assignment: Profile must be unassigned before deletion.
NOTE
Log Storage: Logs consume database space.
WARNING
Notification Volume: Too many alerts reduces effectiveness.

Best Practices

  1. Log Critical Changes: Users, Roles, System Settings
  2. Selective Notifications: Only true emergencies
  3. Review Regularly: Audit log profile effectiveness
  4. Storage Management: Archive old logs
  5. Test Notifications: Verify delivery

ModuleLogNotify
UsersC E DC E D
Role ProfilesC E DC E D
System SettingsC EC E
ExtensionsC E D- - D
GatewaysC E DC E D
---

8. Troubleshooting Tips

Common Issues

SymptomPossible CauseSolution
No logs appearingProfile not assignedAssign to user
Too many notificationsOver-configuredReduce notify toggles
Can't delete profileUsers assignedReassign users first
Inheritance unclearParent settingCheck module hierarchy

Check Profile Assignment

Sql
SELECT 
  u.username,
  l.name AS log_profile
FROM public.users u
LEFT JOIN public.log_profiles l ON l.id = u.log_profile_id
ORDER BY l.name;

Verify Logging

  1. Assign profile to test user
  2. Perform logged action
  3. Check Audit Logs module
  4. Verify entry appears

---

9. Glossary

TermDefinition
Log ProfileAudit configuration set
Audit LogRecord of user action
NotificationAlert on action
Create (C)New record action
Edit (E)Modify action
Delete (D)Remove action
---

Lua Script Status ℹ️

Admin Module

ComponentStatus
Log Profilesℹ️ Audit configuration - no Lua handler required
Log Profiles is an administration module. It configures what actions are logged and notified. No Lua handlers are used - audit logging is handled by the backend API middleware.

---

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?