case class CustomHttpEndpointAlert(checkIntervalMinutes: Option[CheckIntervalMinutes] = None, checkName: String, componentName: String, cronCheckSchedule: String, environmentsEnabled: EnvironmentsEnabled, expectedHttpStatusCode: Option[Int] = None, expectedStringInResponse: Option[String] = None, httpEndpoint: String, integrations: Seq[String], pendingPeriodMinutes: Option[Int] = None, queryTimeRangeMinutes: TimeRangeAsMinutes = TimeRangeAsMinutes.ONE_HOUR, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String) extends CustomAlert with Product with Serializable
This alert will notify when it fails to receive the expected response (status code and/or string pattern) from the given endpoint
- checkIntervalMinutes
Number of minutes between each check. See CheckIntervalMinutes for supported values
- checkName
Name to be used in the metric path. Only lowercase letters and - are allowed:
^[a-z-]+$- componentName
The name of the component you are testing. e.g. jira / proxy / sensu / mongo. Only lowercase letters and - are allowed:
^[a-z-]+$- cronCheckSchedule
The cron schedule for how often the endpoint will be checked creating a metric data point.
- environmentsEnabled
The specific environments to enable this alert in
- expectedHttpStatusCode
The HTTP status code expected from the endpoint.
- expectedStringInResponse
A substring that is expect in the endpoint's response.
- httpEndpoint
The HTTP endpoint to be checked.
- integrations
Which PagerDuty integrations to direct this alert to
- pendingPeriodMinutes
Amount of time in minutes that a threshold needs to be breached before the alert fires
- queryTimeRangeMinutes
The sample period to check data for. If you set it to FIVE_MINUTES, the alert check will evaluate data starting from 6 minutes ago until one minute ago (so that only fully shipped metrics are evaluated).
- runbookUrl
Runbook for when this alert fires
- severity
The severity level of the alert (critical or warning). Defaults to critical.
- summary
The description to populate in PagerDuty when the alert fires
- teamName
All alerts are prefixed with the team name
- Annotations
- @JsonFilter()
- Alphabetic
- By Inheritance
- CustomHttpEndpointAlert
- Serializable
- Product
- Equals
- CustomAlert
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CustomHttpEndpointAlert(checkIntervalMinutes: Option[CheckIntervalMinutes] = None, checkName: String, componentName: String, cronCheckSchedule: String, environmentsEnabled: EnvironmentsEnabled, expectedHttpStatusCode: Option[Int] = None, expectedStringInResponse: Option[String] = None, httpEndpoint: String, integrations: Seq[String], pendingPeriodMinutes: Option[Int] = None, queryTimeRangeMinutes: TimeRangeAsMinutes = TimeRangeAsMinutes.ONE_HOUR, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String)
- checkIntervalMinutes
Number of minutes between each check. See CheckIntervalMinutes for supported values
- checkName
Name to be used in the metric path. Only lowercase letters and - are allowed:
^[a-z-]+$- componentName
The name of the component you are testing. e.g. jira / proxy / sensu / mongo. Only lowercase letters and - are allowed:
^[a-z-]+$- cronCheckSchedule
The cron schedule for how often the endpoint will be checked creating a metric data point.
- environmentsEnabled
The specific environments to enable this alert in
- expectedHttpStatusCode
The HTTP status code expected from the endpoint.
- expectedStringInResponse
A substring that is expect in the endpoint's response.
- httpEndpoint
The HTTP endpoint to be checked.
- integrations
Which PagerDuty integrations to direct this alert to
- pendingPeriodMinutes
Amount of time in minutes that a threshold needs to be breached before the alert fires
- queryTimeRangeMinutes
The sample period to check data for. If you set it to FIVE_MINUTES, the alert check will evaluate data starting from 6 minutes ago until one minute ago (so that only fully shipped metrics are evaluated).
- runbookUrl
Runbook for when this alert fires
- severity
The severity level of the alert (critical or warning). Defaults to critical.
- summary
The description to populate in PagerDuty when the alert fires
- teamName
All alerts are prefixed with the team name
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val checkIntervalMinutes: Option[CheckIntervalMinutes]
- val checkName: String
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- val componentName: String
- val cronCheckSchedule: String
- val environmentsEnabled: EnvironmentsEnabled
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val expectedHttpStatusCode: Option[Int]
- val expectedStringInResponse: Option[String]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val httpEndpoint: String
- val integrations: Seq[String]
- Definition Classes
- CustomHttpEndpointAlert → CustomAlert
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val pendingPeriodMinutes: Option[Int]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val queryTimeRangeMinutes: TimeRangeAsMinutes
- val runbookUrl: Option[String]
- val severity: CustomAlertSeverity.AlertSeverity
- Definition Classes
- CustomHttpEndpointAlert → CustomAlert
- val summary: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val teamName: String
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)