Skip to main content

🛑 Advanced Logging

TKI Auth features a comprehensive logging system that tracks every action and event within your authentication system. Our Advanced Logging feature takes this to the next level by creating organized, user-specific threads in Discord forum channels.

Overview​

The logging system in TKI Auth is designed to provide complete visibility into your authentication system's operations. Every license creation, deletion, request, and administrative action is automatically logged and can be sent to dedicated Discord channels.

Basic vs Advanced Logging​

Basic Logging​

  • Logs events to specified Discord channels
  • Separate channels for different event types
  • Real-time notifications for administrators

Advanced Logging​

  • Creates individual forum threads for each user
  • Organizes all user activities in dedicated threads
  • Combines license and request logs in one place
  • Customizable thread naming with dynamic variables

Configuration​

Enabling Advanced Logging​

Logging:
  Enabled: true
  AdvancedLogging:
    Enabled: true
    PostName: "{username}-logs"
    ForumChannelID: "your-forum-channel-id"
    StoreRequests: true
    StoreLicenses: true

Available Variables for Thread Names​

You can customize thread names using these dynamic variables:

VariableDescriptionExample
{userid}Discord User ID123456789012345678
{username}Discord Usernamejohn_doe
{discriminator}Discord Discriminator0001
{tag}Full Discord Tagjohn_doe#0001
{licensekey}License KeyTKI-ABC123-DEF456
{product}Product NameMyAwesomeProduct
{timestamp}Current Date2024-01-15

Logging Categories​

Product Events​

Track all product-related activities:

  • Product Creation: New products added to your system
  • Product Deletion: Products removed from your system
  • Product Version Changes: Version updates and modifications

License Management​

Monitor license lifecycle events:

  • License Creation: New licenses generated
  • License Deletion: Licenses removed or revoked
  • License Updates: Modifications to existing licenses
  • Staff License Events: Special tracking for staff licenses

Security & Access Control​

Keep track of security-related events:

  • Blacklist Creation: Users or IPs added to blacklist
  • Blacklist Removal: Items removed from blacklist
  • Request Success: Successful authentication attempts
  • Request Rejected: Failed or blocked authentication attempts

How Advanced Logging Works​

1. Forum Channel Setup​

When Advanced Logging is enabled, TKI Auth uses Discord's forum channels to create organized threads for each user.

2. Automatic Thread Creation​

When a user first interacts with your system (creates a license, makes a request, etc.), TKI Auth automatically creates a dedicated forum thread for them.

3. Centralized User Activities​

All subsequent activities from that user are logged to their personal thread, creating a complete history of their interactions with your system.

4. Dual Logging Support​

Advanced Logging works alongside traditional channel logging. You can have events logged to both the user's thread AND the specified channels.

Configuration Examples​

Example 1: User-Focused Logging​

AdvancedLogging:
  Enabled: true
  PostName: "{username} Activity Log"
  ForumChannelID: "1234567890123456789"
  StoreRequests: true
  StoreLicenses: true

Example 2: Product-Specific Logging​

AdvancedLogging:
  Enabled: true
  PostName: "{product} - {username}"
  ForumChannelID: "1234567890123456789"
  StoreRequests: true
  StoreLicenses: true

Example 3: Date-Organized Logging​

AdvancedLogging:
  Enabled: true
  PostName: "{timestamp} - {tag}"
  ForumChannelID: "1234567890123456789"
  StoreRequests: true
  StoreLicenses: true

Benefits of Advanced Logging​

🔍 Complete User History​

See everything a user has done in one organized thread, from their first license creation to their latest authentication attempt.

📊 Better Organization​

No more scrolling through hundreds of messages in busy channels. Each user has their own dedicated space.

🚀 Improved Support​

When a user needs help, all their information is readily available in their personal thread.

📈 Enhanced Analytics​

Easily track user behavior patterns and system usage by reviewing individual user threads.

🛡ī¸ Security Monitoring​

Quickly identify suspicious activity by monitoring user-specific threads for unusual patterns.

Important Notes​

Migration Notice

If you enable Advanced Logging on an existing system with licenses already created, the forum threads will not be automatically created for existing users. You'll need to manually set the forum channel ID in your MongoDB dashboard for existing licenses.

Dual Storage

When StoreLicenses is set to true and you still have traditional channel logging enabled, events will be stored in BOTH the user's forum thread AND the specified channels.

Best Practices​

Channel Organization​

  • Use separate forum channels for different products
  • Consider using categories to group related forum channels
  • Set appropriate permissions for staff access

Thread Naming​

  • Keep thread names concise but informative
  • Use consistent naming patterns across your system
  • Include relevant identifiers for easy searching

Storage Settings​

  • Enable StoreRequests for complete activity tracking
  • Enable StoreLicenses for license lifecycle monitoring
  • Consider your Discord server's storage limits when configuring

Troubleshooting​

Forum Channel Not Working?​

  • Ensure the channel ID is correct and points to a forum channel
  • Verify the bot has proper permissions in the forum channel
  • Check that the bot can create threads in the specified channel

Missing Logs?​

  • Verify Advanced Logging is enabled in the configuration
  • Check that both StoreRequests and StoreLicenses are set correctly
  • Ensure the forum channel ID is valid and accessible

Advanced Logging is just one of the many features that sets TKI Auth apart from the competition. Explore more features or get started today.