On this page

• Start Free Trial
• Overview
• Prerequisites
• Enabling Explain Log
• Using Explain Log
• Share your feedback with us
• Limitations
• Frequently asked questions
• Support

Explain Log

Overview

Enhance the user experience by providing clear, natural language explanations for individual logs. This Cora’s capability simplifies the analysis of specific log entries by providing a clear explanation, detailing their significance, immediate impact, and potential causes (for logs with a warning level or higher). By simplifying log interpretation, users, whether or not they have technical expertise or ownership of the service generating the logs, can quickly understand their significance and respond effectively.

Benefits

Use the Explain Log to provide natural language explanations for log entries. This ensures:

• Contextual insights. Detailed overviews help users grasp the broader context of log entries, facilitating better analysis of system behavior.
• Improved comprehension. Users can easily understand complex log data without needing deep technical knowledge. Additionally, complex technical terms in the log explanations are accompanied by tooltips that provide clear definitions of each item.
• Faster decision-making. Clear explanations allow users to quickly assess issues and take appropriate actions. If there is a mismatch between the severity and the content, a message will alert the user to the discrepancy.
• Increased efficiency. Users can efficiently pinpoint problems, reducing downtime and improving overall productivity.
• Proactive issue management. Understanding logs allows users to identify potential issues before they escalate, enhancing system reliability.
• User empowerment. By demystifying logs, users feel more in control and capable of managing their systems effectively.

Prerequisites

1. Navigate to Settings > Account Preferences and verify that the Cora has been enabled. For details, see Getting Started.

Enabling Explain Log

1. Verify that the user has the team-ai-settings:Manage permission.
2. Navigate to Settings > Account Preferences.
3. In the CORA - Coralogix Observation and Research Assistant section, toggle the Explain Log switch to ON.

Using Explain Log

1. Go to any product page in the Coralogix UI that displays logs.

2. Hover over a log entry and click the Explain Log button.

   

   Alternatively, for log pages with [info panel] support, display the panel and click the Explain Log button.

   

   The Explain log side panel is displayed at the right-hand side of the current UI page. It remains visible at all times, even if you navigate away from the current UI page. This ensures a seamless log investigation process, enabling faster insights and quicker resolutions.

3. Explain Log analyzes the log entry and provides natural language explanation of the log.

   • Severity levels - Severity level of each log is color-coded for easy identification. The colors correspond to the standard severity levels (Info, Warning, Error, Critical), as shown in the Severity section of the filtering side panel.
   • What happened? - A clear and concise summary of what the log entry is reporting.
   • How significant is this? - Clarifies the importance of the event by specifying its relevance to the system and whether the user needs to take any action in response.
   • What is the impact? - Evaluates the immediate and potential future impact of the log entry on the user’s system/user platform .
   • Potential Reasons (optional) - For logs with a severity level of Warningor higher, Explain Log offers a root cause analysis, helping to identify why the issue may have occurred.
   • Additional important fields - Covers important fields in the log that may not directly pertain to its core content but can still provide valuable insights for the user. These are infrastructure-related fields, such as cluster name, pod UID, instance ID, etc.
     

   

4. If you need an explanation of a technical concept, simply hover your mouse pointer over the underlined term to view its definition.

5. Click the Copy button at the bottom of the Explain Log panel to copy the response content to your clipboard.

Share your feedback with us

The more you use our Explain Log, the more it improves. As you interact with it, please give the response a thumbs up or thumbs down. If you believe something needs correction or improvement, feel free to share your feedback. Simply click the Thumbs Up or Thumbs Down button at the bottom of the Explain Log panel to let us know.

• If you’re happy with the generated explanation, give us a thumbs up to let us know we're on the right track.
• If you provide a negative response (Thumbs Down), please complete the feedback form, detailing what you didn’t like, and send us your comments. You can select multiple options and/or include your suggestions in the text box.

Limitations

The maximum length for an explainable log entry is 4096 tokens (words, word pieces, characters, punctuation marks).

Frequently asked questions

Which data is sent to OpenAI?

The selected customer’s log entry is sent to OpenAI for processing.

Support

Need help?

Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.

Feel free to reach out to us via our in-app chat or by sending us an email to [email protected].

Previous DataPrime Query Assistance

Next Knowledge Assistance