Browse Guides

Coralogix Integration
Reading mode
Copy Link
Link Copied!
Print
Feedback
This guide has multiple versions available:
<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><p><strong>In this guide we will cover:</strong></p><p><strong>- What is the Coralogix Integration?</strong></p><p><strong>- Enabling the Coralogix Integration</strong></p><p><strong>- Creating an Alert Webhook in Coralogix</strong></p><p><strong>- Customising the Runbook</strong></p><p><br></p><p><br></p><p data-pasted="true"><strong><span style="font-size: 14pt;">What is the Coralogix Integration?</span></strong></p><p>The Coralogix integration creates a ticket in Halo when an alert is triggered in Coralogix, and when the alert is resolved in Coralogix, the ticket in Halo gets resolved. The integration works via a runbook, which can be customised if different behaviour is desired.&nbsp;</p><p><br></p><p><strong><span style="font-size: 14pt;">Enabling the Coralogix Integration</span></strong></p><p>In Configuration &gt; Integrations, navigate to the Coralogix module within the &quot;Asset Management &amp; Alerting&quot; section. Hover over this, and click the &quot;+&quot; icon to enable the module.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjNjMzRhZmRlLWViYzMtNDgzZC1iMGM2LTYxNDU1N2IyMjc2ZSJ9.IfgbbFTv_rSpc9AKLjNkWiiKzSawfyNS7y7Wu75hc4o" class="fr-fic fr-fil fr-dib" width="98" height="110"></p><p><strong><span style="font-size: 10pt;">Fig 1. Enabling the module</span></strong></p><p><br></p><p>Clicking into the module, you&#39;ll see the option to click into the &quot;Coralogix Runbook&quot;. This can also be found by navigating to Configuration &gt; Integrations &gt; Custom Integrations &gt; Integration Runbooks.</p><p><br></p><p><span data-pasted="true">If this button does not open the runbook, ensure your module is enabled as this is what will download the runbook.</span></p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjEwYWNkNjYxLWNiZmEtNDRhNi05ZTM4LTEwYmMxZWViYWVjMyJ9.16Z6d8X3XvmHaHExa0RNvsUosfWMbi5rVqg-qxwlTz8" class="fr-fic fr-fil fr-dib" width="808" height="358"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 2. Navigating to the runbook</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Creating an Alert Webhook in Coralogix</span></strong></p><p>The Coralogix documentation to create an alert webhook can be found <a href="https://coralogix.com/docs/alert-webhooks" target="_blank" rel="noopener noreferrer"><strong>here</strong></a>.</p><p><br></p><p data-pasted="true">Navigate to Integrations &gt; Integrations. In &quot;Sections&quot;, select &quot;Outbound Webhooks&quot;. Click &quot;Generic Webhook&quot; &gt; &quot;Add New&quot;.</p><p><br></p><p>Enter a webhook name and the URL to which you want to send an event notification. The URL entered here should be the one within the &quot;Details&quot; tab of the runbook. The UUID field is auto-populated, take note of this for later.</p><p><br></p><p><strong><em>Note: &quot;$ALERT_ACTION&quot; must be included in the webhook for the runbook to determine if it is an alert or a resolve webhook.<br></em></strong></p><p><br></p><p data-pasted="true">If multiple webhooks are triggered by one alert, only one ticket will be created in Halo until the ticket is resolved. A new ticket will be created for the next alert webhook.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg3ZWY1NWE5LTk3OGMtNDMyOC1iNTg5LTg4YjM5NGEyODQzZSJ9.UlCRx7BZnOQvZLi81r7SSb5tWXrsnK4xXC_uLuv3hLs" class="fr-fic fr-fil fr-dib" width="689" height="607"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 3. URL to trigger the runbook</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Customising the Runbook</span></strong></p><p>The UUID field from the webhook needs to be added to the runbook. In the &quot;Flow Chart&quot; tab, edit the runbook, then click the pencil icon on the first step.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjhlMDBkNDcxLTgyMzgtNGNjNS1hMzRlLWQ4ZWEwZGI5ZTIyYSJ9.LkBu9ItdMRgmP_u1bMi27xX_yXeyAea7pUJvs3QV3WM" class="fr-fic fr-fil fr-dib" width="1063" height="775"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 4. Editing the runbook step</span></strong></p><p><br></p><p data-pasted="true">Hover over the UUID condition, and click the pencil icon to edit it.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjM3ZmE1ZDhjLTU2OGMtNDI0MS05ZTYwLWEwOTU2ZGM2MzAwNyJ9.mGj_6FfNUgbqn53se9G1Ioe-LdlnJGcIpqPyOLGTJU8" class="fr-fic fr-fil fr-dib" width="1698" style="width: 1700px; height: 435.465px;" height="435"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 5. Editing the condition</span></strong></p><p><br></p><p>Enter the UUID from the webhook in the popup, then save. Ensure to save the popup, the step and then the runbook itself.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImIzZjk4YzRhLWNiYmItNGE3NS04NzU4LWYwMGY2ZjJmYzY3MSJ9.siWzDjjS95yeQqS6dL86TR-IoG71LFBYwuOrWsVZ6Ls" class="fr-fic fr-fil fr-dib" width="714" height="314"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 6. Entering the UUID</span></strong></p><p><br></p><p>The runbook will create alert tickets when triggered.</p><p><br></p><ul><li>If the &quot;ALERTACTION&quot; variable is set to &quot;<strong>trigger</strong>&quot;, it will log a ticket.</li><li>If the &quot;ALERTACTION&quot; variable is set to &quot;<strong>resolve</strong>&quot;, an &quot;Coralogix Alert Resolved&quot; action will be added to the ticket and the status will change to closed.</li></ul><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImVmZjA1NjA4LWJmYjUtNDM5Ny1iMTMwLTZhNjNkYzhmNjZiMyJ9.MzlmhxyFvgFeBquEVtx9iSN4-_lG4L16-YNX2Y_te98" class="fr-fic fr-fil fr-dib" width="1066" height="757"></p><p data-pasted="true"><strong><span style="font-size: 10pt;">Fig 7. Runbook overview</span></strong></p><p><br></p>
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.