# Functions
Alert alerts to slack, email, text.
AllMsgPayloads generates a series of payloads based on specified payload sizes or the number of messages.
AnalyticsAppStart reports a monitor starts.
AnalyticsClearIncident reports the end of an incident.
AnalyticsDowntime reports downtime.
AnalyticsHeartbeat reports heartbeat.
AnalyticsLatencyReport reports a monitor starts.
AnalyticsReportIncident reports the beginning of an incident.
BuildTenantsUsageThread is the daemon thread that builds last 30s tenants usage and expose to Prometheus metrics.
CalculateDowntime calculate downtime.
ClearIncident clears an incident.
CloseOpsGenieAlert deletes an OpsGenie alert.
CreateIncident creates incident.
CreateOpsGenieAlert creates an OpsGenie alert.
EvaluateBrokers evaluates and reports all brokers health.
EvaluateClusterHealth evaluates and reports the k8s cluster health.
FuncLatencyGaugeOpt is the description of Pulsar Function latency gauge.
GenPayload generates an array of bytes with prefix string and payload size.
GetConfig returns a reference to the Configuration.
GetGaugeType get the Prometheus Gauge Option based on type/subsystem.
GetMessageID returns the message index by parsing the template payload string with a prefix.
GetOfflinePodsCounter returns prometheus GaugeOpts for kubernetes cluster pod offline counter.
GetPulsarClient gets the pulsar client object Note: the caller has to Close() the client object.
HeartbeatCounterOpt is the description for heart beat counter.
HeartBeatToOpsGenie send heart beat to ops genie.
MonitorBrokers start K8sPulsarClusterMonitor thread.
MonitorK8sPulsarCluster start K8sPulsarClusterMonitor thread.
MonitorSites monitors a list of sites.
MsgLatencyGaugeOpt is the description for Pulsar message latency gauge.
NewIncident creates a Incident object.
NewPayload returns a new Payload object with a fixed payload size.
NumOfBytes returns a number of bytes with specified size in MB or KB.
OfflinePodGaugeOpt is offline pods counter.
PromCounter registers counter and increment.
PromGauge registers gauge reading.
PromGaugeInt registers gauge reading in integer.
PromLatencySum expose monitoring metrics to Prometheus.
PubSubDowntimeGaugeOpt is the description for downtime summary.
PubSubLatency the latency including successful produce and consume of a message.
PulsarAdminTenant probes the tenant endpoint to get a list of tenants returns the number of tenants on the cluster.
PulsarTenants get a list of tenants on each cluster.
PushToPrometheusProxy pushes exp data to PrometheusProxy.
PushToPrometheusProxyThread is the daemon thread that scrape and pushes metrics to prometheus proxy.
ReadConfigFile reads configuration file.
RemoveIncident removes an existing incident.
ReportIncident reports an incident.
RunInterval runs interval.
SendSlackNotification will post to an 'Incoming Webook' url setup in Slack Apps.
SetupAnalytics initializes and validates the configuration.
SiteLatencyGaugeOpt is the description for hosting site latency gauge.
StartHeartBeat starts heartbeat monitoring the program by OpsGenie.
TenantsGaugeOpt is the description for rest api tenant counts.
TestTopicLatency test generic message delivery in topics and the latency.
TestWsLatency test all clusters' websocket pub sub latency.
TopicLatencyTestThread tests a message delivery in topic and measure the latency.
UptimeHeartBeat sends heartbeat to uptime counter.
VerboseAlert is able to reduce the verbosity to Slack channel.
WebSocketTopicLatencyTestThread tests a message websocket delivery in topic and measure the latency.
WsLatencyTest latency test for websocket.
# Constants
PrefixDelimiter for message prefix.
# Variables
AllowedPriorities a list of allowed priorities.
Config - this server's configuration instance.
# Structs
AckMessage is the message struct to acknowledge a message.
AlertPolicyCfg is a set of criteria to evaluation triggers for incident alert.
AlertVerbosity contains attributes required to calculate whether verbose alert is required or not.
AmpEvent the analytic event.
AnalyticsCfg is analytics usage and statistucs tracking configuration.
AppStartEvent event.
BrokersCfg monitors all brokers in the cluster.
ClearIncidentEvent event.
ClusterHealth a cluster health struct.
Configuration - this server's configuration.
DowntimeReportEvent event.
HeartbeatEvent event.
Incident is the struct for incident reporting.
IncidentAlertPolicy tracks and reports incident when threshold is reached.
K8sClusterCfg is configuration to monitor kubernete cluster only to be enabled in-cluster monitoring.
LatencyReportEvent event.
MsgResult stores the result of message test.
OpsClusterCfg is each cluster's configuration.
OpsGenieAlertCloseRequest is the POST request payload json.
OpsGenieAlertCreateResponse is the response struct returned by OpsGenie https://docs.opsgenie.com/docs/alert-api#section-create-alert.
OpsGenieAlertGetResponse is the response struct returned by OpsGenie https://docs.opsgenie.com/docs/alert-api#section-create-alert.
OpsGenieCfg is opsGenie configuration.
Payload defines the payload size.
PrometheusCfg configures Premetheus set up.
PulsarAdminRESTCfg is for monitor a list of Pulsar cluster.
PulsarMessage is the required message format for Pulsar Websocket message.
ReceivingMessage is the Pulsar message for socket consumer.
ReportIncidentEvent event.
SiteCfg configures general website.
SitesCfg configures a list of website`.
SlackCfg is slack configuration.
SlackMessage is the message struct to be posted for Slack.
TenantUsageCfg tenant usage reporting and monitoring.
TopicCfg is topic configuration.
WsConfig is configuration to monitor WebSocket pub sub latency.