DOCSEARCHbyAlgolia
Submit Docs

LOGether Documentation

website·Indexed 30 days ago

https://docs.logether.cloud

A monitoring and alerting layer that integrates with AlertFleet to watch system logs and send notifications. Features include a System Log for searching and filtering log streams, an Alert Manager for defining triggers based on log rules, and integration with the AlertFleet API.

Tokens
3.4K
Snippets
3
Records
35
Agent score
50%

What's inside LOGether

  1. Overview of LOGether monitoring and alerting capabilities

    LOGether serves as a monitoring and alerting layer that integrates with AlertFleet to watch system logs and send notifications across multiple channels. Key capabilities include:

    • Connecting to TCP controllers via Public Host, Public Port, and Controller Number.
    • Managing multiple Systems (subject to plan limits).
    • Interacting with System Logs through a table interface to add markers/annotations, filter, search, and control system power (start/stop) or schedule on/off timers.
    • Sharing read-only system views with guests using a link, password, and pseudonym.
    • Exporting or clearing logs (resetting to 0).
    • Configuring Recipients (SMS, WhatsApp, Email, Webhook) and up to 5 Triggers per system using AND/OR logic chains to trigger notifications based on log conditions.

  2. Secure controller connectivity using the LOGether VPN Tunnel

    The VPN Tunnel uses WireGuard to create an encrypted, authenticated channel between LOGether Cloud and a local VPN client in the same LAN as the Vantage controller. This removes the need to expose the controller's TCP port directly to the public internet, reducing the attack surface and ensuring encrypted communication.

  4. Start and stop log collection for a System

    To begin receiving logs from a controller, click the green Connect button in the top-right toolbar. To stop receiving logs, click the red Disconnect button. A confirmation popup will appear upon disconnecting, which can be disabled for future actions.

  5. Create and configure a new System in LOGether

    Adding a System allows you to track logs and manage alerts for a specific controller. Once created, the system will appear in the pickers on the System Log and Alert Manager pages.

    Steps to create a system:

    1. Log in to logether.cloud.
    2. Navigate to Subscription → Systems and click Add System.
    3. Provide the following details:
      • Name: A descriptive label (e.g., 'Seaside House - Hotel Blue').
      • Description (Optional): Additional notes.
      • Public Host: The controller's DNS name or IP address (must be reachable from LOGether).
      • Public Port: The TCP port exposed by the controller.
      • Controller Number: The device/controller ID used for authentication.
    4. Click Create system.

  6. Create and manage log triggers

    Triggers define the rules that fire notifications when specific log lines match. You can create up to 5 triggers per System (subject to plan limits). Triggers support AND/OR logic on fields such as Body and Timestamp.

    Each trigger allows you to:

    • Select one or more delivery channels (SMS, WhatsApp, Email, Webhook).
    • Review matched log lines using the eye icon.
    • Jump to the System Log to see the matched line with 5 lines of context before and after.
    Example conditions:
IF "Body" CONTAINS "Disconnected"
AND "Timestamp" TIME BETWEEN "00:00:00" "23:00:00"

  7. Review and debug triggered log lines

    To inspect lines that fired a trigger:

    1. Click the Eye icon on a trigger card to view the match history (limited to the last 50 matches).
    2. Click the icon on the far right of a match to jump to the System Log, where the specific line is highlighted with ±5 lines of context.
    3. To verify if a notification was successfully delivered to the end user, check the Alert Logs within the AlertFleet dashboard.

  8. Schedule automatic log start and stop times

    For subscription plans that include scheduling, you can automate when logging is enabled and disabled:

    1. Click the Timer button in the toolbar above the log table.
    2. Set the desired Start and Stop times in the popup.
    3. Confirm the settings.

  9. Change or downgrade a subscription plan

    Directly downgrading a current subscription plan is not possible. To move to a lower-tier plan, you must cancel your existing plan at the end of its current term and then subscribe to the desired new plan.

  10. Control log ingestion for a System

    You can manage the flow of logs for a specific System using the following controls:

    • Start logging: Begin ingesting messages for the selected System.
    • Stop logging: Pause the ingestion of messages.
    • Timed Start/Stop: Set a timer to automatically enable or disable logging at specific times (available on certain subscription plans).

  11. Share a System log view with guests

    Depending on your subscription plan, you can share a System view with a trusted guest. Sharing requires a link, a password, and a guest name. Guests granted access can view, filter, annotate, and mark logs for that specific shared System only.

  12. Collaborate on log lines using Annotations and Markers

    Logether provides two primary ways to collaborate on specific log entries:

    • Annotations: Attach a short comment thread to a specific log line, which is useful for investigations or hand-offs.
    • Markers: Drop a visual flag on a line to highlight key moments.

    Caveat: Avoid putting sensitive details in annotations if the log view is intended to be shared externally.