Skip to content

Commit

Permalink
feat: add sumologic provider
Browse files Browse the repository at this point in the history
Signed-off-by: 35C4n0r <[email protected]>
  • Loading branch information
35C4n0r committed Sep 15, 2024
1 parent 48d9826 commit cfd7ee6
Show file tree
Hide file tree
Showing 7 changed files with 539 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@ Workflow triggers can either be executed manually when an alert is activated or
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/prometheus-icon.png?raw=true"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/sumologic-icon.png?raw=true"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/victoriametrics-icon.png?raw=true"/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
<img width=32 height=32 src="https://github.com/keephq/keep/blob/main/keep-ui/public/icons/zabbix-icon.png?raw=true"/>
Expand Down
1 change: 1 addition & 0 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@
"providers/documentation/squadcast-provider",
"providers/documentation/ssh-provider",
"providers/documentation/statuscake-provider",
"providers/documentation/sumologic-provider",
"providers/documentation/teams-provider",
"providers/documentation/telegram-provider",
"providers/documentation/template",
Expand Down
36 changes: 36 additions & 0 deletions docs/providers/documentation/sumologic-provider.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: "SumoLogic Provider"
sidebarTitle: "SumoLogic Provider"
description: "The SumoLogic provider enables webhook installations for receiving alerts in keep"
---

## Overview

The SumoLogic provider facilitates receiving alerts from Monitors in SumoLogic using a Webhook Connection.

## Authentication Parameters

- `sumoLogicAccessId`: API key for authenticating with SumoLogic's API.
- `sumoLogicAccessKey`: API key for authenticating with SumoLogic's API.
- `deployment`: API key for authenticating with SumoLogic's API.

## Scopes

- `authenticated`: Mandatory for all operations, ensures the user is authenticated.
- `authorized`: Mandatory for querying incidents, ensures the user has read access.

## Connecting with the Provider

1. Follow the instructions [here](https://help.sumologic.com/docs/manage/security/access-keys/) to get your Access Key & Access ID
2. Make sure the user has roles with the following capabilities:
- `manageScheduledViews`
- `manageConnections`
- `manageUsersAndRoles`
3. Find your `deployment` from [here](https://api.sumologic.com/docs/#section/Getting-Started/API-Endpoints), keep will automatically figure out your endpoint.

## Useful Links

- [SumoLogic API Documentation](https://api.sumologic.com/docs/#section/Getting-Started)
- [SumoLogic Access_Keys](https://help.sumologic.com/docs/manage/security/access-keys/)
- [SumoLogic Roles Management](https://help.sumologic.com/docs/manage/users-roles/roles/create-manage-roles/)
- [SumoLogic Deployments](https://api.sumologic.com/docs/#section/Getting-Started/API-Endpoints)
Binary file added keep-ui/public/icons/sumologic-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file.
20 changes: 20 additions & 0 deletions keep/providers/sumologic_provider/connection_template.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "{{Name}}",
"description": "{{Description}}",
"monitorType": "{{MonitorType}}",
"query": "{{Query}}",
"queryURL": "{{QueryURL}}",
"resultsJson": "{{ResultsJson}}",
"numQueryResults": "{{NumQueryResults}}",
"id": "{{Id}}",
"detectionMethod": "{{DetectionMethod}}",
"triggerType": "{{TriggerType}}",
"triggerTimeRange": "{{TriggerTimeRange}}",
"triggerTime": "{{TriggerTime}}",
"triggerCondition": "{{TriggerCondition}}",
"triggerValue": "{{TriggerValue}}",
"triggerTimeStart": "{{TriggerTimeStart}}",
"triggerTimeEnd": "{{TriggerTimeEnd}}",
"sourceURL": "{{SourceURL}}",
"alertResponseUrl": "{{AlertResponseUrl}}"
}
Loading

0 comments on commit cfd7ee6

Please sign in to comment.