-
Notifications
You must be signed in to change notification settings - Fork 799
AI Log Summary #11512
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
OlufunkeMoronfolu
wants to merge
6
commits into
development
Choose a base branch
from
olu-ai-log-summary
base: development
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
AI Log Summary #11512
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
cceed63
Add AI Log Summary feature and update release notes
OlufunkeMoronfolu ff45c8c
Fix URL in AI Log Summary documentation and update reference in relea…
OlufunkeMoronfolu 1626bbc
Update AI Log Summary documentation to clarify beta status and limita…
OlufunkeMoronfolu c4c046e
Refine AI Log Summary documentation for clarity and accuracy
OlufunkeMoronfolu 44e91eb
update links for log summary
OlufunkeMoronfolu e21fb84
Merge branch 'development' into olu-ai-log-summary
OlufunkeMoronfolu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
17 changes: 17 additions & 0 deletions
17
content/en/docs/deployment/mendix-cloud-deploy/maia-operate/_index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| title: "Maia Operate" | ||
| url: /developerportal/deploy/maia-operate/ | ||
| description: "Describes Maia Operate, which provides AI assistance for operating Mendix applications running on Mendix Cloud." | ||
| weight: 14 | ||
| no_list: false | ||
| description_list: true | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| Operating a production application requires continuous monitoring of its health and behavior. This often involves reviewing logs, investigating errors, and understanding application activity over time. | ||
|
|
||
| Maia Operate simplifies these operational tasks by using data already available in Mendix Cloud to provide AI-powered insights into your running application. It helps you understand incidents more quickly, reduce investigation time, and spend less effort on routine operational work. | ||
|
|
||
|
|
||
| ## Documents in This Category | ||
61 changes: 61 additions & 0 deletions
61
content/en/docs/deployment/mendix-cloud-deploy/maia-operate/ai-log-summary.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| --- | ||
| title: "AI Log Summary" | ||
| url: /developerportal/maia-operate/ai-log-summary/ | ||
| description: "Describes the AI Log Summary feature, which provides a daily AI-generated digest of application log activity for Mendix applications running on Mendix Cloud." | ||
| weight: 10 | ||
| beta: true | ||
| --- | ||
|
|
||
| {{% alert color="warning" %}} | ||
| This feature is in Public Beta. For more information, see [Release Status](/releasenotes/release-status/). | ||
| {{% /alert %}} | ||
| ## Introduction | ||
|
|
||
| AI Log Summary is a feature of Maia Operate that provides an AI-generated daily digest of your application's log activity for a single Mendix environment. By analyzing the previous 24 hours of log data, it generates a summary of error patterns, application lifecycle events, and security signals, giving you a quick operational overview without the need to manually download or review raw log files. | ||
|
OlufunkeMoronfolu marked this conversation as resolved.
Outdated
|
||
|
|
||
| Summaries are generated on demand and are intended to help identify areas that may require further investigation. They provide a starting point for troubleshooting and should be used alongside the underlying log data, not as a replacement for it. | ||
|
|
||
| {{% alert color="info" %}} | ||
|
OlufunkeMoronfolu marked this conversation as resolved.
|
||
| AI Log Summary is only available for apps running on Kubernetes clusters. It is not available for apps running on Mendix Cloud V3 or other non-Kubernetes environments. | ||
| {{% /alert %}} | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| To use AI Log Summary, you must have **Access to Monitoring** permission for the environment. For more information, refer to [Node Permissions](/developerportal/deploy/node-permissions/#access-to-monitoring). | ||
|
|
||
| ## Generating a Log Summary {#generate} | ||
|
|
||
| To generate an AI Log Summary: | ||
|
|
||
| 1. Open your app in [Apps](https://sprintr.home.mendix.com/). | ||
|
OlufunkeMoronfolu marked this conversation as resolved.
Outdated
|
||
| 2. Go to the **Environments** page. | ||
| 3. In the **Overview** tab, locate the target environment. | ||
| 4. Click **Explain**. | ||
|
|
||
| Analysis typically takes 10–30 seconds. AI Log Summary displays a progress indicator while the analysis is running. | ||
|
|
||
| {{% alert color="info" %}} | ||
|
OlufunkeMoronfolu marked this conversation as resolved.
Outdated
|
||
| AI Log Summary is currently not available in Mendix Cloud Africa (Cape Town). | ||
| {{% /alert %}} | ||
|
|
||
| ## Understanding the Summary {#understand} | ||
|
|
||
| When the AI analysis is complete, the summary opens in a read-only window. It is presented in plain language, which can be copied for use in tickets or documentation. It includes the following sections: | ||
|
|
||
| * **Status overview** – a snapshot of application health, including uptime, total error count and security events | ||
| * **Timeline of events** – a chronological view of significant lifecycle events, such as startup and shutdown events, critical errors, deployments, and configuration changes | ||
| * **Error analysis** – errors grouped by pattern, with occurrence counts and the timeframe in which they appeared | ||
| * **Security signals** – patterns in HTTP access logs that may indicate unusual activity, such as repeated failed authentication attempts or suspected probes | ||
|
|
||
| {{% alert color="warning" %}} | ||
| Summaries are best-effort and may miss edge cases or omit patterns that appear infrequently in the log data. Always verify findings against the raw log data before taking action. Do not use summaries as the sole basis for application changes, compliance decisions, or security assessments. | ||
|
OlufunkeMoronfolu marked this conversation as resolved.
Outdated
|
||
| {{% /alert %}} | ||
|
|
||
| ## Data Handling {#data-handling} | ||
|
|
||
| Log retention follows the existing log retention policies for your environment, independent of this feature. For more information, refer to the [Rotation and Retention Schedule](/developerportal/operate/logs/#retention-schedule) section of *Logs*. | ||
|
|
||
| ## Read More | ||
|
|
||
| * [Logs](/developerportal/operate/logs/) | ||
| * [Monitoring Your Mendix Apps](/developerportal/operate/monitoring-application-health/) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶 |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.