diff --git a/docs/alerts/monitors/overview.md b/docs/alerts/monitors/overview.md index 2a9ec2c804..a68af47157 100644 --- a/docs/alerts/monitors/overview.md +++ b/docs/alerts/monitors/overview.md @@ -2,32 +2,111 @@ id: overview title: Monitors Overview sidebar_label: Overview -description: Sumo Logic monitors continuously query your logs or metrics and sends notifications when specific events occur, such as critical, warning, and missing data. +description: Learn how Sumo Logic monitors continuously query your logs or metrics and sends notifications when specific events occur, such as critical, warning, and missing data. +keywords: + - monitors + - log-monitoring + - metric-monitoring + - alert-notification + - threshold-alert + - anomaly-detection + - missing-dataalert + - monitor-limits +head: + - tagName: script + attributes: + type: application/ld+json + innerHTML: | + { + "@context": "https://schema.org", + "@type": "FAQPage", + "mainEntity": [ + { + "@type": "Question", + "name": "What is a Sumo Logic monitor?", + "acceptedAnswer": { + "@type": "Answer", + "text": "A Sumo Logic monitor continuously queries logs or metrics data and sends a notification when a defined condition is met — such as an error count exceeding a threshold, a metric spiking above a baseline, or log data stopping entirely." + } + }, + { + "@type": "Question", + "name": "What is the difference between a monitor and a scheduled search in Sumo Logic?", + "acceptedAnswer": { + "@type": "Answer", + "text": "A monitor evaluates data continuously — from every few seconds to every few minutes — and fires in real time when a condition is breached. A scheduled search runs at a fixed interval such as hourly or daily and sends a report of results. Use monitors for real-time alerting and scheduled searches for periodic reporting." + } + }, + { + "@type": "Question", + "name": "How many monitors can a Sumo Logic account have?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Enterprise and Trial accounts can have up to 1,000 log monitors and 1,500 metric monitors. Essentials and Professional accounts can have up to 300 log monitors and 500 metric monitors. Free Trial accounts can have up to 50 of each." + } + }, + { + "@type": "Question", + "name": "What permissions are needed to create a Sumo Logic monitor?", + "acceptedAnswer": { + "@type": "Answer", + "text": "The Manage Monitors role capability is required to create or edit monitors. The View Monitors capability is required to view them. Permissions can also be set at the folder level." + } + }, + { + "@type": "Question", + "name": "When does a Sumo Logic monitor auto-resolve?", + "acceptedAnswer": { + "@type": "Answer", + "text": "A monitor resolves automatically when the recovery condition is met for the entire duration of the detection window. For example, if a monitor triggered at 1:00 PM with a 15-minute detection window, the earliest it can resolve is 1:15 PM. After one day without new data, the incident is automatically expired and marked resolved." + } + }, + { + "@type": "Question", + "name": "What are the limitations of Sumo Logic monitors?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Monitors do not support Receipt Time, LogReduce, LogCompare, Save to Index, Save to Lookup, or Search Templates. An aggregate metric monitor can evaluate up to 15,000 time series and a non-aggregate metric monitor up to 3,000. A log monitor query can be up to 15,000 characters. Email notifications support up to 100 recipients." + } + }, + { + "@type": "Question", + "name": "What happens when a monitor is muted in Sumo Logic?", + "acceptedAnswer": { + "@type": "Answer", + "text": "A muted monitor continues to evaluate data and generate alerts, but notifications are suppressed for the duration of the mute. Use muting schedules to silence notifications during planned maintenance without disabling the monitor." + } + } + ] + } --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import useBaseUrl from '@docusaurus/useBaseUrl'; -Monitors track your metrics and logs data in real time and send notifications when noteworthy changes happen in your production applications. +A Sumo Logic monitor continuously queries logs or metrics and send notifications when noteworthy changes happen in your production applications. :::note -Learn how [monitors differ from Scheduled Searches](/docs/alerts/difference-from-scheduled-searches). +To understand when to use a monitor versus a scheduled search, refer to [Monitors vs. Scheduled Searches](/docs/alerts/difference-from-scheduled-searches/). ::: -## Prerequisites +## What permissions are required to use monitors? -To manage and/or view monitors, you'll need the **Manage** and **View Monitors** [role capabilities](/docs/manage/users-roles/roles/role-capabilities). [Learn more](/docs/alerts/monitors/settings/#monitor-folder-permissions) about controlling permissions at the monitor or folder level. +The **Manage Monitors** role capability is required to create, edit, or delete monitors. The **View Monitors** capability is required to view them. [Learn more](/docs/alerts/monitors/settings/#monitor-folder-permissions) about controlling permissions at the monitor or folder level. -## Rules +## How often does a monitor evaluate data? -The frequency at which a monitor executes depends on various factors, such as the underlying query, the operators used, and the detection window. This frequency can range from a few seconds to several minutes. +Evaluation frequency depends on the underlying query, the operators used, and the detection window. This frequency can range from a few seconds to several minutes. -For example, if the detection window of your alert is 24 hours, it will be evaluated every few minutes. Conversely, if the detection window of the monitor is 15 minutes, it will be evaluated every few seconds. +The shorter the detection window, the more frequently the monitor runs: -See [Trigger Type (Logs)](/docs/alerts/monitors/create-monitor/#trigger-type-logs) and [Trigger Type (Metrics)](/docs/alerts/monitors/create-monitor/#trigger-type-metrics) for more information. +- A **15-minute** detection window evaluates every few seconds. +- A **24-hour** detection window evaluates every few minutes. -### Log monitors +See [Trigger Type (Logs)](/docs/alerts/monitors/create-monitor/#trigger-type-logs) and [Trigger Type (Metrics)](/docs/alerts/monitors/create-monitor/#trigger-type-metrics) for the full evaluation schedule by window size. + +## What are the rules specific to log monitors? * Log monitors use the [role search filter](/docs/manage/users-roles/roles/construct-search-filter-for-role) of their creator. * Log monitors delay execution by two minutes. This means it won't evaluate data from the current time, but evaluate data from two minutes ago. This ensures that any delays in ingestion are factored in and won't generate false positive or false negative alerts. @@ -35,7 +114,7 @@ See [Trigger Type (Logs)](/docs/alerts/monitors/create-monitor/#trigger-type-log * Essentials and Professional plan customers can have up to 300 log monitors. * Free Trial customers can have up to 50 log monitors. -#### Auto-resolving notifications +### How do log monitors auto-resolve? Log monitors in a triggered state can auto-resolve. @@ -44,25 +123,25 @@ Log monitors in a triggered state can auto-resolve. - Non-grouped monitors will trigger again after auto-resolving if there is still no data. - Grouped monitors will be removed and no longer considered after being auto-resolved, unless data for this group is seen again. -### Metrics monitors +## What are the rules specific to metric monitors? * Metrics monitors delay execution by one minute. * Enterprise and Trial plan customers can have up to 1,500 Metrics monitors. * Essentials and Professional plan customers can have up to 500 Metrics monitors. * Free Trial customers can have up to 50 Metrics monitors. -## Notifications +## How do monitor notifications work? -Notifications are optional and available as an **alert** and **recovery** for each trigger condition you specify, **critical**, **warning**, and **missing**. +Notifications are optional and available for both **alert** and **recovery** states for each trigger condition you specify, **critical**, **warning**, and **missing**. -### Alerts +### How do alerts behave when multiple trigger types fire? * Monitor evaluation for each trigger type (Critical, Warning or Missing Data) happens independently. Each trigger type's lifecycle is managed separately and doesn't have any impact on other trigger types. So it is possible for a monitor to be in Critical and Warning state at the same time. Monitor goes back to normal when it is not in either of Critical, Warning and Missing Data states. * When both Critical and Warning conditions are met, two separate alerts and notifications are generated - one for the Critical condition and one for the Warning condition. Auto-resolution, if set up, will work according to the resolution condition for each case.  * Metric monitors have the option to group notifications. When configured, the Monitor will not trigger new notifications until the first one is resolved. The Monitor will only update if the notification type supports auto-resolution. Grouped notifications will resolve when all the time series return to normal. * Log monitors always group notifications. -### Recovery +### How does alert recovery and auto-resolution work? * Recovery is based on the detection window, which is either the time range or the number of data points of the trigger condition. An alert is recovered (resolved) when the recovery condition is met for the entire duration of the detection window. * For example, if an alert is triggered at 1:00 PM and the detection window is 15 minutes, the earliest the alert would recover is after 1:15 PM since the entire detection window must pass. This is to ensure there isn't an alert between the triggered and resolved state, especially for metrics that are volatile. @@ -72,73 +151,92 @@ Notifications are optional and available as an **alert** and **recovery** for ea * The recovery notification is sent to the same channel where the corresponding Alert notifications were sent. In other words, you cannot have different channels where you receive alert and recovery notifications for a given trigger condition. * After one day without new data to an incident, the system automatically expires it. The incident is marked as resolved with the resolution set to **Expired**. -## Tools +## What are the monitor status values? + +| Status | Meaning | +|:--|:--| +| **Normal** | No trigger conditions are met; data is actively monitored. | +| **Critical** | The critical threshold condition is met. | +| **Warning** | The warning threshold condition is met. | +| **Missing Data** | No data was returned within the detection window. | + +A monitor returns to Normal when none of the Critical, Warning, or Missing Data conditions are met. + +## Where can monitors be managed programmatically? -* [Monitor resource in Terraform](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/monitor)  -* [Monitor Management API](/docs/api/monitors-management) +- **Terraform**. Use the [`sumologic_monitor`](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/monitor) and [`sumologic_monitor_folder`](https://registry.terraform.io/providers/SumoLogic/sumologic/latest/docs/resources/monitor_folder) resources. +- **API**. Use the [Monitor Management API](/docs/api/monitors-management/). +## What does muting a monitor do? -## Terminology +Muting a monitor suppresses notifications for the duration of the mute schedule, but the monitor continues to evaluate data and generate alerts internally. Use +[Muting Schedules](/docs/alerts/monitors/muting-schedules/) to silence notifications during planned maintenance windows without disabling the monitor entirely. -Here are the technical terms used in monitors. +## What are the key terms used in monitors? -### Detection method -This can be _Static_, _Dynamic_, _Anomaly_, or _Outlier_. +| Term | Definition | +|:--|:--| +| **Detection method** | _Static_, _Dynamic_, _Anomaly_, or _Outlier_ defines how the monitor identifies a trigger condition. | +| **Disable** | The monitor is in a disabled state when monitors are not processed by the backend, only their definition is persisted in the database. | +| **Incident** | Created when a trigger condition is met. | +| **Monitor** | A _Monitor_ creates an _Alert_. Using the options below, you're subscribing to an _Alert's Monitor_.
The monitor is the object that you configure within Sumo Logic that: | +| **Monitor type** | The underlying data stream, either logs or metrics, on which the monitor is created. | +| **Mute** | When a monitor is in a mute state, it continues to process your data stream as expected where alerts are still generated. However, notifications are suppressed based on your mute condition. See also: [Muting Schedules](/docs/alerts/monitors/muting-schedules). | +| **Resolve** | The process of closing an incident. | +| **Status** | The state of the monitor can be one of the following: Normal, Critical, Warning, or Missing Data.| +| **Template** | The section that describes the actual connection attributes. | +| **Threshold** | The static condition which when met an incident is triggered by a monitor. | +| **Trigger (state)** | The state when an alert condition has been met, and an incident has been created as a result. | +| **Trigger type** | Type of alert/trigger condition defined Critical/Warning/Missing Data. | +| **Alert variables** | Custom variables used inside the Action Payload. | -### Disable -The monitor is in a disabled state when monitors are not processed by the backend, only their definition is persisted in the database. +## What are the limitations of monitors? -### Incident -When a specific alerting condition is met, as defined on the monitor, an incident is triggered. +The following features and operators are **not supported** in monitors: -### Monitor +- [Receipt Time](/docs/search/get-started-with-search/build-search/use-receipt-time/) +- [LogReduce](/docs/search/behavior-insights/logreduce/logreduce-operator/) and [LogCompare](/docs/search/behavior-insights/logcompare/) +- [Save to Index](/docs/alerts/scheduled-searches/save-to-index/) and [Save to Lookup](/docs/alerts/scheduled-searches/save-to-lookup/) +- [Search templates](/docs/search/get-started-with-search/build-search/search-templates/) +- [`timeshift` metrics operator](/docs/metrics/metrics-operators/timeshift/) +- [Hidden Metrics queries](/docs/metrics/metrics-queries/metrics-explorer/) are not persist across edit sessions. +- **Numeric limits:** + | Limit | Value | + |:--|:--| + | Log monitor query length | 15,000 characters | + | Metric monitor queries | Up to 6 per monitor | + | Aggregate metric monitor time series | 15,000 | + | Non-aggregate metric monitor time series | 3,000 | + | Email notification recipients | 100 | + | Time range precision | Last millisecond excluded, a range of 6:15 to 6:30 PM runs as 6:15:00.000–6:29:59.999 | +- Monitors only support the [Continuous data tier](/docs/manage/partitions/data-tiers/). -A _Monitor_ creates an _Alert_. Using the options below, you're subscribing to an _Alert's Monitor_. +## FAQs -The monitor is the object that you configure within Sumo Logic that: - * Checks for specific events of interest against a data source, based on your specified conditions. Events of interest are used in a general sense to denote an event that may be of interest to you. - * Notifies you about the event-of-interest based on your preferences. +### What is a Sumo Logic monitor? -### Monitor type -The underlying data stream, either logs or metrics, on which the monitor is created. +A monitor continuously queries logs or metrics data and sends a notification when a defined condition is met, such as an error count exceeding a threshold, a metric spiking above a baseline, or log data stopping entirely. -### Mute -When a monitor is in a mute state, it continues to process your data stream as expected where alerts are still generated. However, notifications are suppressed based on your mute condition. See also: [Muting Schedules](/docs/alerts/monitors/muting-schedules). +### What is the difference between a monitor and a scheduled search? -### Resolve -The process of closing an incident. +A monitor evaluates data continuously every few seconds to every few minutes and fires in real time when a condition is breached. A scheduled search runs at a fixed interval such as hourly or daily and sends a report of results. Use monitors for real-time alerting and scheduled searches for periodic reporting. -### Status -The state of the monitor can be one of the following: Normal, Critical, Warning, or Missing Data. +### How many monitors can a Sumo Logic account have? -### Template -The section that describes the actual connection attributes. +Enterprise and Trial accounts support up to 1,000 log monitors and 1,500 metric monitors. Essentials and Professional accounts support up to 300 log monitors and 500 metric monitors. Free Trial accounts support up to 50 of each type. -### Threshold -The static condition which when met an incident is triggered by a monitor. +### What permissions are needed to create a monitor? -### Trigger (state) -The state when an alert condition has been met, and an incident has been created as a result. +The **Manage Monitors** role capability is required to create or edit monitors. The **View Monitors** capability is required to view them. Permissions can also be set at the folder level. -### Trigger type -Type of alert/trigger condition defined Critical/Warning/Missing Data. +### When does a Sumo Logic monitor auto-resolve? -### Alert variables -Custom variables used inside the Action Payload. +A monitor resolves automatically when the recovery condition is met for the entire duration of the detection window. For example, a monitor that triggered at 1:00 PM with a 15-minute window can resolve no earlier than 1:15 PM. Incidents without new data for 24 hours are automatically expired and marked resolved. +### What are the limitations of Sumo Logic monitors? -## Limitations +Monitors do not support Receipt Time, LogReduce, LogCompare, Save to Index, Save to Lookup, or Search Templates. An aggregate metric monitor evaluates up to 15,000 time series; a non-aggregate metric monitor evaluates up to 3,000. Log monitor queries are limited to 15,000 characters. Email notifications support up to 100 recipients. -### General +### What happens when a monitor is muted? -* [Receipt Time](../../search/get-started-with-search/build-search/use-receipt-time.md) is not supported. -* [LogReduce](/docs/search/behavior-insights/logreduce/logreduce-operator) / [LogCompare](/docs/search/behavior-insights/logcompare) operators are not supported in monitors. If your query contains these operators, you will not be able to create the monitor. -* Monitors only support the [Continuous data tier](/docs/manage/partitions/data-tiers). -* An aggregate Metric Monitor can evaluate up to 15,000 time series. A non-aggregate Metric Monitor can evaluate up to 3,000 time series. -* [Save to Index](../scheduled-searches/save-to-index.md) and [Save to Lookup](../scheduled-searches/save-to-lookup.md) are not supported. -* [Search templates](../../search/get-started-with-search/build-search/search-templates.md) are not supported. -* A Log Monitor can have one query up to 15,000 characters long. Metric monitors can specify up to six queries. -* Email notifications can have up to 100 recipients. -* The [`timeshift metrics` operator](/docs/metrics/metrics-operators/timeshift) is not supported in a Metric Monitor. -* [Hidden Metrics queries](../../metrics/metrics-queries/metrics-explorer.md) do not persist across edit sessions. -* The last millisecond of the defined time range is not searched. For example, a time range of 6:15 to 6.30 pm will run as 6:15:00:000 to 6:29:59:999. +A muted monitor continues to evaluate data and generate alerts internally, but notifications are suppressed for the duration of the mute. Use muting schedules to silence notifications during planned maintenance without disabling the monitor. \ No newline at end of file diff --git a/docs/dashboards/about.md b/docs/dashboards/about.md index b76df17f3c..02ee595121 100644 --- a/docs/dashboards/about.md +++ b/docs/dashboards/about.md @@ -1,25 +1,110 @@ --- id: about -title: About Dashboard +title: Dashboards Overview sidebar_label: About Dashboard -description: Learn the benefits of Dashboard and how it seamlessly integrates log, metric, and trace data. +description: Sumo Logic dashboards let you visualise log and metric data together in real time with template variable filters, auto-refresh, dark mode, drill-down, and scheduled email reports. +keywords: + - dashboards + - log-dashboard + - metric-dashboard + - real-time-dashboard + - template-variables + - dashboard-auto-refresh + - dashboard-dark-mode + - operational-dashboard + - build-a-dashboard +head: + - tagName: script + attributes: + type: application/ld+json + innerHTML: | + { + "@context": "https://schema.org", + "@type": "FAQPage", + "mainEntity": [ + { + "@type": "Question", + "name": "What is a Sumo Logic dashboard?", + "acceptedAnswer": { + "@type": "Answer", + "text": "A Sumo Logic dashboard is a real-time visualisation surface that displays log and metric data together in a single view. Panels support charts, tables, maps, and single-value displays. Dashboards can be filtered with template variables, set to auto-refresh, shared with teammates, and exported as PDF, PNG, or JSON." + } + }, + { + "@type": "Question", + "name": "How to build a real-time operational dashboard from logs in Sumo Logic?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Create a new dashboard, add log or metric panels directly from the dashboard editor, write queries for each panel, set a time range and optional auto-refresh interval, and use template variables to make filters dynamic. See the Create a Dashboard page for step-by-step instructions." + } + }, + { + "@type": "Question", + "name": "Can Sumo Logic dashboards display logs and metrics together?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Yes. Sumo Logic dashboards support both log and metric queries in the same panel and across panels on the same dashboard, giving a unified view of application and infrastructure data." + } + }, + { + "@type": "Question", + "name": "How to share a Sumo Logic dashboard?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Use the Share option in the dashboard menu to share with teammates inside the organisation, preserving template variables and time range. Dashboards can also be shared publicly outside the organisation using a public URL." + } + }, + { + "@type": "Question", + "name": "How to set up auto-refresh on a Sumo Logic dashboard?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Click the dropdown arrow next to the refresh icon on the dashboard and select a refresh interval. Auto-refresh applies to the entire dashboard and cannot be set per panel. If the requested interval is not achievable due to query complexity or time range, an error message indicates the actual refresh rate." + } + }, + { + "@type": "Question", + "name": "How to send a Sumo Logic dashboard as a scheduled email report?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Use the Scheduled Report feature to send a dashboard snapshot by email on a defined schedule. See the Scheduled Report page for setup steps." + } + }, + { + "@type": "Question", + "name": "What are the limitations of Sumo Logic dashboards?", + "acceptedAnswer": { + "@type": "Answer", + "text": "A dashboard can have up to 100 queries. Each panel supports up to 6 log queries and 6 metric queries. Dashboard queries cannot return more than 1,440 data points. Joining log queries across panels is not supported. The operators Details, LogReduce, LogCompare, Save, and Transaction cannot be used in dashboard panels." + } + } + ] + } --- import useBaseUrl from '@docusaurus/useBaseUrl'; Dashboards icon -Dashboard allows you to analyze metric and log data on the same dashboard, in a streamlined user experience. This is exactly what you need to effectively monitor and manage a Kubernetes environment. +A Sumo Logic dashboard displays log and metric data together in a single real-time view. Panels support a range of chart types, template variable filters make dashboards dynamic, and auto-refresh keeps data current without manual reloads. This is exactly what you need to effectively monitor and manage a Kubernetes environment. Dashboards are a critical tool for monitoring and troubleshooting modern applications, allowing you to quickly navigate through your data without having to learn a query language. Graphs and data mappings provide visual representations of data that enable you to quickly identify and resolve key issues. -## What's great about Dashboard  +## What can Sumo Logic dashboards display? -Dashboard provides the unique ability to display metrics metadata and logs data on the same dashboard in an integrated seamless view. This gives you control over the visual display of metric data as well as log data. Dashboard streamlines dashboard configuration and on-the-fly analytic visualizations with its new templating features.  +Dashboards support both log and metric queries in the same panel and across panels on the same dashboard. This gives a unified view of application logs and infrastructure metrics without switching between tools. -[Template variables](filter-template-variables.md) allow you to filter dashboard data dynamically to generate new visualizations for intuitive chart creation and data scoping. +Supported panel types include: Area, Bar, Box Plot, Bubble, Cluster Map, Column, Combo, Connection Map, Funnel, Geo Heat Map, Heat Map, Honeycomb, Line, Pie, Sankey Diagram, Scatter, Single Value, Table, and Text panels. -### Features +See [Panels](/docs/dashboards/panels/) for details on each chart type. + +## How do template variables work in dashboards? + +[Template variables](/docs/dashboards/filter-template-variables/) let you filter dashboard data dynamically without editing individual panel queries. A variable can be applied across both log and metric panels simultaneously, and the dashboard updates all panels when the variable value changes. + +Template variables support full replacement control over inserted values and work across log and metric panels. + +## What features does Sumo Logic Dashboard support? :::tip See [Migrate to Dashboards](/docs/dashboards/dashboards-migration). @@ -55,30 +140,37 @@ The following table shows the availability of features for Dashboard. | Locate Deviations in a Time Series |[Supported](/docs/dashboards/locate-deviations-time-series/) | | Longer Time Range Queries | [Supported](/docs/dashboards/set-custom-time-ranges/) | -## Restricted Operators in Dashboard +## What operators cannot be used in dashboard panels? -The following operators cannot be used with Dashboard: +The following operators are not supported in dashboard panels: -* Details -* LogReduce -* LogCompare -* Save -* Transaction +- `Details` +- `LogReduce` +- `LogCompare` +- `Save` +- `Transaction` :::note -Live mode restrictions do not apply to Dashboard.  +Live mode restrictions do not apply to dashboards. ::: -## Limitations +See [Restricted Operators in Dashboards](/docs/dashboards/restricted-operators-dashboards/) for full details. + +## What are the limits for Sumo Logic dashboards? + +| Limit | Value | +|:--|:--| +| Queries per dashboard | 100 | +| Log queries per panel | 6 | +| Metric queries per panel | 6 | +| Data points per query | 1,440 | +| Joining log queries across panels | Not supported | + +Chart properties set in a panel are not retained when the chart is viewed from the Search page, and are not retained when a chart is added to a dashboard from the Search page. -* A panel can have up to 6 logs and 6 metrics queries. -* Joining log queries in a separate query is not supported. See how to [join metric queries](/docs/metrics/metrics-queries/metrics-explorer) for details on how this works. -* A Dashboard can have up to 100 queries. -* Dashboard chart properties are not retained when viewed from the Search page. -* Chart properties are not retained when a chart is added to a Dashboard from the Search page. -* Dashboard queries cannot return more than 1440 data points. +## How does auto-refresh work? -## Rules +Dashboards can automatically refresh all panels at a configured interval. To set the interval, click the dropdown arrow next to the refresh icon and select a rate.
auto refresh dropdown options
dashboard new refresh interval options * Auto Refresh applies to the whole dashboard, you cannot configure it by panel. * If there are two or more queries in a panel, the refresh interval for the panel is set to the maximum supported interval. @@ -87,24 +179,19 @@ Live mode restrictions do not apply to Dashboard.  * An operator is not supported at this refresh interval. * The number of grouped elements is too large for the requested interval. -## Auto Refresh +See [Restricted Operators in Dashboards](/docs/dashboards/restricted-operators-dashboards/) for a full list of operators that affect refresh behaviour. -Your dashboard can automatically refresh its panels to the latest information. You have the ability to configure the refresh interval rate by clicking the dropdown arrow next to the refresh icon. - -There are some restrictions when using operators with dashboards. To learn more, see [Restricted Operators in Dashboards](/docs/dashboards/restricted-operators-dashboards).
auto refresh dropdown options -
A list of the refresh interval rates is provided for you to select from.
dashboard new refresh interval options - -## Dark Theme +## How to switch to dark mode? Dashboards have two themes available: Light mode (which is the default) and Dark mode. You can toggle between the two themes within the dashboard by clicking the three-dot kebab icon. The following image shows the option to **Switch to Dark Theme**.
dark theme switch -## Clickable Legend +## How does the clickable legend work? If you want to focus on one item in your chart you can simply click on the item in the legend. If you want to toggle just one legend item, just hold the **shift** key and then click the item.
clicklegend -## Dashboard Information +## How do I view dashboard scan cost information? -The dashboard information popup provides insights into the scan costs associated with log-based queries that run within dashboards. +The dashboard information dialog shows insights into the scan costs associated with log-based queries that run within dashboards. To view the dashboard information, follow the steps below: 1. Open the dashboard for which you need to view the information. @@ -117,4 +204,35 @@ To view the dashboard information, follow the steps below: - **End**. The current end time based on the selected time range. - **Time Zone**. The time zone for the set time range. - **Scanned Bytes**. The total amount of data scanned in bytes. - - **Dashboard ID**. A unique identification ID for the dashboard. Copy and use the dashboard ID within the APIs to identify the dashboard when making requests. \ No newline at end of file + - **Dashboard ID**. A unique identification ID for the dashboard. Copy and use the dashboard ID within the APIs to identify the dashboard when making requests. + + +## FAQs + +### What is a Sumo Logic dashboard? + +A Sumo Logic dashboard is a real-time visualisation surface that displays log and metric data together in a single view. Panels support charts, tables, maps, and single-value displays. Dashboards can be filtered with template variables, set to auto-refresh, shared with teammates, and exported as PDF, PNG, or JSON. + +### How to build a real-time operational dashboard from logs? + +Create a new dashboard, add log or metric panels directly from the dashboard editor, write queries for each panel, set a time range and optional auto-refresh interval, and use template variables to make filters dynamic. See [Create a Dashboard](/docs/dashboards/create-dashboard-new/) for step-by-step instructions. + +### Can Sumo Logic dashboards display logs and metrics together? + +Yes. Both log and metric queries are supported in the same panel and across panels on the same dashboard, giving a unified view of application and infrastructure data. + +### How to share a Sumo Logic dashboard? + +Use the **Share** option in the dashboard menu to share with teammates inside the organisation, preserving template variables and time range. Dashboards can also be shared publicly outside the organisation. See [Share a Dashboard](/docs/dashboards/share-dashboard-new/) and [Share a Dashboard Outside Your Organisation](/docs/dashboards/share-dashboard-outside-org/). + +### How to set up auto-refresh on a dashboard? + +Click the dropdown arrow next to the refresh icon and select an interval. Auto-refresh applies to the entire dashboard. If the requested interval is not achievable, an error message explains the reason — usually a time range that is too long or an unsupported operator. + +### How to send a dashboard as a scheduled email report? + +Use the [Scheduled Report](/docs/dashboards/scheduled-report/) feature to send a dashboard snapshot by email on a defined schedule. + +### What are the limitations of Sumo Logic dashboards? + +A dashboard supports up to 100 queries total. Each panel supports up to 6 log and 6 metric queries. Queries cannot return more than 1,440 data points. Joining log queries across panels is not supported. The operators Details, LogReduce, LogCompare, Save, and Transaction cannot be used in dashboard panels. \ No newline at end of file diff --git a/docs/manage/field-extractions/create-field-extraction-rule.md b/docs/manage/field-extractions/create-field-extraction-rule.md index 0006c598af..7aafb78fd4 100644 --- a/docs/manage/field-extractions/create-field-extraction-rule.md +++ b/docs/manage/field-extractions/create-field-extraction-rule.md @@ -1,16 +1,99 @@ --- id: create-field-extraction-rule -title: Create a Field Extraction Rule -description: Field Extraction Rules (FER) tell Sumo Logic which fields to parse out automatically. +title: How to Create a Field Extraction Rule in Sumo Logic +sidebar_label: Create a Field Extraction Rule +description: Create a Field Extraction Rule (FER) in Sumo Logic to automatically parse fields from log messages at ingest time making fields available for searches, alerts, and dashboards without query-level parsing. +keywords: + - Sumo Logic + - create field extraction rule + - FER + - parse log fields at ingest + - extract fields from logs + - automatic log parsing + - ingest time field extraction + - run time field extraction + - parse regex logs + - log field extraction rule +head: + - tagName: script + attributes: + type: application/ld+json + innerHTML: | + { + "@context": "https://schema.org", + "@type": "FAQPage", + "mainEntity": [ + { + "@type": "Question", + "name": "How to create a field extraction rule in Sumo Logic?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Go to Data Management > Logs > Field Extraction Rules, click + Add, select the rule type (Ingest Time or Run Time), define the scope to target the relevant log sources, write a parse expression to extract the fields, and click Save." + } + }, + { + "@type": "Question", + "name": "How to extract a value from a log message using regex in Sumo Logic?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Create an Ingest Time field extraction rule with a parse expression using the parse regex operator. For example: parse regex \"user=(?\\S+)\" extracts the user field from every matching log message at ingestion time, making it available in all searches and dashboards without repeating the regex in queries." + } + }, + { + "@type": "Question", + "name": "What is the difference between Ingest Time and Run Time field extraction in Sumo Logic?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Ingest Time rules parse any log format using manually written expressions and apply to data ingested after the rule is created, providing better search performance. Run Time rules parse JSON data automatically during a search using Dynamic Parsing and have no rule limit. Run Time rules are more flexible but add overhead at query time." + } + }, + { + "@type": "Question", + "name": "What operators can be used in a field extraction rule parse expression?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Ingest Time field extraction rules support the following operators in the parse expression: parse regex, parse anchor, parse nodrop, csv, fields, json, keyvalue, and num. The multi and auto options are not supported." + } + }, + { + "@type": "Question", + "name": "How to parse multiple fields from a log message in a single field extraction rule?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Use a single parse expression with multiple named capture groups or wildcards. For example: parse \"[hostId=*] [module=*] [localUserName=*]\" as hostId, module, localUserName extracts three fields from each matching log message in one rule." + } + }, + { + "@type": "Question", + "name": "What are the best practices for designing field extraction rules?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Lock down the scope as tightly as possible to target only the logs that need parsing. Create multiple specific rules rather than one complex rule. Extract only the fields that are actually needed. Test the scope as a search before saving the rule. Avoid using the same field name in multiple rules that target the same messages." + } + }, + { + "@type": "Question", + "name": "Can field extraction rules be managed with Terraform?", + "acceptedAnswer": { + "@type": "Answer", + "text": "Yes. Use the sumologic_field_extraction_rule resource in the Sumo Logic Terraform provider to create and manage field extraction rules as code." + } + } + ] + } --- import useBaseUrl from '@docusaurus/useBaseUrl'; import Iframe from 'react-iframe'; import FerLimit from '../../reuse/fer-limitations.md'; +A Field Extraction Rule (FER) automatically parses fields from log messages at ingestion time, making those fields available in searches, alerts, scheduled searches, and dashboards without writing parse expressions in every query. + You can create a field extraction rule of your own from scratch by following the instructions below. We also provide [data-source-specific templates](/docs/manage/field-extractions/fer-templates/index.md) for AWS, Apache, and more. -You need the **Manage field extraction rules** [role capability](../users-roles/roles/role-capabilities.md) to create a field extraction rule. +:::info +The **Manage field extraction rules** [role capability](/docs/manage/users-roles/roles/role-capabilities/) is required to create a field extraction rule. +::: :::note Fields specified in field extraction rules are automatically added and enabled in your [Fields](/docs/manage/fields) table schema. @@ -25,9 +108,6 @@ You can use Terraform to provide a field extraction rule with the [`sumologic_fi ::: :::training Micro Lesson - -Learn how to create a FER through our video, "Creating a Field Extraction Rule". -