Incrementeel en idempotent
Door een checkpoint in de KV store wordt elk incident precies één keer verzameld. Herstarts en herplanningen gaan verder waar de vorige run stopte.
Splunk-add-on · Splunkbase app 8411TOPdesk-incidenten in Splunk.
TOPdesk-incidenten in Splunk.
Splunk-alerts in TOPdesk.
De Add-on for TOPdesk verzamelt TOPdesk-incidenten in Splunk en maakt TOPdesk-incidenten rechtstreeks aan vanuit Splunk-alerts. Open source, gebouwd op het UCC-framework van Splunk, door Orange Insight.
Zo stroomt de data
Twee richtingen, één add-on.
Een modular input bevraagt de TOPdesk REST API en indexeert elk incident als JSON-event. Een alert action gaat de andere kant op en opent een ticket in TOPdesk zodra een Splunk-alert afgaat.
TOPdesk
Servicemanagement
Incidents-inputelke 5 minuten, incrementeel
Alert actionmaakt incidenten aan vanuit alerts
Splunk
Enterprise of Cloud
01 / VERZAMELEN
Incidenten verzamelen
De modular input TOPdesk Incidents bevraagt de incidents-API volgens een schema dat jij kiest en indexeert elk incident als één JSON-event met sourcetype topdesk:incident. Daarmee is het direct bruikbaar voor spath, dashboards, SLA-rapportage en correlatie met de rest van je Splunk-data.
- Schema: standaard elke 5 minuten, of een eigen cron-expressie
- Filter op status (eerste lijn, tweede lijn of alles), prioriteit P1 tot P7, categorie en operatorgroep, optioneel alleen openstaande incidenten
- Incrementeel: een checkpoint in de KV store onthoudt het nieuwste incident, de eerste run haalt de laatste 24 uur op
- Volgt de paginering van TOPdesk automatisch
- Respecteert de proxy-instellingen en certificaatverificatie van Splunk, probeert tijdelijke fouten opnieuw met backoff en stopt direct bij authenticatiefouten
02 / AANMAKEN
Incidenten aanmaken
Voeg de actie Create TOPdesk incident toe aan elke Splunk-alert, of voer hem ad hoc uit met sendalert. Het ticket neemt de alertdata mee via $result.field$-tokens, zodat de servicedesk de host, de metriek en de drempel ziet in plaats van een kale melding.
- Velden: korte omschrijving, verzoektekst, e-mail van de melder (opgezocht in TOPdesk), status, prioriteit, vestiging en categorie
- Ondersteunt $result.field$-tokens, zodat het ticket de alertdata bevat
- Valideert lengtes en e-mailformaat voordat er iets wordt verstuurd
- Probeert alleen opnieuw bij tijdelijke HTTP-fouten
- Geschikt voor search head clusters: instellingen worden gerepliceerd
Aan de slag
In drie stappen operationeel.
Installeer vanaf Splunkbase, voer je TOPdesk-gegevens één keer in, en beide richtingen zijn beschikbaar voor elke input en alert op die instantie.
STAP 01
Gegevens configureren
Vul op de configuratiepagina van de add-on de TOPdesk-URL, de API-gebruikersnaam en het applicatiewachtwoord in. Het wachtwoord wordt versleuteld opgeslagen in de credential store van Splunk.
STAP 02
Input aanmaken
Maak een TOPdesk Incidents-input aan op een heavy forwarder of een enkele search head. Kies het interval, de filters en de doelindex. De eerste run haalt de laatste 24 uur op.
STAP 03
Alert action toevoegen
Open een alert op de search head, voeg Create TOPdesk incident toe als trigger action en vul de velden met $result.field$-tokens. Test hem ad hoc met sendalert.
Functies
Gebouwd voor beheer, niet voor een demo.
Elke ontwerpkeuze in de add-on komt uit het draaien van Splunk en servicedesks in productie: idempotent verzamelen, geheimen die geheim blijven en runs die je van begin tot eind kunt volgen.
Filteren aan de bron
Filters op status, prioriteit, categorie, operatorgroep en alleen-openstaand worden in de TOPdesk-query toegepast, zodat je indexeert wat je nodig hebt en niets meer.
Geheimen blijven geheim
Het applicatiewachtwoord staat versleuteld in de credential store van Splunk. Er komt niets gevoeligs in de logs, en e-mailadressen van melders worden gemaskeerd.
Proxy- en certificaatbewust
De input respecteert de proxy-instellingen en certificaatverificatie van Splunk, met retries en backoff bij tijdelijke fouten.
Traceerbare runs
Elke run en elke alertuitvoering schrijft gestructureerde logregels met een run-id en request-id naar _internal, afgesloten met één JSON MONITOR-samenvatting. Een Monitoring-dashboard wordt meegeleverd.
Open source
Apache 2.0-licentie, gebouwd met de Splunk Add-on Builder op het UCC-framework. Installeer hem vanaf Splunkbase, bekijk hem en breid hem uit met je eigen velden.
Compatibiliteit
Waar het draait.
Op Splunkbase vermeld als app 8411. Installeer de input op een heavy forwarder of een enkele search head, en de alert action op de search head.
Splunk Enterprise9.0 tot en met 10.6, Python 3-runtime
Splunk CloudVictoria en Classic experience
DeploymentInput op een heavy forwarder of enkele search head, alert action op de search head (geschikt voor search head clusters)
TOPdeskREST API v1, endpoint /tas/api/incidents
TOPdesk-rechtenOperatoraccount met leesrechten op incidenten (verzamelen) en aanmaakrechten (alert action)
CIM3.x tot 6.x
FrameworkSplunk Add-on Builder, UCC
LicentieApache License 2.0
Supportsupport@orangeinsight.io
TOPdesk is een geregistreerd handelsmerk van TOPdesk B.V. De add-on is onafhankelijk ontwikkeld door Orange Insight en is niet gelieerd aan of goedgekeurd door TOPdesk.
Veelgestelde vragen
FAQ.
Beveiliging, proxy's, Splunk Cloud en hoe je hulp krijgt. Mis je iets, mail support en we voegen het hier toe.
Hoe worden de TOPdesk-gegevens opgeslagen?
Het applicatiewachtwoord wordt versleuteld opgeslagen in de credential store van Splunk (passwords.conf), nooit als platte tekst in een configuratiebestand. Authenticatie bij TOPdesk verloopt via HTTP Basic over HTTPS. Geheimen komen nooit in logregels terecht, en e-mailadressen van melders worden gemaskeerd.
Werkt de add-on via een proxy?
De incidents-input respecteert de proxy-instellingen en certificaatverificatie van Splunk, zodat hij werkt vanuit omgevingen die TOPdesk via een uitgaande proxy bereiken.
Werkt het op Splunk Cloud?
Ja. De add-on ondersteunt Splunk Cloud op zowel de Victoria- als de Classic experience, naast Splunk Enterprise 9.0 tot en met 10.6. Op Victoria draaien inputs op de search head; op Classic gebruik je de inputs data manager of een heavy forwarder.
Welke rechten heeft de TOPdesk API-gebruiker nodig?
Een operatoraccount met een applicatiewachtwoord. Voor het verzamelen zijn leesrechten op incidenten nodig, voor de alert action aanmaakrechten. Gebruik een apart account per Splunk-instantie, zodat API-gebruik eenvoudig te auditen is.
Is de add-on gratis te gebruiken?
Ja. De Add-on for TOPdesk is open source onder de Apache License 2.0 en gratis te installeren vanaf Splunkbase. Consultancy eromheen, zoals dashboards, alertontwerp of hulp bij de uitrol, is een aparte dienst.
Kunnen jullie helpen met uitrol of uitbreiding?
Ja. We hebben de add-on gebouwd vanuit onze eigen Splunk-praktijk en helpen graag met dashboards op TOPdesk-data, alertontwerp, SLA-rapportage of eigen velden. Neem contact op via de contactpagina of mail support.
Neem contact op
TOPdesk-data aan het werk in Splunk?
Of je nu de add-on uitrolt, dashboards bouwt op incidentdata of alerts ontwerpt die de juiste tickets openen: wij helpen je er te komen.