Skip to content
Draft
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
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: Disabled Metrics Sources
description: Sumo Logic sometimes disables metrics Sources in response to excessive volume of time series.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

In some cases, Sumo Logic disables a metrics source or drops a metric dimension to limit the number of ingested time series. 

This page has information about the process and how to resolve the problem.
Expand Down Expand Up @@ -100,8 +102,7 @@ For other dimensions that exceed the cardinality limit, Sumo generates a metric
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). To access **Metrics Transformation Rules**, go to the main Sumo Logic menu and select **Manage Data > Metrics > Metrics Transformation Rules**.

You can delete the metric transformation rule, but you can’t disable or modify it. 

![transformation-rules.png](/img/metrics/transformation-rules.png)
<img src={useBaseUrl('img/metrics/transformation-rules.png')} alt="Transformation-rules" style={{border: '1px solid gray'}} width="800" />

:::note
If you have a use case that requires the dropped dimension, contact Sumo Logic support.
Expand Down
3 changes: 2 additions & 1 deletion docs/metrics/metrics-operators/accum.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: accum Metrics Operator
sidebar_label: accum
---

import useBaseUrl from '@docusaurus/useBaseUrl';

The `accum` operator creates a series of running totals for each metric time series. The running total in each series starts from the value of the first data point in the series, then iteratively adds up successive
values.
Expand Down Expand Up @@ -31,5 +32,5 @@ In the metric chart below, the green time series is the result of using

The orange time series shows the results without the `accum` operator.

![accum.png](/img/metrics/accum.png)
<img src={useBaseUrl('img/metrics/accum.png')} alt="accum operator" style={{border: '1px solid gray'}} width="800" />

5 changes: 3 additions & 2 deletions docs/metrics/metrics-operators/avg.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: avg Metrics Operator
sidebar_label: avg
---

import useBaseUrl from '@docusaurus/useBaseUrl';

The `avg` operator calculates the average of all matching time series. If grouping is specified, it calculates the average for each group.

Expand All @@ -22,8 +23,8 @@ This query returns the average value of the `RequestCount` metric across matchin
```sql
Namespace=AWS/ApplicationELB metric=RequestCount Statistic=Sum AvailabilityZone=* Region=* TargetGroup=* | avg 
```
 
![avg1.png](/img/metrics/avg1.png)

<img src={useBaseUrl('img/metrics/avg1.png')} alt="avg operator" style={{border: '1px solid gray'}} width="800" />

### Average by one field

Expand Down
3 changes: 2 additions & 1 deletion docs/metrics/metrics-operators/count.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: count Metrics Operator
sidebar_label: count
---

import useBaseUrl from '@docusaurus/useBaseUrl';

Counts the total number of time series that match the query. If grouping is specified, it counts the total number for each group.

Expand Down Expand Up @@ -41,4 +42,4 @@ metric=4XXError | count by method

In this query, we're searching for how many 4xx errors occurred by different methods, for example, GET, PUT, DELETE, and so on.

![count-example.png](/img/metrics/count-example.png)
<img src={useBaseUrl('img/metrics/count-example.png')} alt="count example" style={{border: '1px solid gray'}} width="800" />
4 changes: 3 additions & 1 deletion docs/metrics/metrics-operators/outlier.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: outlier Metrics Operator
sidebar_label: outlier
---

import useBaseUrl from '@docusaurus/useBaseUrl';

The metrics `outlier` operator identifies metrics data points that are outside the range of expected values. Outliers help you spot unusual behavior in your metrics visualizations and track the behavior over time.

`outlier` tracks the moving average and standard deviation of a time series over a specified time window, and calculates a threshold band, outside of which data points are considered outliers. You can use optional qualifiers to specify the time window, the number of standard deviations beyond which a data point is considered an outlier, and the directionality of the deviation.
Expand All @@ -24,6 +26,6 @@ Where:
* `threshold` is the number of standard deviations from the moving average that defines the threshold band. Default: 3
* `direction` specifies what deviation direction should trigger violations: positive deviations (`+`), negative deviations (`-`), or both (`+-`). Default: `+-`.

![outlier-operator.png](/img/metrics/outlier-operator.png)
<img src={useBaseUrl('img/metrics/outlier-operator.png')} alt="outlier operator" style={{border: '1px solid gray'}} width="800" />

In the visualization, the threshold band is the part shaded in pink. The outlier values are represented by the pink triangles.
6 changes: 4 additions & 2 deletions docs/metrics/metrics-queries/metric-query-autocomplete.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: Metric Query Autocomplete
description: The Metrics Search provides an autocomplete dropdown dialog that offers suggestions to make query writing easier.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

The [Metrics Search](/docs/metrics/metrics-queries/metrics-explorer) provides an autocomplete dropdown dialog that offers suggestions to make query writing easier. Autocomplete is supported in both Basic and Advanced mode.

## Basic Mode autocomplete
Expand All @@ -16,7 +18,7 @@ three fields for building a query.
* **Filter** — When you click the field, a list of Sumo Logic metadata fields, metric dimensions, and metatags is displayed. As you start to enter text, the items that match your entry appear.
* **Add Operator** — When you click the field a list of operators is displayed. After you select an operator, you’re prompted to supply the appropriate options for that operator. 

![basic-autocomplete.png](/img/metrics/basic-autocomplete.png)
<img src={useBaseUrl('img/metrics/basic-autocomplete.png')} alt="Basic autocomplete" style={{border: '1px solid gray'}} width="800" />

## Advanced Mode autocomplete

Expand All @@ -26,7 +28,7 @@ When you click in the query area, metric query autocomplete presents a list of S

If you enter a partial value in the query area, autocomplete presents only those items that match the value.  

![advanced-autocomplete.png](/img/metrics/advanced-autocomplete.png)
<img src={useBaseUrl('img/metrics/advanced-autocomplete.png')} alt="Advanced autocomplete" style={{border: '1px solid gray'}} width="800" />

## About autocomplete retention

Expand Down
10 changes: 5 additions & 5 deletions docs/metrics/metrics-queries/metrics-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ If the query editor mode cannot be adjusted, it is changed to advanced mode so t

1. Scroll through the list, or begin typing to dynamically narrow the list. Click the desired value. The **Filter** field now contains the key-value pair you selected. You can click a filter setting to edit it. You can preface a filter value with and exclamation point (!) to NOT the value.
1. As desired, repeat the previous steps to add additional filters to the query. 
1. When you are ready to run your query, click the run button: ![run-button.png](/img/metrics/run-button.png)
1. When you are ready to run your query, click the run button: <img src={useBaseUrl('img/metrics/run-button.png')} alt="Run button" style={{border: '1px solid gray'}} width="50" />
1. The metrics returned by your query appear in the **Time Series Table**.

<img src={useBaseUrl('img/metrics/results-in-table.png')} alt="Metrics search results in time series table" style={{border: '1px solid gray'}} width="800" />
Expand Down Expand Up @@ -129,7 +129,7 @@ You can perform basic math operations (+, -, \*, /) on two or more metrics queri

To join the queries, add a third query row, and then switch to advanced mode by choosing **Advanced Mode** from the three-dot kebab menu in that row.

![advanced.png](/img/metrics/advanced.png)
<img src={useBaseUrl('img/metrics/advanced.png')} alt="Advanced" style={{border: '1px solid gray'}} width="100" />

In Advanced mode, enter:

Expand All @@ -144,12 +144,12 @@ It returns the difference between the incoming rate and the outgoing rate. In th
You can hide a query so that it is not visualized in the chart.

1. Click the eye icon to the right of the query builder area in the row that contains the query you want to hide.
1. The visualization for the query is hidden. The query label for a hidden query is faded out.<br/>![eye-icon.png](/img/metrics/eye-icon.png)
1. The visualization for the query is hidden. The query label for a hidden query is faded out.<br/><img src={useBaseUrl('img/metrics/eye-icon.png')} alt="Eye icon" style={{border: '1px solid gray'}} width="100" />
1. To make the query visible, click the eye icon again.

## Add a monitor to a metric query

1. Select **Add Monitor** from the more options menu.<br/>![add-monitor.png](/img/metrics/add-monitor.png)
1. Select **Add Monitor** from the more options menu.<br/><img src={useBaseUrl('img/metrics/add-monitor.png')} alt="Add monitor" style={{border: '1px solid gray'}} width="150" />
1. Follow the instructions to add a Monitor.

## Convert query mode
Expand All @@ -164,7 +164,7 @@ between Basic and Advanced anytime.

## Duplicate a metric query

1. Select **Duplicate Query** from the more options menu. <br/>![duplicate-query.png](/img/metrics/duplicate-query.png)
1. Select **Duplicate Query** from the more options menu. <br/><img src={useBaseUrl('img/metrics/duplicate-query.png')} alt="Duplicate query" style={{border: '1px solid gray'}} width="150" />
1. Your query will be copied to a new row in the query builder area.

## Tailoring charts
Expand Down
19 changes: 6 additions & 13 deletions docs/metrics/metrics-queries/share-metric-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: Share a Metric Query
description: Share a saved or unsaved metric query.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

There are two ways you can share a metric query with other Sumo users:

* You can share a saved metric query with one or more roles, users, or a combination of roles and individual users. When you share a saved metric query, you can set the sharing permission level to View, Edit, or Manage, and also apply advanced sharing options.
Expand All @@ -18,14 +20,8 @@ Logic Library. 
### Share a metric query from the query tab

1. If you have not already saved the query, save it by clicking the save icon. 
1. Click the sharing icon.

![sharing-icon.png](/img/metrics/sharing-icon.png)

1. The sharing popup appears.

![sharing-popup.png](/img/metrics/sharing-popup.png)

1. Click the sharing icon. <br/><img src={useBaseUrl('img/metrics/sharing-icon.png')} alt="Sharing icon" style={{border: '1px solid gray'}} width="800" />
1. The sharing popup appears. <br/><img src={useBaseUrl('img/metrics/sharing-popup.png')} alt="Sharing popup" style={{border: '1px solid gray'}} width="800" />
1. **Users and Roles**. Enter the user names and/or roles to receive access. For example, if you want all share the query with all users that have the Analyst role, enter Analyst.
1. **Access**. Choose the level of access to grant: **View**, **Edit**, or **Manage**.
1. **Advanced Access** (Optional).You can further refine access to the dashboard by setting a permission level. For details on these options, see [Available Permission Levels](#available-permission-levels).
Expand Down Expand Up @@ -62,14 +58,11 @@ After you run a metric query you can obtain a URL for the chart and send it to o
1. On the **Share Metrics Search** popup:
1. Select a time range option:
* Leave **Use absolute time range** checked to share the search with the current start and end time.
* Uncheck **Use absolute time range** to share the search with the currently selected relative search expression, "Last 60 minutes" in the example chart.

![share-metric-search.png](/img/metrics/share-metric-search.png)

* Uncheck **Use absolute time range** to share the search with the currently selected relative search expression, "Last 60 minutes" in the example chart.<br/><img src={useBaseUrl('img/metrics/share-metric-search.png')} alt="Share metric search" style={{border: '1px solid gray'}} width="600" />
1. Click **Copy** to copy the URL. 
1. Send the the URL to the users with whom you want to share the metric
chart.

When a user opens the URL in a browser, Sumo will prompt the user to log on. If you shared the chart with **Use** **absolute time range** selected, the chart will show data for the actual time range shown when you shared the cart, as shown below. Otherwise, the shared chart will show a relative search expression. In our example query, that would be "Last 60 minutes".

![as-shared-absolute.png](/img/metrics/as-shared-absolute.png)
<img src={useBaseUrl('img/metrics/as-shared-absolute.png')} alt="As shared absolute" style={{border: '1px solid gray'}} width="<insert-pixel-number>" />
4 changes: 3 additions & 1 deletion docs/observability/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: About Observability
description: The Sumo Logic Observability Solution focuses on finding the unconsidered issues and the unknown risks to your system.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

Observability is the ability of the internal states of a system to be determined by its external outputs.

For our purposes, Observability is the ability to observe an application from the outside and understand what is happening inside the application and its services. Observability helps ensure that the application is running reliably: the system is up and running (available), performant, and secure.  
Expand Down Expand Up @@ -39,7 +41,7 @@ Modern applications are increasingly complex, as they leverage distributed techn

* **Troubleshoot** and uncover root cause(s) to guide recovery and ensure on-going application reliability. As in the case of the diagnosis step, the unknown unknowns might make it difficult to find the root cause.

![image9.png](/img/observability/about-ob-architecture.png)
<img src={useBaseUrl('img/observability/about-ob-architecture.png')} alt="Monitor, diagnose, and troubleshoot cycle diagram" style={{border: '1px solid gray'}} width="800" />

Monitoring, diagnosing, and troubleshooting such issues is harder because there are no existing runbooks that can help resolve issues quickly. This problem is compounded by the fact that modern applications also emit astonishing amounts of machine data across the stack. 

Expand Down
2 changes: 1 addition & 1 deletion docs/observability/aws/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Sumo Logic provides an AWS CloudFormation templates (CFN) and Terraform scripts

After you have [prepared](/docs/observability/aws/deploy-use-aws-observability/before-you-deploy) and [deployed](/docs/observability/aws/deploy-use-aws-observability) the solution, you can [add and configure additional AWS services](/docs/observability/aws/other-configurations-tools/add-new-aws-service) as your infrastructure grows.

![AWS_Observ_architecture.jpg](/img/observability/AWS_Observ_architecture.jpeg)
<img src={useBaseUrl('img/observability/AWS_Observ_architecture.jpeg')} alt="AWS observability architecture" style={{border: '1px solid gray'}} width="800" />

### Data collection and dashboards

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: Before You Deploy
description: Learn prerequisites and guidelines for deploying the AWS Observability Solution to a single AWS account and region.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

This page describes prerequisites and guidelines for deploying Sumo Logic’s AWS Observability Solution. 

:::info
Expand All @@ -30,8 +32,7 @@ If you are already collecting AWS metrics, logs, and/or events, we recommend tha
* View Monitors
* Manage Entity Type Configs
* Create access keys
* **Sumo Logic Access ID and Key**. When you deploy the solution, you’ll need to supply a Sumo Logic Access ID and Access Key, which enable you to use Sumo Logic APIs. Make sure you select default scope and have the role capabilities listed above before generating the Access ID and Key.
![Default-Scope.png](/img/observability/Default-Scope.png)
* **Sumo Logic Access ID and Key**. When you deploy the solution, you’ll need to supply a Sumo Logic Access ID and Access Key, which enable you to use Sumo Logic APIs. Make sure you select default scope and have the role capabilities listed above before generating the Access ID and Key. <br/><img src={useBaseUrl('img/observability/Default-Scope.png')} alt="Default scope" style={{border: '1px solid gray'}} width="500" />
:::note
For the AWS Observability Solution, you must use the default scope when generating the Access ID and Key; custom scopes are not supported.
:::
Expand Down Expand Up @@ -191,10 +192,10 @@ Before setting up the AWS Observability solution we recommend testing permission

1. Invoke the AWS CloudFormation template at this [URL](https://console.aws.amazon.com/cloudformation/home#/stacks/quickcreate?templateURL=https://sumologic-appdev-aws-sam-apps.s3.amazonaws.com/aws-observability-versions/v2.13.0/permissionchecker/permissioncheck.template.yaml).
1. Select the desired AWS region to test.
1. Enter a Stack Name, Sumo Logic Deployment, and Sumo Logic Access ID and Access Key.<br/> ![Testing_sumo_Permission_1.png](/img/observability/Testing_sumo_Permission_1.png)
1. Enter a Stack Name, Sumo Logic Deployment, and Sumo Logic Access ID and Access Key.<br/><img src={useBaseUrl('img/observability/Testing_sumo_Permission_1.png')} alt="Stack details" style={{border: '1px solid gray'}} width="800" />
1. Click **Create Stack.**
1. Verify that the AWS CloudFormation template has executed successfully in a CREATE_COMPLETE status.
* This indicates that you have all the right permissions on both the Sumo Logic and the AWS side to proceed with the installation of the solution. 
* All the resources (Sumo Logic and AWS) created by template are also deleted.<br/> ![Testing_sumo_Permission_2.png](/img/observability/Testing_sumo_Permission_2.png)
* All the resources (Sumo Logic and AWS) created by template are also deleted.<br/><img src={useBaseUrl('img/observability/Testing_sumo_Permission_2.png')} alt="Testing Sumo Logic permissions" style={{border: '1px solid gray'}} width="800" />
1. If the AWS CloudFormation template has not executed successfully, identify and fix any permission errors till the stack completes with a `CREATE_COMPLETE` status. 
1. Once the AWS CloudFormation stack has executed successfully, delete the AWS CloudFormation Stack.
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ sidebar_label: Configure Alerts
description: Sumo Logic has provided out-of-the-box alerts to help you quickly determine if a particular AWS service is available and performing as expected.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

Sumo Logic provides pre-configured alerts designed to promptly assess the availability and performance of specific AWS services. These alerts utilize metric datasets with predefined thresholds aligned with industry best practices and AWS recommendations. They are available for each AWS service integrated into the AWS Observability solution and can be deployed via a CloudFormation template.

After installing the AWS Observability solution and selecting "Install Dashboards and Alerts," you can configure these alerts by navigating to the AWS Observability folder under **Monitors**.

![install](/img/observability/install-dashboards-alerts.png)
<img src={useBaseUrl('img/observability/install-dashboards-alerts.png')} alt="Install Dashboards and Alerts" style={{border: '1px solid gray'}} width="800" />

To enable the monitors you wish to receive alerts from, see [Editing Monitor Settings](/docs/alerts/monitors/settings). To configure alerts to send notifications to other teams or connections, see [Create a Monitor](/docs/alerts/monitors/create-monitor). 

Expand Down
Loading