{% package main %} {% import ( "time" "sort" "net/http" "github.com/VictoriaMetrics/VictoriaMetrics/app/vmalert/tpl" "github.com/VictoriaMetrics/VictoriaMetrics/app/vmalert/utils" "github.com/VictoriaMetrics/VictoriaMetrics/app/vmalert/notifier" ) %} {% func Welcome(r *http.Request) %} {%= tpl.Header(r, navItems, "vmalert") %} <p> API:<br> {% for _, p := range apiLinks %} {%code p, doc := p[0], p[1] %} <a href="{%s p %}">{%s p %}</a> - {%s doc %}<br/> {% endfor %} {% if r.Header.Get("X-Forwarded-For") == "" %} System:<br> {% for _, p := range systemLinks %} {%code p, doc := p[0], p[1] %} <a href="{%s p %}">{%s p %}</a> - {%s doc %}<br/> {% endfor %} {% endif %} </p> {%= tpl.Footer(r) %} {% endfunc %} {% func buttonActive(filter, expValue string) %} {% if filter != expValue %} btn-secondary {% else %} btn-primary {% endif %} {% endfunc %} {% func ListGroups(r *http.Request, originGroups []APIGroup) %} {%code prefix := utils.Prefix(r.URL.Path) %} {%= tpl.Header(r, navItems, "Groups") %} {%code filter := r.URL.Query().Get("filter") rOk := make(map[string]int) rNotOk := make(map[string]int) rNoMatch := make(map[string]int) var groups []APIGroup for _, g := range originGroups { var rules []APIRule for _, r := range g.Rules { if r.LastError != "" { rNotOk[g.ID]++ } else { rOk[g.ID]++ } if isNoMatch(r) { rNoMatch[g.ID]++ } if (filter == "unhealthy" && r.LastError == "") || (filter == "noMatch" && !isNoMatch(r)) { continue } rules = append(rules, r) } if len(rules) > 0 { g.Rules = rules groups = append(groups, g) } } %} <a class="btn {%= buttonActive(filter, "") %}" role="button" onclick="window.location = window.location.pathname">All</a> <a class="btn btn-primary" role="button" onclick="collapseAll()">Collapse All</a> <a class="btn btn-primary" role="button" onclick="expandAll()">Expand All</a> <a class="btn {%= buttonActive(filter, "unhealthy") %}" role="button" onclick="location.href='?filter=unhealthy'" title="Show only rules with errors">Unhealthy</a> <a class="btn {%= buttonActive(filter, "noMatch") %}" role="button" onclick="location.href='?filter=noMatch'" title="Show only rules matching no time series during last evaluation">NoMatch</a> {% if len(groups) > 0 %} {% for _, g := range groups %} <div class="group-heading{% if rNotOk[g.ID] > 0 %} alert-danger{%endif%}" data-bs-target="rules-{%s g.ID %}"> <span class="anchor" id="group-{%s g.ID %}"></span> <a href="#group-{%s g.ID %}">{%s g.Name %}{% if g.Type != "prometheus" %} ({%s g.Type %}){% endif %} (every {%f.0 g.Interval %}s) #</a> {% if rNotOk[g.ID] > 0 %}<span class="badge bg-danger" title="Number of rules with status Error">{%d rNotOk[g.ID] %}</span> {% endif %} {% if rNoMatch[g.ID] > 0 %}<span class="badge bg-warning" title="Number of rules with status NoMatch">{%d rNoMatch[g.ID] %}</span> {% endif %} <span class="badge bg-success" title="Number of rules withs status Ok">{%d rOk[g.ID] %}</span> <p class="fs-6 fw-lighter">{%s g.File %}</p> {% if len(g.Params) > 0 %} <div class="fs-6 fw-lighter">Extra params {% for _, param := range g.Params %} <span class="float-left badge bg-primary">{%s param %}</span> {% endfor %} </div> {% endif %} {% if len(g.Headers) > 0 %} <div class="fs-6 fw-lighter">Extra headers {% for _, header := range g.Headers %} <span class="float-left badge bg-primary">{%s header %}</span> {% endfor %} </div> {% endif %} </div> <div class="collapse" id="rules-{%s g.ID %}"> <table class="table table-striped table-hover table-sm"> <thead> <tr> <th scope="col" style="width: 60%">Rule</th> <th scope="col" style="width: 20%" class="text-center" title="How many samples were produced by the rule">Samples</th> <th scope="col" style="width: 20%" class="text-center" title="How many seconds ago rule was executed">Updated</th> </tr> </thead> <tbody> {% for _, r := range g.Rules %} <tr{% if r.LastError != "" %} class="alert-danger"{% endif %}> <td> <div class="row"> <div class="col-12 mb-2"> {% if r.Type == "alerting" %} <b>alert:</b> {%s r.Name %} (for: {%v r.Duration %} seconds) {% else %} <b>record:</b> {%s r.Name %} {% endif %} | {%= seriesFetchedWarn(r) %} <span><a target="_blank" href="{%s prefix+r.WebLink() %}">Details</a></span> </div> <div class="col-12"> <code><pre>{%s r.Query %}</pre></code> </div> <div class="col-12 mb-2"> {% if len(r.Labels) > 0 %} <b>Labels:</b>{% endif %} {% for k, v := range r.Labels %} <span class="ms-1 badge bg-primary">{%s k %}={%s v %}</span> {% endfor %} </div> {% if r.LastError != "" %} <div class="col-12"> <b>Error:</b> <div class="error-cell"> {%s r.LastError %} </div> </div> {% endif %} </div> </td> <td class="text-center">{%d r.LastSamples %}</td> <td class="text-center">{%f.3 time.Since(r.LastEvaluation).Seconds() %}s ago</td> </tr> {% endfor %} </tbody> </table> </div> {% endfor %} {% else %} <div> <p>No groups...</p> </div> {% endif %} {%= tpl.Footer(r) %} {% endfunc %} {% func ListAlerts(r *http.Request, groupAlerts []GroupAlerts) %} {%code prefix := utils.Prefix(r.URL.Path) %} {%= tpl.Header(r, navItems, "Alerts") %} {% if len(groupAlerts) > 0 %} <a class="btn btn-primary" role="button" onclick="collapseAll()">Collapse All</a> <a class="btn btn-primary" role="button" onclick="expandAll()">Expand All</a> {% for _, ga := range groupAlerts %} {%code g := ga.Group %} <div class="group-heading alert-danger" data-bs-target="rules-{%s g.ID %}"> <span class="anchor" id="group-{%s g.ID %}"></span> <a href="#group-{%s g.ID %}">{%s g.Name %}{% if g.Type != "prometheus" %} ({%s g.Type %}){% endif %}</a> <span class="badge bg-danger" title="Number of active alerts">{%d len(ga.Alerts) %}</span> <br> <p class="fs-6 fw-lighter">{%s g.File %}</p> </div> {%code var keys []string alertsByRule := make(map[string][]*APIAlert) for _, alert := range ga.Alerts { if len(alertsByRule[alert.RuleID]) < 1 { keys = append(keys, alert.RuleID) } alertsByRule[alert.RuleID] = append(alertsByRule[alert.RuleID], alert) } sort.Strings(keys) %} <div class="collapse" id="rules-{%s g.ID %}"> {% for _, ruleID := range keys %} {%code defaultAR := alertsByRule[ruleID][0] var labelKeys []string for k := range defaultAR.Labels { labelKeys = append(labelKeys, k) } sort.Strings(labelKeys) %} <br> <b>alert:</b> {%s defaultAR.Name %} ({%d len(alertsByRule[ruleID]) %}) | <span><a target="_blank" href="{%s defaultAR.SourceLink %}">Source</a></span> <br> <b>expr:</b><code><pre>{%s defaultAR.Expression %}</pre></code> <table class="table table-striped table-hover table-sm"> <thead> <tr> <th scope="col">Labels</th> <th scope="col">State</th> <th scope="col">Active at</th> <th scope="col">Value</th> <th scope="col">Link</th> </tr> </thead> <tbody> {% for _, ar := range alertsByRule[ruleID] %} <tr> <td> {% for _, k := range labelKeys %} <span class="ms-1 badge bg-primary">{%s k %}={%s ar.Labels[k] %}</span> {% endfor %} </td> <td>{%= badgeState(ar.State) %}</td> <td> {%s ar.ActiveAt.Format("2006-01-02T15:04:05Z07:00") %} {% if ar.Restored %}{%= badgeRestored() %}{% endif %} </td> <td>{%s ar.Value %}</td> <td> <a href="{%s prefix+ar.WebLink() %}">Details</a> </td> </tr> {% endfor %} </tbody> </table> {% endfor %} </div> <br> {% endfor %} {% else %} <div> <p>No active alerts...</p> </div> {% endif %} {%= tpl.Footer(r) %} {% endfunc %} {% func ListTargets(r *http.Request, targets map[notifier.TargetType][]notifier.Target) %} {%= tpl.Header(r, navItems, "Notifiers") %} {% if len(targets) > 0 %} <a class="btn btn-primary" role="button" onclick="collapseAll()">Collapse All</a> <a class="btn btn-primary" role="button" onclick="expandAll()">Expand All</a> {%code var keys []string for key := range targets { keys = append(keys, string(key)) } sort.Strings(keys) %} {% for i := range keys %} {%code typeK, ns := keys[i], targets[notifier.TargetType(keys[i])] count := len(ns) %} <div class="group-heading" data-bs-target="notifiers-{%s typeK %}"> <span class="anchor" id="group-{%s typeK %}"></span> <a href="#group-{%s typeK %}">{%s typeK %} ({%d count %})</a> </div> <div class="collapse show" id="notifiers-{%s typeK %}"> <table class="table table-striped table-hover table-sm"> <thead> <tr> <th scope="col">Labels</th> <th scope="col">Address</th> </tr> </thead> <tbody> {% for _, n := range ns %} <tr> <td> {% for _, l := range n.Labels.GetLabels() %} <span class="ms-1 badge bg-primary">{%s l.Name %}={%s l.Value %}</span> {% endfor %} </td> <td>{%s n.Notifier.Addr() %}</td> </tr> {% endfor %} </tbody> </table> </div> {% endfor %} {% else %} <div> <p>No targets...</p> </div> {% endif %} {%= tpl.Footer(r) %} {% endfunc %} {% func Alert(r *http.Request, alert *APIAlert) %} {%code prefix := utils.Prefix(r.URL.Path) %} {%= tpl.Header(r, navItems, "") %} {%code var labelKeys []string for k := range alert.Labels { labelKeys = append(labelKeys, k) } sort.Strings(labelKeys) var annotationKeys []string for k := range alert.Annotations { annotationKeys = append(annotationKeys, k) } sort.Strings(annotationKeys) %} <div class="display-6 pb-3 mb-3">Alert: {%s alert.Name %}<span class="ms-2 badge {% if alert.State=="firing" %}bg-danger{% else %} bg-warning text-dark{% endif %}">{%s alert.State %}</span></div> <div class="container border-bottom p-2"> <div class="row"> <div class="col-2"> Active at </div> <div class="col"> {%s alert.ActiveAt.Format("2006-01-02T15:04:05Z07:00") %} </div> </div> </div> <div class="container border-bottom p-2"> <div class="row"> <div class="col-2"> Expr </div> <div class="col"> <code><pre>{%s alert.Expression %}</pre></code> </div> </div> </div> <div class="container border-bottom p-2"> <div class="row"> <div class="col-2"> Labels </div> <div class="col"> {% for _, k := range labelKeys %} <span class="m-1 badge bg-primary">{%s k %}={%s alert.Labels[k] %}</span> {% endfor %} </div> </div> </div> <div class="container border-bottom p-2"> <div class="row"> <div class="col-2"> Annotations </div> <div class="col"> {% for _, k := range annotationKeys %} <b>{%s k %}:</b><br> <p>{%s alert.Annotations[k] %}</p> {% endfor %} </div> </div> </div> <div class="container border-bottom p-2"> <div class="row"> <div class="col-2"> Group </div> <div class="col"> <a target="_blank" href="{%s prefix %}groups#group-{%s alert.GroupID %}">{%s alert.GroupID %}</a> </div> </div> </div> <div class="container border-bottom p-2"> <div class="row"> <div class="col-2"> Source link </div> <div class="col"> <a target="_blank" href="{%s alert.SourceLink %}">Link</a> </div> </div> </div> {%= tpl.Footer(r) %} {% endfunc %} {% func RuleDetails(r *http.Request, rule APIRule) %} {%code prefix := utils.Prefix(r.URL.Path) %} {%= tpl.Header(r, navItems, "") %} {%code var labelKeys []string for k := range rule.Labels { labelKeys = append(labelKeys, k) } sort.Strings(labelKeys) var annotationKeys []string for k := range rule.Annotations { annotationKeys = append(annotationKeys, k) } sort.Strings(annotationKeys) var seriesFetchedEnabled bool var seriesFetchedWarning bool for _, u := range rule.Updates { if u.seriesFetched != nil { seriesFetchedEnabled = true if *u.seriesFetched == 0 && u.samples == 0{ seriesFetchedWarning = true } } } %} <div class="display-6 pb-3 mb-3">Rule: {%s rule.Name %}<span class="ms-2 badge {% if rule.Health!="ok" %}bg-danger{% else %} bg-success text-dark{% endif %}">{%s rule.Health %}</span></div> <div class="container border-bottom p-2"> <div class="row"> <div class="col-2"> Expr </div> <div class="col"> <code><pre>{%s rule.Query %}</pre></code> </div> </div> </div> {% if rule.Type == "alerting" %} <div class="container border-bottom p-2"> <div class="row"> <div class="col-2"> For </div> <div class="col"> {%v rule.Duration %} seconds </div> </div> </div> {% endif %} <div class="container border-bottom p-2"> <div class="row"> <div class="col-2"> Labels </div> <div class="col"> {% for _, k := range labelKeys %} <span class="m-1 badge bg-primary">{%s k %}={%s rule.Labels[k] %}</span> {% endfor %} </div> </div> </div> {% if rule.Type == "alerting" %} <div class="container border-bottom p-2"> <div class="row"> <div class="col-2"> Annotations </div> <div class="col"> {% for _, k := range annotationKeys %} <b>{%s k %}:</b><br> <p>{%s rule.Annotations[k] %}</p> {% endfor %} </div> </div> </div> <div class="container border-bottom p-2"> <div class="row"> <div class="col-2"> Debug </div> <div class="col"> {%v rule.Debug %} </div> </div> </div> {% endif %} <div class="container border-bottom p-2"> <div class="row"> <div class="col-2"> Group </div> <div class="col"> <a target="_blank" href="{%s prefix %}groups#group-{%s rule.GroupID %}">{%s rule.GroupID %}</a> </div> </div> </div> <br> {% if seriesFetchedWarning %} <div class="alert alert-warning" role="alert"> <strong>Warning:</strong> some of updates have "Series fetched" equal to 0.<br> It might be that either this data is missing in the datasource or there is a typo in rule's expression. For example, <strong>foo{label="bar"} > 0</strong> could never trigger because <strong>foo{label="bar"}</strong> metric doesn't exist. <br> Rule's expressions without time series selector, like <strong>expr: 42</strong> or <strong>expr: time()</strong> aren't fetching time series from datasource, so they could have "Series fetched" equal to 0 and this won't be a problem. <br> See more details about this detection <a target="_blank" href="https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4039">here</a>. </div> {% endif %} <div class="display-6 pb-3">Last {%d len(rule.Updates) %}/{%d rule.MaxUpdates %} updates</span>:</div> <table class="table table-striped table-hover table-sm"> <thead> <tr> <th scope="col" title="The time when event was created">Updated at</th> <th scope="col" style="width: 10%" class="text-center" title="How many samples were returned">Samples</th> {% if seriesFetchedEnabled %}<th scope="col" style="width: 10%" class="text-center" title="How many series were scanned by datasource during the evaluation">Series fetched</th>{% endif %} <th scope="col" style="width: 10%" class="text-center" title="How many seconds request took">Duration</th> <th scope="col" class="text-center" title="Time used for rule execution">Executed at</th> <th scope="col" class="text-center" title="cURL command with request example">cURL</th> </tr> </thead> <tbody> {% for _, u := range rule.Updates %} <tr{% if u.err != nil %} class="alert-danger"{% endif %}> <td> <span class="badge bg-primary rounded-pill me-3" title="Updated at">{%s u.time.Format(time.RFC3339) %}</span> </td> <td class="text-center">{%d u.samples %}</td> {% if seriesFetchedEnabled %}<td class="text-center">{% if u.seriesFetched != nil %}{%d *u.seriesFetched %}{% endif %}</td>{% endif %} <td class="text-center">{%f.3 u.duration.Seconds() %}s</td> <td class="text-center">{%s u.at.Format(time.RFC3339) %}</td> <td> <textarea class="curl-area" rows="1" onclick="this.focus();this.select()">{%s u.curl %}</textarea> </td> </tr> </li> {% if u.err != nil %} <tr{% if u.err != nil %} class="alert-danger"{% endif %}> <td colspan="{% if seriesFetchedEnabled %}6{%else%}5{%endif%}"> <span class="alert-danger">{%v u.err %}</span> </td> </tr> {% endif %} {% endfor %} {%= tpl.Footer(r) %} {% endfunc %} {% func badgeState(state string) %} {%code badgeClass := "bg-warning text-dark" if state == "firing" { badgeClass = "bg-danger" } %} <span class="badge {%s badgeClass %}">{%s state %}</span> {% endfunc %} {% func badgeRestored() %} <span class="badge bg-warning text-dark" title="Alert state was restored after the service restart from remote storage">restored</span> {% endfunc %} {% func seriesFetchedWarn(r APIRule) %} {% if isNoMatch(r) %} <svg xmlns="http://www.w3.org/2000/svg" data-bs-toggle="tooltip" title="No match! This rule's last evaluation hasn't selected any time series from the datasource. It might be that either this data is missing in the datasource or there is a typo in rule's expression. See more in Details." width="18" height="18" fill="currentColor" class="bi bi-exclamation-triangle-fill flex-shrink-0 me-2" viewBox="0 0 16 16" role="img" aria-label="Warning:"> <path d="M8 16A8 8 0 1 0 8 0a8 8 0 0 0 0 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194 0 .487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703 0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 1 1 0-2 1 1 0 0 1 0 2z"/> </svg> {% endif %} {% endfunc %} {%code func isNoMatch (r APIRule) bool { return r.LastSamples == 0 && r.LastSeriesFetched != nil && *r.LastSeriesFetched == 0 } %}