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

docs/vmanomaly: preset guide #6151

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Conversation

Cambaza
Copy link
Contributor

@Cambaza Cambaza commented Apr 19, 2024

  • added instructions of how to run presets
  • description of Node Exporter indicators covered

@hagen1778
Copy link
Collaborator

@Cambaza is it a draft or you want it to be reviewed?

@Cambaza
Copy link
Contributor Author

Cambaza commented Apr 22, 2024

@Cambaza is it a draft or you want it to be reviewed?

@hagen1778 this is a draft that I want to be reviewed before the release of presets. It will be ready to merge only after vmanomaly new version.

Copy link
Contributor

@fred-navruzov fred-navruzov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Daria! Left some notes on how to make it easier for the users to read

docs/anomaly-detection/Presets.md Outdated Show resolved Hide resolved
docs/anomaly-detection/Presets.md Outdated Show resolved Hide resolved
docs/anomaly-detection/Presets.md Outdated Show resolved Hide resolved
docs/anomaly-detection/Presets.md Outdated Show resolved Hide resolved
docs/anomaly-detection/Presets.md Outdated Show resolved Hide resolved
docs/anomaly-detection/Presets.md Outdated Show resolved Hide resolved
docs/anomaly-detection/Presets.md Outdated Show resolved Hide resolved

Provided alerts are set to fire every time all models agreeing that the datapoint is anomalous.

You can find alerting rules here:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a question: it's useful to add here a reference to vmalert examples? to give more context and for using the same VM ecosystem

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My opinion is, that we describe here only the part connected to vmanomaly and assume that the user already knows about alerting and what it looks like. Correct me if I'm wrong @fred-navruzov @tenmozes

docs/anomaly-detection/Presets.md Outdated Show resolved Hide resolved
- HostUnusualNetworkThroughputOut

### Grafana dashboard
Grafana dashboard `.json` file can be found [here](http://localhost:8490/presets/dashboard.json): `http://localhost:8490/presets/dashboard.json`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a question (similar to vmalert ref above): should we add a reference to the guide of how to import custom dashboard in Grafana, like this or we assume most of the users should be already familiar with it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about that. @tenmozes aren't we assuming they already know this?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's assume that people know that

docs/anomaly-detection/Presets.md Outdated Show resolved Hide resolved
docs/anomaly-detection/Presets.md Outdated Show resolved Hide resolved
@Cambaza Cambaza requested a review from tenmozes April 26, 2024 13:39
weight: 1
title: Presets
---
# Anomaly Detection Presets
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no mentions in original documentation

@Cambaza
Copy link
Contributor Author

Cambaza commented May 6, 2024

rendertablebug

I have broken tags when I render docs locally, but it is ok in markdown IDE.

@Cambaza Cambaza requested a review from tenmozes May 15, 2024 11:29
@Cambaza Cambaza marked this pull request as ready for review May 15, 2024 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants