Skip to content

Commit

Permalink
Add unit for timeshift and slack formatting note (#1056)
Browse files Browse the repository at this point in the history
  • Loading branch information
srikanthccv authored Dec 23, 2024
1 parent 6599762 commit df7b1dc
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 2 deletions.
4 changes: 4 additions & 0 deletions data/docs/alerts-management/anomaly-based-alerts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ You can incorporate result attributes in the alert descriptions to make the aler

**Example**: If you have a query that has the attribute `service.name` in the group by clause then to use it in the alert description, you will use `$service.name`.

#### Slack alert format

Using [advanced slack formatting](https://api.slack.com/reference/surfaces/formatting#advanced) is supported if you are using Slack as a notification channel.

### Labels
A field to add static labels or tags for categorization. Labels should be added in key value pairs. First enter key (avoid space in key) and set value.

Expand Down
4 changes: 4 additions & 0 deletions data/docs/alerts-management/exceptions-based-alerts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ You can incorporate result attributes in the alert descriptions to make the aler

**Example**: If you have a query that has the attribute `service.name` in the group by clause then to use it in the alert description, you will use `$service.name`.

#### Slack alert format

Using [advanced slack formatting](https://api.slack.com/reference/surfaces/formatting#advanced) is supported if you are using Slack as a notification channel.

### Labels
A field to add static labels or tags for categorization. Labels should be added in key value pairs. First enter key (avoid space in key) and set value.

Expand Down
4 changes: 4 additions & 0 deletions data/docs/alerts-management/log-based-alerts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ You can incorporate result attributes in the alert descriptions to make the aler

**Example**: If you have a query that has the attribute `service.name` in the group by clause then to use it in the alert description, you will use `$service.name`.

#### Slack alert format

Using [advanced slack formatting](https://api.slack.com/reference/surfaces/formatting#advanced) is supported if you are using Slack as a notification channel.

### Labels
A field to add static labels or tags for categorization. Labels should be added in key value pairs. First enter key (avoid space in key) and set value.

Expand Down
4 changes: 4 additions & 0 deletions data/docs/alerts-management/metrics-based-alerts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,10 @@ You can incorporate result attributes in the alert descriptions to make the aler

**Example**: If you have a query that has the attribute `service.name` in the group by clause then to use it in the alert description, you will use `$service.name`.

#### Slack alert format

Using [advanced slack formatting](https://api.slack.com/reference/surfaces/formatting#advanced) is supported if you are using Slack as a notification channel.

### Labels
A field to add static labels or tags for categorization. Labels should be added in key value pairs. First enter key (avoid space in key) and set value.

Expand Down
4 changes: 4 additions & 0 deletions data/docs/alerts-management/trace-based-alerts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@ Add a detailed description for the alert, explaining its purpose and trigger con

You can incorporate result labels in the alert descriptions to make the alerts more informative:

#### Slack alert format

Using [advanced slack formatting](https://api.slack.com/reference/surfaces/formatting#advanced) is supported if you are using Slack as a notification channel.

### Test Notification
A button to test the alert to ensure that it works as expected.

Expand Down
2 changes: 1 addition & 1 deletion data/docs/userguide/query-builder.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ To extend the data analysis capabilities of the Metrics Query Builder, you can u

- **Smoothing Functions:** To deal with volatile data, smoothing functions can be applied, such as moving averages, which help in identifying underlying trends by reducing noise. For example, functions like EWMA 3/5/7 (Exponentially Weighted Moving Average) can smooth data fluctuations over 3, 5, or 7 periods.

- **Time Shift Functions:** These functions enable comparisons of data across different time periods, useful for analyzing trends, changes, or anomalies over time. For example, using the `Time Shift` function for shifting a series by a fixed amount of seconds to compare current data with past data.
- **Time Shift Functions:** These functions enable comparisons of data across different time periods, useful for analyzing trends, changes, or anomalies over time. For example, using the `Time Shift` function for shifting a series by a fixed amount of seconds to compare current data with past data. The input for this function is a time shift value in seconds. For example, `Time Shift 3600` will shift the series by 1 hour.

<figure data-zoomable align='center'>
<img className="box-shadowed-image" src="/img/docs/product-features/query-builder/support-for-functions.webp" alt="Functions in metrics query builder"/>
Expand Down
2 changes: 1 addition & 1 deletion data/newsroom/launch-week-1-day-2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ We have added support for four kinds of functions in the metrics query builder t

- **Smoothing Functions:** To deal with volatile data, smoothing functions can be applied, such as moving averages, which help in identifying underlying trends by reducing noise.

- **Time Shift Functions:** These functions enable comparisons of data across different time periods, useful for analyzing trends, changes, or anomalies over time.
- **Time Shift Functions:** These functions enable comparisons of data across different time periods, useful for analyzing trends, changes, or anomalies over time. The input for this function is a time shift value in seconds. For example, `Time Shift 3600` will shift the series by 1 hour.

You can use functions for things like reducing visual noise.

Expand Down

0 comments on commit df7b1dc

Please sign in to comment.