health_monitor

Documentation

Index

• type Aws
• type ConsulEventForwarder
• type Datadog
• type Director
• type DirectorAccount
• type Env
• type EventNats
• type Graphite
• type HealthMonitorJob
• type Hm
• type Http
• type Intervals
• type Nats
• type Pagerduty
• type Resurrector
• type Smtp
• type SyslogEventForwarder
• type Tsdb

Types

type Aws

type Aws struct {

	/*SecretAccessKey - Descr: AWS secret access key Default: <nil>
	 */
	SecretAccessKey interface{} `yaml:"secret_access_key,omitempty"`

	/*AccessKeyId - Descr: AWS access key id Default: <nil>
	 */
	AccessKeyId interface{} `yaml:"access_key_id,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type ConsulEventForwarder

type ConsulEventForwarder struct {

	/*HeartbeatsAsAlerts - Descr: Should we treat all heartbeats as alerts as well? Default: false
	 */
	HeartbeatsAsAlerts interface{} `yaml:"heartbeats_as_alerts,omitempty"`

	/*Host - Descr: Location of Consul Cluster or agent Default: <nil>
	 */
	Host interface{} `yaml:"host,omitempty"`

	/*Namespace - Descr: A namespace for handling multiples of the same release Default: <nil>
	 */
	Namespace interface{} `yaml:"namespace,omitempty"`

	/*TtlNote - Descr: A note for ttl checks Default: Automatically Registered by Bosh-Monitor
	 */
	TtlNote interface{} `yaml:"ttl_note,omitempty"`

	/*Ttl - Descr: A ttl time for ttl checks, if set ttl checks will be used Default: <nil>
	 */
	Ttl interface{} `yaml:"ttl,omitempty"`

	/*Protocol - Descr: http/https Default: http
	 */
	Protocol interface{} `yaml:"protocol,omitempty"`

	/*Events - Descr: Whether or not to use the events api Default: false
	 */
	Events interface{} `yaml:"events,omitempty"`

	/*Params - Descr: Params for url can be used for passing ACL token Default: <nil>
	 */
	Params interface{} `yaml:"params,omitempty"`

	/*Port - Descr: Consul Port Default: 8500
	 */
	Port interface{} `yaml:"port,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Datadog

type Datadog struct {

	/*ApplicationKey - Descr: Health Monitor Application Key for DataDog Default: <nil>
	 */
	ApplicationKey interface{} `yaml:"application_key,omitempty"`

	/*PagerdutyServiceName - Descr: Service name to alert in PagerDuty upon HM events Default: <nil>
	 */
	PagerdutyServiceName interface{} `yaml:"pagerduty_service_name,omitempty"`

	/*ApiKey - Descr: API Key for DataDog Default: <nil>
	 */
	ApiKey interface{} `yaml:"api_key,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Director

type Director struct {

	/*Port - Descr: Port of the Bosh Director to connect to Default: 25555
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*Address - Descr: Address of the Bosh Director to connect to Default: <nil>
	 */
	Address interface{} `yaml:"address,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type DirectorAccount

type DirectorAccount struct {

	/*ClientSecret - Descr: UAA client secret to access Bosh Director Default:
	 */
	ClientSecret interface{} `yaml:"client_secret,omitempty"`

	/*ClientId - Descr: UAA client id to access Bosh Director Default:
	 */
	ClientId interface{} `yaml:"client_id,omitempty"`

	/*CaCert - Descr: Certificate to verify UAA endpoint Default:
	 */
	CaCert interface{} `yaml:"ca_cert,omitempty"`

	/*User - Descr: User to access Bosh Director Default:
	 */
	User interface{} `yaml:"user,omitempty"`

	/*Password - Descr: Password to access Bosh Director Default:
	 */
	Password interface{} `yaml:"password,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Env

type Env struct {

	/*NoProxy - Descr: List of comma-separated hosts that should skip connecting to the proxy in the health monitor Default: <nil>
	 */
	NoProxy interface{} `yaml:"no_proxy,omitempty"`

	/*HttpProxy - Descr: HTTP proxy that the health monitor should use Default: <nil>
	 */
	HttpProxy interface{} `yaml:"http_proxy,omitempty"`

	/*HttpsProxy - Descr: HTTPS proxy that the health monitor should use Default: <nil>
	 */
	HttpsProxy interface{} `yaml:"https_proxy,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type EventNats

type EventNats struct {

	/*Address - Descr: Address of the event NATS message bus to connect to Default: <nil>
	 */
	Address interface{} `yaml:"address,omitempty"`

	/*User - Descr: User for the event NATS message bus connection Default: <nil>
	 */
	User interface{} `yaml:"user,omitempty"`

	/*Password - Descr: Password for event NATS message bus connection Default: <nil>
	 */
	Password interface{} `yaml:"password,omitempty"`

	/*Port - Descr: Port of the event NATS message bus port to connect to Default: <nil>
	 */
	Port interface{} `yaml:"port,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Graphite

type Graphite struct {

	/*Prefix - Descr: Prefix that will be added to all metrics sent to Graphite Default: <nil>
	 */
	Prefix interface{} `yaml:"prefix,omitempty"`

	/*Address - Descr: Graphite address Default: <nil>
	 */
	Address interface{} `yaml:"address,omitempty"`

	/*Port - Descr: Graphite port Default: <nil>
	 */
	Port interface{} `yaml:"port,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type HealthMonitorJob

type HealthMonitorJob struct {

	/*EventNatsEnabled - Descr: Enable event NATS message bus plugin Default: false
	 */
	EventNatsEnabled interface{} `yaml:"event_nats_enabled,omitempty"`

	/*Director - Descr: Address of the Bosh Director to connect to Default: <nil>
	 */
	Director *Director `yaml:"director,omitempty"`

	/*Hm - Descr: Email of recipients (Array) Default: <nil>
	 */
	Hm *Hm `yaml:"hm,omitempty"`

	/*Nats - Descr: Port of the NATS message bus port to connect to Default: 4222
	 */
	Nats *Nats `yaml:"nats,omitempty"`

	/*Env - Descr: HTTPS proxy that the health monitor should use Default: <nil>
	 */
	Env *Env `yaml:"env,omitempty"`

	/*EventNats - Descr: Port of the event NATS message bus port to connect to Default: <nil>
	 */
	EventNats *EventNats `yaml:"event_nats,omitempty"`

	/*Aws - Descr: AWS access key id Default: <nil>
	 */
	Aws *Aws `yaml:"aws,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Hm

type Hm struct {

	/*CloudWatchEnabled - Descr: Enable AWS CloudWatch Plugin Default: false
	 */
	CloudWatchEnabled interface{} `yaml:"cloud_watch_enabled,omitempty"`

	/*Resurrector - Descr: Time (in seconds) for which an alert in the resurrector is considered 'current'; alerts older than this are ignored when deciding to recreate a job. Default: 600
	 */
	Resurrector *Resurrector `yaml:"resurrector,omitempty"`

	/*Tsdb - Descr: Port of TSDB to connect to Default: <nil>
	 */
	Tsdb *Tsdb `yaml:"tsdb,omitempty"`

	/*EmThreadpoolSize - Descr: EM thread pool size Default: 20
	 */
	EmThreadpoolSize interface{} `yaml:"em_threadpool_size,omitempty"`

	/*EmailRecipients - Descr: Email of recipients (Array) Default: <nil>
	 */
	EmailRecipients interface{} `yaml:"email_recipients,omitempty"`

	/*Loglevel - Descr: Level of log messages (fatal, error, warn, info, debug) Default: info
	 */
	Loglevel interface{} `yaml:"loglevel,omitempty"`

	/*DatadogEnabled - Descr: Enable DataDog plugin Default: false
	 */
	DatadogEnabled interface{} `yaml:"datadog_enabled,omitempty"`

	/*GraphiteEnabled - Descr: Enable Graphite plugin Default: false
	 */
	GraphiteEnabled interface{} `yaml:"graphite_enabled,omitempty"`

	/*Http - Descr: TCP port Health Monitor daemon listens on Default: 25923
	 */
	Http *Http `yaml:"http,omitempty"`

	/*ResurrectorEnabled - Descr: Enable VM resurrector plugin Default: false
	 */
	ResurrectorEnabled interface{} `yaml:"resurrector_enabled,omitempty"`

	/*Datadog - Descr: API Key for DataDog Default: <nil>
	 */
	Datadog *Datadog `yaml:"datadog,omitempty"`

	/*SyslogEventForwarderEnabled - Descr: Enable syslog forwarder plugin Default: false
	 */
	SyslogEventForwarderEnabled interface{} `yaml:"syslog_event_forwarder_enabled,omitempty"`

	/*TsdbEnabled - Descr: Enable TSDB plugin Default: false
	 */
	TsdbEnabled interface{} `yaml:"tsdb_enabled,omitempty"`

	/*Pagerduty - Descr: HTTP proxy to connect to PagerDuty (optional) Default: <nil>
	 */
	Pagerduty *Pagerduty `yaml:"pagerduty,omitempty"`

	/*DirectorAccount - Descr: UAA client secret to access Bosh Director Default:
	 */
	DirectorAccount *DirectorAccount `yaml:"director_account,omitempty"`

	/*Smtp - Descr: Port of the SMTP server to connect to (e.g. 25, 465, or 587) Default: <nil>
	 */
	Smtp *Smtp `yaml:"smtp,omitempty"`

	/*PagerdutyEnabled - Descr: Enable PagerDuty plugin Default: false
	 */
	PagerdutyEnabled interface{} `yaml:"pagerduty_enabled,omitempty"`

	/*EmailNotifications - Descr: Enable email notifications plugin Default: false
	 */
	EmailNotifications interface{} `yaml:"email_notifications,omitempty"`

	/*Graphite - Descr: Graphite port Default: <nil>
	 */
	Graphite *Graphite `yaml:"graphite,omitempty"`

	/*ConsulEventForwarder - Descr: A ttl time for ttl checks, if set ttl checks will be used Default: <nil>
	 */
	ConsulEventForwarder *ConsulEventForwarder `yaml:"consul_event_forwarder,omitempty"`

	/*SyslogEventForwarder - Descr: Custom rule for syslog event forwarder Default:
	 */
	SyslogEventForwarder *SyslogEventForwarder `yaml:"syslog_event_forwarder,omitempty"`

	/*Intervals - Descr: Interval (in seconds) to analyze the status of agents Default: 60
	 */
	Intervals *Intervals `yaml:"intervals,omitempty"`

	/*ConsulEventForwarderEnabled - Descr: Enable Consul Plugin Default: false
	 */
	ConsulEventForwarderEnabled interface{} `yaml:"consul_event_forwarder_enabled,omitempty"`

	/*EmailInterval - Descr: Interval (in seconds) to deliver alerts by email (optional) Default: <nil>
	 */
	EmailInterval interface{} `yaml:"email_interval,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Http

type Http struct {

	/*Port - Descr: TCP port Health Monitor daemon listens on Default: 25923
	 */
	Port interface{} `yaml:"port,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Intervals

type Intervals struct {

	/*PruneEvents - Descr: Interval (in seconds) to prune received events Default: 30
	 */
	PruneEvents interface{} `yaml:"prune_events,omitempty"`

	/*AgentTimeout - Descr: Interval (in seconds) to consider an agent has timed out Default: 60
	 */
	AgentTimeout interface{} `yaml:"agent_timeout,omitempty"`

	/*RogueAgentAlert - Descr: Interval (in seconds) to consider an agent as rogue (an agent that is no part of any deployment) Default: 120
	 */
	RogueAgentAlert interface{} `yaml:"rogue_agent_alert,omitempty"`

	/*LogStats - Descr: Interval (in seconds) to log Health Monitor statistics Default: 60
	 */
	LogStats interface{} `yaml:"log_stats,omitempty"`

	/*PollDirector - Descr: Interval (in seconds) to get the list of managed VMs from Bosh Director Default: 60
	 */
	PollDirector interface{} `yaml:"poll_director,omitempty"`

	/*PollGracePeriod - Descr: Interval (in seconds) between discovering managed VMs and analyzing their status Default: 30
	 */
	PollGracePeriod interface{} `yaml:"poll_grace_period,omitempty"`

	/*AnalyzeAgents - Descr: Interval (in seconds) to analyze the status of agents Default: 60
	 */
	AnalyzeAgents interface{} `yaml:"analyze_agents,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Nats

type Nats struct {

	/*Password - Descr: Password for NATS message bus connection Default: <nil>
	 */
	Password interface{} `yaml:"password,omitempty"`

	/*Address - Descr: Address of the NATS message bus to connect to Default: <nil>
	 */
	Address interface{} `yaml:"address,omitempty"`

	/*User - Descr: User for the NATS message bus connection Default: <nil>
	 */
	User interface{} `yaml:"user,omitempty"`

	/*Port - Descr: Port of the NATS message bus port to connect to Default: 4222
	 */
	Port interface{} `yaml:"port,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Pagerduty

type Pagerduty struct {

	/*ServiceKey - Descr: PagerDuty service API key Default: <nil>
	 */
	ServiceKey interface{} `yaml:"service_key,omitempty"`

	/*HttpProxy - Descr: HTTP proxy to connect to PagerDuty (optional) Default: <nil>
	 */
	HttpProxy interface{} `yaml:"http_proxy,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Resurrector

type Resurrector struct {

	/*PercentThreshold - Descr: Percentage of total jobs in a deployment that must be down for the resurrector to to stop sending recreate-job requests. Used in 'meltdown' situations so resurrector will not try to recreate the world. Default: 0.2
	 */
	PercentThreshold interface{} `yaml:"percent_threshold,omitempty"`

	/*MinimumDownJobs - Descr: If the total number of down jobs in a deployment is below this threshold, the resurrector will always request a down job be recreated Default: 5
	 */
	MinimumDownJobs interface{} `yaml:"minimum_down_jobs,omitempty"`

	/*TimeThreshold - Descr: Time (in seconds) for which an alert in the resurrector is considered 'current'; alerts older than this are ignored when deciding to recreate a job. Default: 600
	 */
	TimeThreshold interface{} `yaml:"time_threshold,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Smtp

type Smtp struct {

	/*Password - Descr: Password for SMTP Authentication (optional, use in conjuction with hm.smtp.auth) Default: <nil>
	 */
	Password interface{} `yaml:"password,omitempty"`

	/*Port - Descr: Port of the SMTP server to connect to (e.g. 25, 465, or 587) Default: <nil>
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*Auth - Descr: SMTP Authentication type (optional, only "plain" is supported) Default: <nil>
	 */
	Auth interface{} `yaml:"auth,omitempty"`

	/*User - Descr: User for SMTP Authentication (optional, use in conjuction with hm.smtp.auth) Default: <nil>
	 */
	User interface{} `yaml:"user,omitempty"`

	/*Domain - Descr: SMTP EHLO domain (typically server's fully qualified domain name, e.g. "bosh.cfapps.io") Default: <nil>
	 */
	Domain interface{} `yaml:"domain,omitempty"`

	/*Tls - Descr: Use STARTTLS (optional) Default: <nil>
	 */
	Tls interface{} `yaml:"tls,omitempty"`

	/*From - Descr: Email of sender, e.g. "bosh-director@cfapps.io" Default: <nil>
	 */
	From interface{} `yaml:"from,omitempty"`

	/*Host - Descr: Address of the SMTP server to connect to (e.g. "smtp.gmail.com") Default: <nil>
	 */
	Host interface{} `yaml:"host,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type SyslogEventForwarder

type SyslogEventForwarder struct {

	/*Address - Descr: IP address of the syslog drain Default: <nil>
	 */
	Address interface{} `yaml:"address,omitempty"`

	/*Port - Descr: Port of the syslog drain Default: 5514
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*Transport - Descr: One of ["udp", "tcp", "relp"] Default: tcp
	 */
	Transport interface{} `yaml:"transport,omitempty"`

	/*CustomRule - Descr: Custom rule for syslog event forwarder Default:
	 */
	CustomRule interface{} `yaml:"custom_rule,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Tsdb

type Tsdb struct {

	/*Address - Descr: Address of TSDB to connect to Default: <nil>
	 */
	Address interface{} `yaml:"address,omitempty"`

	/*Port - Descr: Port of TSDB to connect to Default: <nil>
	 */
	Port interface{} `yaml:"port,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!