From f3d500841b00859d2f0ad11e9fe0387d3e899c74 Mon Sep 17 00:00:00 2001
From: Samuel Roberts <sam.roberts@geant.org>
Date: Wed, 9 Mar 2022 12:41:10 +0000
Subject: [PATCH] add more elaboration to comment

---
 brian_polling_manager/interfaces.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/brian_polling_manager/interfaces.py b/brian_polling_manager/interfaces.py
index a82105d..97afa3e 100644
--- a/brian_polling_manager/interfaces.py
+++ b/brian_polling_manager/interfaces.py
@@ -26,6 +26,7 @@ class InterfaceCheck(sensu.AbstractCheck):
     @sensu.AbstractCheck.name.getter
     def name(self):
         # fix POL1-386 - replace : in interface name with .
+        # see https://docs.sensu.io/sensu-go/latest/observability-pipeline/observe-schedule/checks/#metadata-attributes
         ifc_name = self.interface['name'].replace('/', '-').replace(':', '.')
         return f'ifc-{self.interface["router"]}-{ifc_name}'
 
-- 
GitLab