Skip to content
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

Editing ai #688

Merged
merged 4 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/user-guide/app360/service-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ Clicking on one of the services or clicking on drill down opens a dashboard with

You can change the time frame and add additional filters, including comparing the data to a previous period or choose an environment, nodes, and pods. Clicking the refresh button will manually update the data.

![service deeper](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/services-service-drilldown-aug26.png)

![service deeper](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/service-main-oct21.png)


Hovering over the graphs provides additional info for the time point you've chosen:
Expand Down Expand Up @@ -174,12 +175,12 @@ Once your anomaly detector is up and running, you'll see an indicator in the lis

![no anomaly](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/no-anomaly.png)

## AI Assistant
## AI Agent

Click the **AI Assistant** button to activate the [Observability IQ Assistant](https://docs.logz.io/docs/user-guide/observability/assistantiq/), an AI-powered, chat-based interface that lets you engage in a dynamic conversation with your data. Use one of the pre-configured prompts or type your own question to get real-time insights about your metrics, anomalies, trends, and the overall health of your environment.
Click the **[AI Agent](https://docs.logz.io/docs/user-guide/observability/assistantiq/)** button to activate an AI-powered, chat-based interface that lets you engage in a dynamic conversation with your data. Use one of the pre-configured prompts or type your own question to get real-time insights about your metrics, anomalies, trends, and the overall health of your environment.


![AI App360](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/aikapp360.gif)
![AI App360](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/services-ai-agent-oct21.png)



Expand Down
29 changes: 15 additions & 14 deletions docs/user-guide/explore/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,16 @@ Explore supports a few query methods, including:

Logz.io offers an intuitive and easy way to build your query. You can build queries easily by selecting fields, conditions, and values.

Click the search bar or type to see available fields, add operators, and choose values. To use custom values, type the name and click the + sign. Press Enter to apply the query or Tab to add another condition.

Free-text searches automatically convert into Lucene queries.
Click the search bar or start typing to see the available fields, parameters, and conditions. To add a custom value, type its name and click the + sign. You can also add free text to your search, converting it into a Lucene query.

## Lucene

Logz.io supports Lucene for more advanced queries.

Search for free text by typing the text string you want to find; for example, `error` will return all words containing this string, and using quotation marks, `"error"`, will return only the specific word you're searching for.
Type the string or query you want to find. For example, `error` will return all words containing this string, and using quotation marks, `"error"`, will return only the specific word you're searching for.


![See error](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/basic-search-search-word.png)
![See error](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/saved-search/explore-error-oct21.png)

Search for a value in a specific field:

Expand Down Expand Up @@ -56,14 +55,14 @@ To exclude a term from your search, you can use the following syntax:

Use the filters to refine your search, whether you're using Simple or Lucene. Open string fields to view its related values, and open numeric fields to choose a range. For example, `LogSize` lets you select the size of the logs you're interested in:

![numeric filters](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/logsize-explore-aug27.png)
![numeric filters](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/saved-search/logsize-oct21.png)



## Regex in Lucene

:::caution
Using regex can overload your system and cause performance issues in your account. If regex is necessary, it is best to apply filters and use shorter timeframes.
Using regex can overload your system and cause performance issues in your account. If regex is necessary, applying filters and using shorter timeframes is best.
:::

Logz.io uses Apache Lucene's regular expression engine to parse regex queries, supporting regexp and query_string.
Expand All @@ -72,7 +71,7 @@ While Lucene's regex supports all Unicode characters, several characters are res

`. ? + * | { } [ ] ( ) " \`

Depending on the optional operators enabled, some additional characters may also be reserved. These characters are:
Some additional characters may also be reserved depending on the optional operators enabled. These characters are:

`# @ & < > ~`

Expand Down Expand Up @@ -100,19 +99,21 @@ To find one of the values in the field, such as `fox`, you'll need to use the fo

You can add additional columns to your logs table view.

Find the field you'd like to add, hover over it and click the **Toggle column in table** button.
Find the field you'd like to add, hover over it and click the **Toggle column in table** button (table icon).

![Add field](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/toggle-in-table-sep9.png)
![Add field](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/toggle-explore-oct21.png)

Once added, you can drag it to reposition it, or click the **X** to remove it.

Save your query to quickly access it whenever needed. The query is saved while the results change according to your chosen relevant time frame.
## Save Searches

Save your current query or filtered view to quickly access it whenever needed. Click on the Save icon > Save Search and name your search. The query is saved while the results change according to your chosen time frame.

![Save field](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/saved-search-sep9.png)
![Save field](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/saved-search/save-search-oct21.png)


## Select logs' time frame

The default period to display results is 15 minutes. You can edit this time frame by clicking on the time picker. Choose an option from the quick menu, or switch to the absolute view to select a specific time frame. In this option, you can type the time frame you want to view.
The default period to display results is 15 minutes. You can edit this time frame by clicking on the time picker. Choose an option from the quick menu, or switch to the absolute view to select a specific time frame. You can type the time frame you want to view using this option.

![Time frame options](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/time-picker-sep9.png)
![Time frame options](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/timepicker-oct21.png)
4 changes: 2 additions & 2 deletions docs/user-guide/explore/exceptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It's integrated into Explore, where you can easily see the number of exceptions

To review exceptions affecting your environments, click the **Exceptions** button. This will open a quick view menu where you can review and filter the exceptions.

![Exceptions in Explore](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/exceptions-quick-view.png)
![Exceptions in Explore](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/exceptions-oct21.png)

### What's an exception?

Expand All @@ -37,7 +37,7 @@ You can find and view all exceptions by using the following query:

`_exists_: _logzio_logceptions OR _exists_:"_logzio_insights"`

![Find exceptions in Explore](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/logzio-insights.png)
![Find exceptions in Explore](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/all-exceptions-oct21.png)

Click the **Exceptions** button to see all exceptions related to your current query.

Expand Down
28 changes: 15 additions & 13 deletions docs/user-guide/explore/explore-log-alerts/intro-alerts-explore.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,35 +19,35 @@ Open the Explore Dashboard, create a query or simple search to trigger your aler

You'll be redirected to the Create an alert page, where you can continue configuring your alert.

![Alert from dashboard](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/alerts/alert-dashboard-button.png)
![Alert from dashboard](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/alerts/explore-create-alert-oct21.png)

To manually build an alert, navigate to **[Alerts > + New alert](https://app.logz.io/#/dashboard/alerts/v2019/new)** to configure and create an alert.

![Alert from dashboard](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/alerts/alert-button.png)
![Alert from dashboard](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/alerts/new-alert-oct21.png)

### Review existing alerts

To view a paginated list of all alerts configured for your account, navigate to the [Alerts](https://app.logz.io/#/dashboard/triggers/alert-definitions) section.

You can sort the list by clicking on the column headers or using the top filters. Sort by severity, creator, tags, or alert status.

Use the search bar to quickly find a specific alert.
Use the search bar to find a specific alert quickly.

To filter alerts chronologically by **name**, **severity**, **creation date**, or **update date**, click on the corresponding column header.
Click on the corresponding column header to filter alerts chronologically by **name**, **severity**, **creation date**, or **update date**.

![Alert definitions](https://dytvr9ot2sszz.cloudfront.net/logz-docs/alerts/alerts-updated-by-screenshot.png)
![Alert definitions](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/alerts/alerts-oct21.png)

### Manage Log alerts

You can manage alerts individually or in bulk.

Use search terms and filters to locate the alerts you want to edit. Select them by clicking the checkbox next to each alert or select all visible alerts on the page (up to 25) by checking the top box.
Use search terms and filters to locate the alerts you want to edit. Select them by clicking the checkbox next to each alert, or check the top box to select all visible alerts on the page (up to 25).

![Select alerts](https://dytvr9ot2sszz.cloudfront.net/logz-docs/alerts/select-alerts.gif)
![Select alerts](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/alerts/edit-alerts-oct21.gif)

If you need to edit more than 25 alerts, you can select all alerts that match your search criteria by clicking the hypertext link located at the top right of the table.
If you need to edit more than 25 alerts, you can select all alerts that match your search criteria by clicking the hypertext link at the top right of the table.

![Alert bulk actions](https://dytvr9ot2sszz.cloudfront.net/logz-docs/alerts/select-all-alerts.png)
![Alert bulk actions](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/alerts/select-alerts-oct21.png)


:::note
Expand All @@ -57,13 +57,13 @@ You can act on **up to 1,000** alerts simultaneously.

<h3 id="individual">Individual alerts</h3>

Each alert features a **State** button that you can toggle to enable or disable the alert as needed.
Each alert features a **State** button that you can toggle to turn the alert on or off as needed.

To edit, duplicate, or delete an alert, hover over its row to reveal the **Delete** and **Edit** buttons.

Click the **Menu button (:)** to access additional options such as **duplicating** the alert or **viewing the latest events**. Selecting the latter will display the alert query and the number of hits in the Explore Dashboard.

![Alert additional options](https://dytvr9ot2sszz.cloudfront.net/logz-docs/explore-dashboard/alerts/hover-menu-items.png)
![Alert additional options](https://dytvr9ot2sszz.cloudfront.net/logz-docs/alerts/alert-menu-oct21.png)



Expand All @@ -77,12 +77,14 @@ Choosing one or more alerts opens a top menu with the following actions:
* **Deactivate** - Set all selected alerts to inactive
* **Recipient** - Add or replace recipients and notification points

![Alert edit menu](https://dytvr9ot2sszz.cloudfront.net/logz-docs/alerts/alert-edit-menu.png)
![Alert edit menu](https://dytvr9ot2sszz.cloudfront.net/logz-docs/alerts/multiple-alerts-oct21.png)

Clicking on the **Recipient** option opens a pop-up with two options:

**Add** - Add new recipients and notification points to the existing ones. This can include Slack channels, email addresses, and more.

**Replace** - Remove existing notification points and recipients, and replace them with new settings. Note that you **won't be able to review** the current notification settings **or revert** this action once saved.

![Alert recepients edit](https://dytvr9ot2sszz.cloudfront.net/logz-docs/alerts/add-replace-alerts.png)
Click **Confirm** to apply your changes.

<img src="https://dytvr9ot2sszz.cloudfront.net/logz-docs/alerts/add-replace-oct21.png" alt="edit-alerts" width="700"/>
Loading