Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Add MSTeams and Telegram channels to CLI #1004

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/cli/src/constructs/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,5 @@ export * from './phone-call-alert-channel'
export * from './retry-strategy'
export * from './multi-step-check'
export * from './alert-escalation-policy'
export * from './msteams-alert-channel'
export * from './telegram-alert-channel'
112 changes: 112 additions & 0 deletions packages/cli/src/constructs/msteams-alert-channel.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
import { AlertChannel, AlertChannelProps } from './alert-channel'
import { Session } from './project'

export interface MSTeamsAlertChannelProps extends AlertChannelProps {
/**
* The name of your MSTeams alert
*/
name: string
/**
* The name of your MSTeams alert channel.
*/
channel_name: string
/**
* The URL webhook to which to send updates.
*/
url: string
/**
* Optional template for Teams Card.
*/
template?: string
}

/**
* Creates an MSTeams Alert Channel
*
* @remarks
*
* This class make use of the Alert Channel endpoints.
*/
export class MSTeamsAlertChannel extends AlertChannel {
name: string
channel_name: string
url: string
template?: string

/**
* Constructs the MSTeams Alert Channel instance
*
* @param logicalId unique project-scoped resource name identification
* @param props MSTeams alert channel configuration properties
* Fix following url:
* {@link https://checklyhq.com/docs/cli/constructs/#MSTeamsalertchannel Read more in the docs}
*/
constructor(logicalId: string, props: MSTeamsAlertChannelProps) {
super(logicalId, props)
this.name = props.name;
this.channel_name = props.channel_name;
this.url = props.url;
this.template = props.template || `{
"type": "message",
"attachments": [
{
"contentType": "application/vnd.microsoft.card.adaptive",
"content": {
"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
"type": "AdaptiveCard",
"version": "1.2",
"body": [
{
"size": "large",
"type": "TextBlock",
"text": "{{ALERT_TITLE}} has failed",
"wrap": true
},
{
"type": "TextBlock",
"text": "Response time: {{RESPONSE_TIME}}",
"wrap": true
},
{
"type": "TextBlock",
"text": "Location: {{RUN_LOCATION}}",
"wrap": true
},
{
"type": "TextBlock",
"text": "Timestamp: {{STARTED_AT}}",
"wrap": true
},
{
"type": "TextBlock",
"text": "Tags: {{TAGS}}",
"wrap": true
}
],
"actions": [
{
"type": "Action.OpenUrl",
"title": "Learn More",
"url": "https://adaptivecards.io"
}
]
}
}
]
}`;
Session.registerConstruct(this)
}

synthesize() {
return {
...super.synthesize(),
type: 'WEBHOOK',
config: {
name: this.name,
channel_name: this.channel_name,
url: this.url,
template: this.template,
},
}
}
}
78 changes: 78 additions & 0 deletions packages/cli/src/constructs/telegram-alert-channel.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
import { AlertChannel, AlertChannelProps } from './alert-channel'
import { HttpHeader } from './http-header'
import { HttpRequestMethod } from './api-check'
import { QueryParam } from './query-param'
import { Session } from './project'
import { WebhookAlertChannel, WebhookAlertChannelProps } from './webhook-alert-channel'

export interface TelegramAlertChannelProps extends AlertChannelProps {
/**
* The name of your Telegram alert
*/
name: string
/**
* The chat id of your Telegram bot.
*/
chat_id: string
/**
* API token for your telegram bot.
*/
api_token: string

/**
* An optional template for use in the GET URL.
*/
template?: string
}

/**
* Creates an Telegram Alert Channel
*
* @remarks
*
* This class make use of the Alert Channel endpoints.
*/
export class TelegramAlertChannel extends AlertChannel {
name: string
chat_id: string
api_token: string
template?: string
url: string
method: HttpRequestMethod

/**
* Constructs the Telegram Alert Channel instance
*
* @param logicalId unique project-scoped resource name identification
* @param props Telegram alert channel configuration properties
* Fix following url:
* {@link https://checklyhq.com/docs/cli/constructs/#Telegramalertchannel Read more in the docs}
*/
constructor(logicalId: string, props: TelegramAlertChannelProps) {
super(logicalId, props)
this.name = props.name;
this.chat_id = props.chat_id;
this.api_token = props.api_token;
this.template = props.template || `{{ALERT_TITLE}} at {{STARTED_AT}} in {{RUN_LOCATION}} ({{RESPONSE_TIME}}ms) Tags: {{#each TAGS}} {{this}} {{#unless @last}},{{/unless}} {{/each}} View check result: {{RESULT_LINK}}`;
this.url = `https://api.telegram.org/bot${props.api_token}/sendMessage?chat_id=${props.chat_id}&text=${this.template}`;
this.method = 'GET';
Session.registerConstruct(this)
}

synthesize() {
return {
...super.synthesize(),
type: 'WEBHOOK',
config: {
name: this.name,
chat_id: this.chat_id,
api_token: this.api_token,
url: this.url,
template: this.template,
method: this.method,
},
}
}
}