Logstyx

Appearance

Dashboard ​

The Logstyx Dashboard is your central hub for managing logs, monitoring application health, and gaining insights from your logging data. This guide covers the main features and navigation.

Accessing the Dashboard ​

After installing Logstyx, access the dashboard at:

http://localhost:5000

Or your configured domain in production:

https://logs.yourcompany.com

First Login ​

  1. Navigate to /login in your browser
  2. Use the credentials you set during installation:
    • Email: The email you provided during setup
    • Password: The password you created during setup
  3. After successful login, you'll land on the Projects dashboard (home page)

Default Credentials

If you used the automated installer, your credentials are stored in the .env file at the root of your Logstyx installation.

Dashboard Layout ​

The sidebar provides access to main sections. Items shown depend on your user permissions:

  • Projects - Overall project list and overview
  • Probes - Configure automated data collectors that fetch external data
  • Reports - Create and view dashboards/reports built from your logs (can be public)
  • Webhooks - Create webhooks to send log data to external endpoints
  • Alerts - Create alerting rules for log conditions
  • Users - User management and invitations (admin only)
  • Logout - At the bottom of the sidebar

Main Content Area ​

The top/main area changes based on your menu selection. Project-level pages include tabs:

  • Overview - Configuration summary, activity charts, and quick stats
  • Logs - The log viewer (most frequently used)
  • Users - Project-level user access management (when permitted)

Projects Dashboard (Home) ​

The Projects dashboard is your starting point after login.

Overview Stats Cards ​

At the top, you'll see four key metrics:

  • Total Projects - Number of projects you have access to
  • Logs Today - Total logs received today across all projects
  • Total Errors - Count of error-level logs
  • Critical Issues - Count of critical-level logs

Projects Grid ​

Each project is displayed as a card showing:

  • Project Title and status badge
  • Last Log Time - When the most recent log was received
  • Log Counts - Breakdown by level (total logs, errors, critical)
  • Mini Activity Chart - Visual representation of recent activity
  • Quick Alert Banner - Appears if critical issues exist

Project Actions ​

Each project card provides quick actions:

  • View Logs - Opens the project's log viewer
  • Settings (gear icon) - Access project settings and details

Project Details ​

When you open a project, you'll see:

Project Header ​

  • Project Name and slug
  • Active Badge - Shows current status
  • Update Settings button

Stats Cards ​

Detailed breakdown showing:

  • Total log counts
  • Warnings count
  • Errors count
  • Critical issues count

Project Tabs ​

Navigate between three main views:

1. Overview Tab ​

  • Configuration summary
  • Activity charts
  • Quick statistics

2. Logs Tab ​

The most-used feature for investigating logs. See Viewing Logs for detailed usage.

Key features:

  • Recent Logs Table - Displays logs with configurable columns
  • Columns Button - Toggle which index columns are visible
  • Add Filter - Create filters to narrow results
  • Sorting - Click column headers to sort (ascending/descending)
  • Refresh Button - Reload logs manually
  • Pagination - Navigate through pages of results
  • Detail View - Click a log entry to see full raw payload (modal)
  • Timeline - View related events around a specific log

3. Users Tab ​

Manage project-level user access (requires appropriate permissions).

Key Features ​

Filtering Logs ​

The filtering system allows you to narrow down logs:

  • Click Add Filter to create a new filter
  • Select a field from your configured indexes
  • Choose an operator:
    • For hashed/indexed fields: Exact match with dropdown of existing values
    • For raw numeric fields: Range operators (>, >=, <, <=)
  • Enter or select the value
  • Add multiple filters to refine results further
  • Remove filters if results become too narrow

Exact Match Only

Due to hashed indexing for privacy, Logstyx supports exact match queries only. Partial or fuzzy text search is not available. See Limitations for more details.

Log Levels and Colors ​

Log entries are color-coded by severity:

  • Info - Normal operational messages
  • Warning - Potential issues that need attention
  • Error - Application errors
  • Critical - Severe issues requiring immediate attention

Critical counts are prominently displayed throughout the dashboard. Use filters and timeline views to find root cause sequences around critical events.

Probes ​

Probes are automated data collectors that fetch logs from external systems at regular intervals.

Managing Probes ​

  • Probes run automatically at the specified interval
  • Logs are ingested into the selected project
  • Edit or delete probes from the probe list
  • Monitor probe status and last run time

See Probes Overview for more details.

Reports ​

Reports allow you to visualize logs and metrics, with options to share publicly.

Managing Reports ​

  • Edit existing reports
  • Delete reports you no longer need
  • Copy public links for sharing (if report is public)
  • View reports from the list

Public Report Viewing ​

Public reports can be accessed at /reports/:slug without authentication. This is useful for:

  • Sharing dashboards with stakeholders
  • Creating public incident status pages
  • Providing read-only access to metrics

See Reports Overview for more details.

Webhooks ​

Webhooks forward log data to external endpoints, enabling integrations with other services.

Use Cases ​

  • Send logs to ChatOps platforms (Slack, Discord)
  • Integrate with incident management systems
  • Forward to analytics platforms
  • Trigger custom workflows

See Webhooks Overview for more details.

Alerts ​

Alerts notify you when logs match specific conditions, helping you respond to issues proactively.

Alert Behavior ​

  • Alerts trigger when conditions are met
  • Notifications are sent via configured channels
  • View alert history and status
  • Temporarily silence alerts during maintenance

See Alerts Overview for more details.

User Management ​

Manage team access to your Logstyx instance.

Invitation Process ​

  • Recipients receive an invite link
  • They visit /invitations/:id to accept
  • During acceptance, they set up their account
  • Once complete, they can access Logstyx based on their assigned permissions

Permissions ​

Logstyx uses role-based access control (RBAC):

  • Users only see menu items and actions they have permission to access
  • If you don't see certain sections (Users, Webhooks, Alerts), request the appropriate role from your admin
  • Project-level permissions can be managed per project

See User Management Overview for more details.

Common Workflows ​

A) Investigate a Spike of Errors ​

  1. Open Dashboard → Projects
  2. Identify the project with increased "Errors" or "Critical" counts
  3. Click View Logs for that project
  4. Click Add Filter:
    • Field: level
    • Value: ERROR (or CRITICAL)
  5. Sort by Last Seen or timestamp to find recent occurrences
  6. Click a log entry to open the Detail View and inspect the full payload
  7. Click Timeline on the log entry to see related events around that time

B) Collect Metrics from an External System ​

  1. Go to Probes → Add Probe
  2. Fill in Step 1: Title, choose Project, set Interval (e.g., 60 seconds)
  3. Fill in Step 2: Enter endpoint URL and configure authentication
  4. Click Test Connection to verify connectivity
  5. Complete Step 3 and click Save
  6. Logs start flowing into the project at the specified interval

C) Share a Report Externally ​

  1. Go to Reports → Create Report
  2. Add widgets and configure the queries you want displayed
  3. Set visibility to Public
  4. Save the report
  5. Copy the generated link (/reports/:slug)
  6. Share the link with stakeholders - they can view it without logging in

Tips for Effective Log Investigation ​

Building Filters ​

  • Start with broad filters and narrow down incrementally
  • Remove filters if your results become empty
  • Combine multiple filters for precise queries
  • Use range operators for numeric fields to find values above/below thresholds

Column Management ​

  • Click the Columns button to show/hide index fields
  • Display only the fields relevant to your current investigation
  • Different investigations may need different column configurations

Using Timeline ​

  • Open timeline view on a specific log entry
  • See what happened before and after the event
  • Identify patterns and sequences leading to errors
  • Useful for debugging complex issues with multiple related events

Session Behavior ​

  • Your session remains active while you're using the dashboard
  • If your session expires on a protected page, you'll be automatically redirected to /logout
  • The logout process clears your session and returns you to the login page
  • Click Logout in the sidebar to end your session manually

Permissions and Visibility ​

The dashboard respects role-based access control:

  • Admins see all sections and can manage users
  • Users with READ permissions can view logs and reports
  • Users with WRITE permissions can create and modify resources
  • Menu items and actions are hidden if you lack the required permissions
  • Contact your admin to request additional permissions if needed

Ready to Start Logging?

Check out our SDK Quick Start Guide to integrate Logstyx into your application and start sending logs to the dashboard.

Released under the MIT License.

Copyright © 2025-present Logstyx