mimir icon indicating copy to clipboard operation
mimir copied to clipboard

Docs: Write "Create your first recording rule and alert" topic

Open charleskorn opened this issue 3 years ago • 9 comments

Is your documentation request related to a feature? If so, which one?

Yes: recording rules and alerts

Describe the solution that you’d like or the expected outcome

It took me a while to piece together what I needed to do to set up my first recording rule and alert and connect ruler to Mimir's Alertmanager. The information I needed was spread across a number of pages:

It'd be great if there was a single page that described what I need to do to set up a recording rule or alert. I'm imagining a guide to creating your first recording rule and alert, but there might be a better way to present this information.

charleskorn avatar Dec 09 '22 03:12 charleskorn

@osg-grafana - Can we please add this to the Docs plan for Mimir? It would be a good guide to develop.

GrafanaWriter avatar Jan 10 '23 22:01 GrafanaWriter

@osg-grafana - Can we please add this to the Docs plan for Mimir? It would be a good guide to develop.

Yes.

osg-grafana avatar Jan 10 '23 22:01 osg-grafana

@charleskorn Did you figure this out / could you share what you found? I'm trying to add Recording Rules to my Grafana Alloy + Mimir setup, however I don't want to add the Prometheus Operator CRDs for that (if possible).

I can't find any docs on where and how to configure rules such as these - or is this simply not possible and has to be done on e.g. Grafana Alloy's side? In my understanding this is exactly the job of the Ruler Component

lieberlois avatar Jul 23 '24 09:07 lieberlois

The easiest way if you don't want to use Alloy's syncing functionality or the CRD is to use mimirtool to upload the rules to the ruler. Either mimirtool rules load (docs) or mimirtools rules sync (docs) should do what you need.

charleskorn avatar Jul 24 '24 01:07 charleskorn

@charleskorn I want to use the syncing functionality, but dont quite understand it - does it only work with the CRD from the Prometheus Operator? 🤔

lieberlois avatar Jul 24 '24 07:07 lieberlois

mimirtools rules sync is a command line tool that can be run anywhere.

charleskorn avatar Jul 25 '24 00:07 charleskorn

@charleskorn Thanks! :) I finally decided to just use the Prometheus Operator CRDS - however, all of the dashboards have wrong job names (I'm using grafana alloy) and the wrong cluster label set. Any ideas on how to do this with Alloy?

lieberlois avatar Aug 09 '24 14:08 lieberlois