AlertManager | AlertManager Telegram Bot

Index

References

Enumerations

IAlertManagerPredicates

Classes

Interfaces

Type aliases

Variables

Functions

References

IAlertManagerContext

Re-exports IAlertManagerContext

alertManagerComposer

Re-exports alertManagerComposer

setupAlertManagerContext

Re-exports setupAlertManagerContext

Type aliases

AlertsDBKey

AlertsDBKey: string

AlertsDBLevelDown

AlertsDBLevelDown: AbstractLevelDOWN<AlertsDBKey, AlertsDBValue>

AlertsDBLevelIterator

AlertsDBLevelIterator: AbstractIterator<string, string>

AlertsDBLevelUp

AlertsDBLevelUp: LevelUp<AlertsDBLevelDown, AlertsDBLevelIterator>

AlertsDBValue

AlertsDBValue: IAlert

BaseDBKey

BaseDBKey: IAlertManagerPredicates

BaseDBLevelDown

BaseDBLevelDown: AbstractLevelDOWN<BaseDBKey, BaseDBValue>

BaseDBLevelIterator

BaseDBLevelIterator: AbstractIterator<string, string>

BaseDBLevelUp

BaseDBLevelUp: LevelUp<BaseDBLevelDown, BaseDBLevelIterator>

BaseDBValue

BaseDBValue: string

IAlertMessageFilterFn

IAlertMessageFilterFn: (triple: ITriple<IAlertManagerPredicates>) => boolean

param: database record to filter
returns: true if the record is expected on the walk result

Type declaration

- (triple: ITriple<IAlertManagerPredicates>): boolean
- Parameters
  - triple: ITriple<IAlertManagerPredicates>
  Returns boolean

ILabels

ILabels: {}

Type declaration

[label: string]: string

Variables

Const alertManagerComposer

alertManagerComposer: Composer<IAlertManagerContext> = new Composer<IAlertManagerContext>()

Const alertManagerDbPath

alertManagerDbPath: undefined | string = process.env.ALERTMANAGER_DB_PATH

Const alertsDbPath

alertsDbPath: undefined | string = process.env.ALERTS_DB_PATH

Const externalUrl

externalUrl: URL = new URL(process.env.EXTERNAL_URL ||"http://127.0.0.1:9093")

Const internalUrl

internalUrl: undefined | string = process.env.INTERNAL_URL

Const templatePath

templatePath: string = process.env.TEMPLATE_FILE ||"default.tmpl"

Functions

Const alertManagerCBMiddleware

alertManagerCBMiddleware(ctx: IAlertManagerContext, next: () => Promise<void>): Promise<void>

- Defined in src/alertManager/alertManagerCBMiddleware.ts:30
processes callback requests from inline keyboards

Parameters
- ctx: IAlertManagerContext
  
  alertmanager's context
- next: () => Promise<void>
  
  continues middleware callback chain
  - - (): Promise<void>
    - Returns Promise<void>
Returns Promise<void>

callback chain result

Const alertManagerMiddleware

alertManagerMiddleware(ctx: IAlertManagerContext, next: () => Promise<void>): Promise<void>

- Defined in src/alertManager/alertManagerMiddleware.ts:31
processes updates sent from AlertManager to the bot webhook

Parameters
- ctx: IAlertManagerContext
  
  bot context containing AlertManager instance
- next: () => Promise<void>
  
  continues middleware callback chain
  - - (): Promise<void>
    - Returns Promise<void>
Returns Promise<void>

callback chain result

Const decodeFromString

decodeFromString<T>(str: string): T

- Defined in src/alertManager/messagepack.ts:24
decodes a messagepack string into an object

Type parameters
- T
Parameters
- str: string
  
  encoded string
Returns T

object with decoded data

Const encodeToString

encodeToString(obj: Record<string, unknown>): string

- Defined in src/alertManager/messagepack.ts:14
encodes an object into a messagepack string

Parameters
- obj: Record<string, unknown>
  
  object to encode
Returns string

encoded string

Const setupAlertManagerContext

setupAlertManagerContext(bot: Telegraf<IAlertManagerContext>, users?: string[]): Promise<void>

- Defined in src/alertManager/setupAlertManagerContext.ts:26
configures databases for alertmanager, alerts and sets up users to receive alerts

Parameters
- bot: Telegraf<IAlertManagerContext>
  
  bot instance
- Optional users: string[]
  
  optional user IDs to authorize upfront
Returns Promise<void>

callback chain result

Index

References

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

References

IAlertManagerContext

alertManagerComposer

setupAlertManagerContext

Type aliases

AlertsDBKey

AlertsDBLevelDown

AlertsDBLevelIterator

AlertsDBLevelUp

AlertsDBValue

BaseDBKey

BaseDBLevelDown

BaseDBLevelIterator

BaseDBLevelUp

BaseDBValue

IAlertMessageFilterFn

Type declaration

Parameters

triple: ITriple<IAlertManagerPredicates>

Returns boolean

ILabels

Type declaration

[label: string]: string

Variables

Const alertManagerComposer

Const alertManagerDbPath

Const alertsDbPath

Const externalUrl

Const internalUrl

Const templatePath

Functions

Const alertManagerCBMiddleware

Parameters

ctx: IAlertManagerContext

next: () => Promise<void>

Returns Promise<void>

Returns Promise<void>

Const alertManagerMiddleware

Parameters

ctx: IAlertManagerContext

next: () => Promise<void>

Returns Promise<void>

Returns Promise<void>

Const decodeFromString

Type parameters

T

Parameters

str: string

Returns T

Const encodeToString

Parameters

obj: Record<string, unknown>

Returns string

Const setupAlertManagerContext

Parameters

bot: Telegraf<IAlertManagerContext>

Optional users: string[]

Returns Promise<void>