Rótulos e anotações

Rótulos e anotações contêm informações sobre um alerta. Tanto os rótulos quanto as anotações têm a mesma estrutura: um conjunto de valores nomeados; no entanto, seus usos pretendidos são diferentes. Um exemplo de rótulo, ou anotação equivalente, pode ser alertname="test".

A principal diferença entre um rótulo e uma anotação é que os rótulos são usados para diferenciar um alerta de todos os outros alertas, enquanto as anotações são usadas para adicionar informações adicionais a um alerta existente.

Por exemplo, considere dois alertas de CPU de alta performance: um para server1 e outro para server2. Neste exemplo, podemos ter um rótulo denominado server, em que o primeiro alerta tem o rótulo server="server1" e o segundo alerta tem o rótulo server="server2". No entanto, talvez também queiramos adicionar uma descrição a cada alerta, como "The CPU usage for server1 is above 75%.", em que server1 e 75% são substituídos pelo nome e pelo uso da CPU do servidor (consulte a documentação sobre Modelos de rótulos e anotações para saber como fazer isso). Esse tipo de descrição seria mais adequado como uma anotação.

Rótulos

Os rótulos contêm informações que identificam um alerta. Um exemplo de rótulo pode ser server=server1. Cada alerta pode ter mais de um rótulo, e o conjunto completo de rótulos de um alerta é denominado seu conjunto de rótulos. É esse conjunto de rótulos que identifica o alerta.

Por exemplo, um alerta pode ter o rótulo definido como {alertname="High CPU usage",server="server1"}, enquanto outro alerta pode ter o rótulo definido como {alertname="High CPU usage",server="server2"}. Eles são dois alertas separados porque, embora seus rótulos de alertname sejam iguais, os rótulos de server são diferentes.

O rótulo definido para um alerta é uma combinação de rótulos da fonte de dados, rótulos personalizados da regra de alerta e vários rótulos reservados, como alertname.

Rótulos personalizados

Os rótulos personalizados são rótulos adicionais da regra de alerta. Assim como as anotações, os rótulos personalizados devem ter um nome, e seu valor pode conter uma combinação de texto e código de modelo que é avaliada quando um alerta é disparado. A documentação sobre como criar modelos de rótulos personalizados pode ser encontrada aqui.

Ao usar rótulos personalizados com modelos, é importante garantir que o valor do rótulo não mude entre avaliações consecutivas da regra de alerta, pois isso acabará criando um grande número de diferentes alertas. No entanto, não há problema em o modelo produzir valores de rótulo diferentes para diversos alertas. Por exemplo, não coloque o valor da consulta em um rótulo personalizado, pois isso acabará criando um novo conjunto de alertas sempre que o valor for alterado. Em vez disso, use anotações.

Também é importante garantir que o rótulo definido para um alerta não tenha dois ou mais rótulos com o mesmo nome. Se um rótulo personalizado tiver o mesmo nome de um rótulo da fonte de dados, ele substituirá esse rótulo. No entanto, se um rótulo personalizado tiver o mesmo nome de um rótulo reservado, o rótulo personalizado será omitido do alerta.

Anotações

As anotações são pares nomeados que adicionam informações extras aos alertas existentes. Há várias anotações sugeridas no Grafana, como description, summary, runbook_url, dashboardUId e panelId. Assim como os rótulos personalizados, as anotações devem ter um nome, e seu valor pode conter uma combinação de texto e código de modelo que é avaliada quando um alerta é disparado. Se uma anotação contiver código de modelo, o modelo será avaliado uma vez quando o alerta for disparado. Ele não será reavaliado, mesmo quando o alerta tiver sido resolvido. A documentação sobre como criar modelos de anotações pode ser encontrada aqui.