integrationer:observium

Observium

Observium är ett system som används för nätverksövervakning. Systemet kan konfigureras till att skicka ut sina larm via så kallade webhooks och Orbiq har ett API för att ta emot utskicken via Webhooks från Observium och omvandla dessa till larm i Orbiq. Information om vilken data som skickas via Webhooks kan fås här.

Så här ser mappningen ut mellan data från Observium och larmhanteringen i Orbiq:

Komponent i payload Exempel på indata Mappning inom Orbiq Kommentar
ALERT_STATE ALERT, ALERT REMINDER, RECOVER Aktiv, Aktiv, Normal Orbiq hanterar påminnelser om larm från Observium som ett aktivt händelse
ALERT_SEVERITY Warning, Critical o.s.v. Warning, Critical o.s.v. Larmprio (severity) från Orbservium lagras i klartext
ALERT_TIMESTAMP 2023-04-03 09:31:18 +02:00 Source_time: 2023-04-03 09:31:18 +02:00 Tidstämpeln från Orbservium lagras som source_timestamp i Orbiq. Orbiq skapar även en egen tidstämpel för när larmet har tagits emot och sparar det som orbiq_timestamp
ALERT_ID 418812 {Alert_ID} Används som subject (eller beteckning för larmpunkten) för larmmeddelandet i Orbiq Orbiq grupperar larmhändelser under unika beteckningar för larmpunkten. Alla larm från Observium som avser samma uppsatta ”regel” har också samma ”Alert_ID”, d.v.s. alla larmhändelser över tid, för samma typ av larm från samma enhet (exempelvis uteblivet pingsvar från switchXYZ) delar samma unika ”Alert_ID”. Därför används detta värde för att benämna larmpunkten. Eftersom detta ID inte ger någon meningsfull information till användaren, rekommenderar vi att användaren anger att Orbiq ska visa larmpunktens beskrivningstext istället för larmpunktens beteckning i larmlistan.
ALERT_MESSAGE
ENTITY_NAME
DEVICE_HOSTNAME
DEVICE_LOCATION
ALERT: [mysitesw50] [device]
mysitesw50
mysitesw50
Mylocation, MyCity
{Alert_Message} {Entity_Name} {Device_Hostname} {Device_Location} (det vill säga värdet för respektive variabel med mellanslag som skiljetecken) används som beskrivningstext för larmpunkten i Orbiq. Om {Entity_Name} och {Device_Hostname} har samma innehåll, skrivs endast ett av dessa fält ut i beskrivningstexten. Värdet för beskrivningstexten uppdateras varje gång ett nytt larm kommer in, så eventuella förändringar av värden från Observium kommer att återspeglas i Orbiq. Kombinationen av dessa parametrar ger en bättre beskrivning av larmpunkten och därför rekommenderar vi att användaren anger att Orbiq ska visa larmpunktens beskrivningstext istället för larmpunktens beteckning i larmlistan.
ENTITY_URL
ENTITY_NAME
ENTITY_ID
ENTITY_TYPE
ENTITY_DESCRIPTION
DEVICE_HOSTNAME
DEVICE_SYSNAME
DEVICE_DESCRIPTION
DEVICE_ID
DEVICE_URL
DEVICE_HARDWARE
DEVICE_OS
DEVICE_TYPE
DEVICE_LOCATION
http://url/device/device=1234/
mysitesw50
1679
device
mysitesw50
mysitesw50
mysitesw50
””
1679
http://url/device/device=1234/
DG534F Switch 2512-24T-PoEP
HPE ProCurve AB.32.03.0001
network
Mylocation, MyCity
”metadata”: {
”entity_url”: ”http://url/device/device=1234/”, ”entity_name”: ”mysitesw50”,

}
Egenskaperna i denna rad lagras i Orbiq i form av metadata. Dessa data visas inte via Orbiqs användargränssnitt, men de finns lagrade i databasen och är tillgängliga via systemets API.
TITLE

ENTITY_NAME
ENTITY_URL
CONDITIONS
METRICS
DURATION

DEVICE_HOSTNAME
DEVICE_URL
DEVICE_HARDWARE
DEVICE_OS
DEVICE_LOCATION
DEVICE_UPTIME
ALERT: [vk-garnsw50] [device]

Entity name: mysitesw50
URL: http://url/device/device=1234/
Conditions: device_status equals 0 (0)
Metrics: device_status = 0
Duration: 5m 7s (2023-04-03 09:26:11)

Device: mysitesw50
URL: https://url/device/device=1234/
Hardware: DG534F Switch 2512-24T-PoEP
OS: HPE ProCurve AB.32.03.0001
Location: Mylocation, MyCity
Uptime: Down (PING) 5m 7s
Uppgifterna används för att bygga texten för larmhändelsen i Orbiq

Inställning av larmutskick

I Observium registreras adressen till Orbiqs endpoint för mottagning av larm via Webhooks, enligt formatet nedan. Platshållarna {orbiq_url} och {observium_endpoint} ska bytas ut mot faktiska URL:en för Orbiq-installationen samt den benämning för endpointen som ska matchas mot inställningen för larmkällan i Orbiq.

https://{orbiq_url}/api/iqalarm/alarmEvent/observium/{observium_endpoint}

I Orbiq registreras en resurs för Orbservium. I fältet för ”adress”, anges samma beteckning som för {observium_endpoint} ovan. I drop-down väljaren för larmformat, välj alternativet Orbservium, eller Orbservium-lt, beroende av hur ni vill att larmmeddelandet ska presenteras/lagras i Orbiq. Observium-lt (light), är ett mera avskalat format, medan Observium innehåller mera information ur larmmeddelandet.

  • integrationer/observium.txt
  • Senast uppdaterad: 2023/09/08 11:09
  • av dokuadmin