Skip to content

Commit 02f219d

Browse files
authored
docs(ilert): branding issues (#2011)
1 parent 4f1d253 commit 02f219d

File tree

3 files changed

+26
-25
lines changed

3 files changed

+26
-25
lines changed

docs/providers/documentation/ilert-provider.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: "Ilert Provider"
3-
sidebarTitle: "Ilert Provider"
2+
title: "ilert Provider"
3+
sidebarTitle: "ilert Provider"
44
description: "The ilert provider enables the creation, updating, and resolution of events or incidents on ilert, leveraging both incident management and event notification capabilities for effective incident response."
55
---
6-
# Ilert Provider
6+
# ilert Provider
77

88
## Overview
99

@@ -21,7 +21,7 @@ Depending on the `_type` specified, the provider will route the operation to the
2121
### Incident Management
2222

2323
- `summary`: A brief summary of the incident. This is required for creating a new incident.
24-
- `status`: `IlertIncidentStatus` - The current status of the incident (e.g., INVESTIGATING, RESOLVED, MONITORING, IDENTIFIED).
24+
- `status`: `ilertIncidentStatus` - The current status of the incident (e.g., INVESTIGATING, RESOLVED, MONITORING, IDENTIFIED).
2525
- `message`: A detailed message describing the incident or situation. Default is an empty string.
2626
- `affectedServices`: A JSON string representing the list of affected services and their statuses. Default is an empty array (`"[]"`).
2727
- `id`: The ID of the incident to update. If set to `"0"`, a new incident will be created.
@@ -69,5 +69,5 @@ This provider is part of Keep's integration with ilert, designed to enhance oper
6969

7070
## Useful Links
7171

72-
- [ilert API Documentation](https://api.ilert.com/api-docs/)
73-
- [ilert Alerting](https://www.ilert.com/product/reliable-actionable-alerting)
72+
- [ilert API Documentation](https://api.ilert.com/api-docs/?utm_campaign=Keep&utm_source=integration&utm_medium=organic)
73+
- [ilert Alerting](https://www.ilert.com/product/reliable-actionable-alerting?utm_campaign=Keep&utm_source=integration&utm_medium=organic)

docs/providers/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ By leveraging Keep Providers, users are able to deeply integrate Keep with the t
181181
></Card>
182182

183183
<Card
184-
title="Ilert"
184+
title="ilert"
185185
href="/providers/documentation/ilert-provider"
186186
icon={
187187
<img src="https://img.logo.dev/ilert.com?token=pk_dfXfZBoKQMGDTIgqu7LvYg" />

keep/providers/ilert_provider/ilert_provider.py

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Ilert Provider is a class that allows to create/close incidents in Ilert.
2+
ilert Provider is a class that allows to create/close incidents in ilert.
33
"""
44

55
import dataclasses
@@ -20,7 +20,7 @@
2020

2121
class IlertIncidentStatus(str, enum.Enum):
2222
"""
23-
Ilert incident status.
23+
ilert incident status.
2424
"""
2525

2626
INVESTIGATING = "INVESTIGATING"
@@ -32,7 +32,7 @@ class IlertIncidentStatus(str, enum.Enum):
3232
@pydantic.dataclasses.dataclass
3333
class IlertProviderAuthConfig:
3434
"""
35-
Ilert authentication configuration.
35+
ilert authentication configuration.
3636
"""
3737

3838
ilert_token: str = dataclasses.field(
@@ -54,8 +54,9 @@ class IlertProviderAuthConfig:
5454

5555

5656
class IlertProvider(BaseProvider):
57-
"""Create/Resolve incidents in Ilert."""
57+
"""Create/Resolve incidents in ilert."""
5858

59+
PROVIDER_DISPLAY_NAME = "ilert"
5960
PROVIDER_SCOPES = [
6061
ProviderScope("read_permission", "Read permission", mandatory=True),
6162
ProviderScope("write_permission", "Write permission", mandatory=False),
@@ -89,7 +90,7 @@ def dispose(self):
8990

9091
def validate_config(self):
9192
"""
92-
Validates required configuration for Ilert provider.
93+
Validates required configuration for ilert provider.
9394
9495
"""
9596
self.authentication_config = IlertProviderAuthConfig(
@@ -123,10 +124,10 @@ def validate_scopes(self):
123124

124125
def _query(self, incident_id: str, **kwargs):
125126
"""
126-
Query Ilert incident.
127+
Query ilert incident.
127128
"""
128129
self.logger.info(
129-
"Querying Ilert incident",
130+
"Querying ilert incident",
130131
extra={
131132
"incident_id": incident_id,
132133
**kwargs,
@@ -139,24 +140,24 @@ def _query(self, incident_id: str, **kwargs):
139140
)
140141
if not response.ok:
141142
self.logger.error(
142-
"Failed to query Ilert incident",
143+
"Failed to query ilert incident",
143144
extra={
144145
"status_code": response.status_code,
145146
"response": response.text,
146147
},
147148
)
148149
raise Exception(
149-
f"Failed to query Ilert incident: {response.status_code} {response.text}"
150+
f"Failed to query ilert incident: {response.status_code} {response.text}"
150151
)
151152
self.logger.info(
152-
"Ilert incident queried",
153+
"ilert incident queried",
153154
extra={"status_code": response.status_code},
154155
)
155156
return response.json()
156157

157158
def _get_alerts(self) -> list[AlertDto]:
158159
"""
159-
Get incidents from Ilert.
160+
Get incidents from ilert.
160161
"""
161162
if not self.authentication_config.ilert_host.endswith("/api"):
162163
self.authentication_config.ilert_host = (
@@ -217,7 +218,7 @@ def __create_or_update_incident(
217218
self, summary, status, message, affectedServices, id
218219
):
219220
self.logger.info(
220-
"Creating/updating Ilert incident",
221+
"Creating/updating ilert incident",
221222
extra={
222223
"summary": summary,
223224
"status": status,
@@ -271,17 +272,17 @@ def __create_or_update_incident(
271272

272273
if not response.ok:
273274
self.logger.error(
274-
"Failed to create/update Ilert incident",
275+
"Failed to create/update ilert incident",
275276
extra={
276277
"status_code": response.status_code,
277278
"response": response.text,
278279
},
279280
)
280281
raise Exception(
281-
f"Failed to create/update Ilert incident: {response.status_code} {response.text}"
282+
f"Failed to create/update ilert incident: {response.status_code} {response.text}"
282283
)
283284
self.logger.info(
284-
"Ilert incident created/updated",
285+
"ilert incident created/updated",
285286
extra={"status_code": response.status_code},
286287
)
287288
return response.json()
@@ -308,13 +309,13 @@ def __post_ilert_event(
308309
"links": links,
309310
"customDetails": custom_details,
310311
}
311-
self.logger.info("Posting Ilert event", extra=payload)
312+
self.logger.info("Posting ilert event", extra=payload)
312313
response = requests.post(
313314
f"{self.authentication_config.ilert_host}/events/keep/{self.authentication_config.ilert_token} ",
314315
json=payload,
315316
)
316317
self.logger.info(
317-
"Ilert event posted", extra={"status_code": response.status_code}
318+
"ilert event posted", extra={"status_code": response.status_code}
318319
)
319320
return response.json()
320321

@@ -335,7 +336,7 @@ def _notify(
335336
custom_details: dict = {},
336337
**kwargs: dict,
337338
):
338-
self.logger.info("Notifying Ilert", extra=locals())
339+
self.logger.info("Notifying ilert", extra=locals())
339340
if _type == "incident":
340341
return self.__create_or_update_incident(
341342
summary, status, message, affectedServices, id

0 commit comments

Comments
 (0)