Type Members

1.  trait CustomAlert extends AnyRef
2.  trait CustomAlertConfig extends AnyRef
3.  case class CustomAlerts(customElasticsearchAlerts: Seq[CustomElasticsearchAlert], customGraphiteMetricAlerts: Seq[CustomGraphiteMetricAlert], customCloudWatchMetricAlerts: Seq[CustomCloudWatchMetricAlert], customHttpEndpointAlerts: Seq[CustomHttpEndpointAlert]) extends Product with Serializable
4.  case class CustomAlertsTopLevel(alerts: CustomAlerts) extends Product with Serializable
5.  case class CustomCloudWatchMetricAlert(alertName: String, cloudwatchSource: CloudWatchSource, dashboardPanelId: Option[Int], dashboardUri: Option[String], dimensions: Map[String, String], integrations: Seq[String], metricName: String, namespace: String, operator: EvaluationOperator, reducerFunction: ReducerFunction, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String, thresholds: EnvironmentThresholds, statistic: Option[Statistic] = Some(Statistic.MAXIMUM), queryTimeRangeMinutes: TimeRangeAsMinutes = TimeRangeAsMinutes.FIFTEEN_MINUTES) extends CustomAlert with Product with Serializable

   CloudWatch metrics based alert.

   CloudWatch metrics based alert.

   alertName

   Name that the alert will be created with

   cloudwatchSource

   Which CloudWatch Grafana datasource to use

   dashboardPanelId

   Specific panel to deep link to that is specific to this alert

   dashboardUri

   Grafana uri to link to. This should just be the uri path and not include the domain

   dimensions

   Which CloudWatch dimensions to filter the metric on

   integrations

   Which PagerDuty integrations to direct this alert to

   metricName

   Which CloudWatch metric to filter the alert on

   namespace

   Which CloudWatch service namespace to filter the alert on

   operator

   Whether to evaluate the metric as greater than or less than

   reducerFunction

   Function to use to transform multiple data points returned from query into a single value, to be compared against the specified threshold. Valid values include: COUNT, LAST, MAX, MEAN, MIN, SUM. Note: Using the LAST reducer could result in not all data points being considered during alert evaluation, depending on the frequency at which the alert runs. Example: An alert with a LAST reducer, that runs every 2 minutes, based on a metric that is written on a per minute basis, will only consider ~50% of the data points, potentially missing a legitimate breach of an alert threshold.

   runbookUrl

   Runbook for when this alert fires

   severity

   The severity of this alert. E.g. Warning or Critical

   summary

   The description to populate in PagerDuty when the alert fires

   teamName

   All alerts are prefixed with the team name

   thresholds

   Trigger point for each environment

   statistic

   Used in the query. Valid values include Average, Maximum, Minimum, Sum, SampleCount, IQM

   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).

6.  case class CustomElasticsearchAlert(alertName: String, checkIntervalMinutes: CheckIntervalMinutes, kibanaDashboardUri: Option[String], integrations: Seq[String], luceneQuery: String, operator: EvaluationOperator, reducerFunction: ReducerFunction, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, teamName: String, thresholds: EnvironmentThresholds, queryTimeRangeMinutes: TimeRangeAsMinutes = TimeRangeAsMinutes.FIFTEEN_MINUTES) extends CustomAlert with Product with Serializable

   CloudWatch metrics based alert.

   CloudWatch metrics based alert.

   alertName

   Name that the alert will be created with

   checkIntervalMinutes

   Number of minutes between each check. See CheckIntervalMinutes for supported values

   kibanaDashboardUri

   Kibana uri to link to. This should just be the uri path and not include the domain

   integrations

   Which PagerDuty integrations to direct this alert to n

   luceneQuery

   Query to make to Elasticsearch

   operator

   Whether to evaluate the metric as greater than or less than

   reducerFunction

   Function to use to transform multiple data points returned from query into a single value, to be compared against the specified threshold. Valid values include: COUNT, LAST, MAX, MEAN, MIN, SUM. Note: Using the LAST reducer could result in not all data points being considered during alert evaluation, depending on the frequency at which the alert runs. Example: An alert with a LAST reducer, that runs every 2 minutes, based on a metric that is written on a per minute basis, will only consider ~50% of the data points, potentially missing a legitimate breach of an alert threshold.

   runbookUrl

   Runbook for when this alert fires

   severity

   The severity of this alert. E.g. Warning or Critical

   summary

   The description to populate in PagerDuty when the alert fires

   teamName

   All alerts are prefixed with the team name

   thresholds

   Trigger point for each environment

   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).

7.  case class CustomGraphiteMetricAlert(alertName: String, checkIntervalMinutes: Option[CheckIntervalMinutes] = None, pendingPeriodMinutes: Option[Int] = None, dashboardUri: Option[String], dashboardPanelId: Option[Int], integrations: Seq[String], operator: EvaluationOperator, query: String, teamName: String, reducerFunction: ReducerFunction, runbookUrl: Option[String], severity: CustomAlertSeverity.AlertSeverity, summary: String, thresholds: EnvironmentThresholds, queryTimeRangeMinutes: TimeRangeAsMinutes = TimeRangeAsMinutes.FIFTEEN_MINUTES) extends CustomAlert with Product with Serializable

   Graphite metric based alert.

   Graphite metric based alert.

   alertName

   Name that the alert will be created with

   checkIntervalMinutes

   Number of minutes between each check. See CheckIntervalMinutes for supported values

   pendingPeriodMinutes

   Amount of time in minutes that a threshold needs to be breached before the alert fires

   dashboardUri

   Grafana uri to link to. This should just be the uri path and not include the domain

   dashboardPanelId

   Specific panel to deep link to that is specific to this alert

   integrations

   Which PagerDuty integrations to direct this alert to

   operator

   Whether to evaluate the metric as greater than or less than

   query

   Graphite query you're running

   teamName

   All alerts are prefixed with the team name

   reducerFunction

   Function to use to transform multiple data points returned from query into a single value, to be compared against the specified threshold. Valid values include: COUNT, LAST, MAX, MEAN, MIN, SUM. Note: Using the LAST reducer could result in not all data points being considered during alert evaluation, depending on the frequency at which the alert runs. Example: An alert with a LAST reducer, that runs every 2 minutes, based on a metric that is written on a per minute basis, will only consider ~50% of the data points, potentially missing a legitimate breach of an alert threshold.

   runbookUrl

   Runbook for when this alert fires

   severity

   The severity of this alert. E.g. Warning or Critical

   summary

   The description to populate in PagerDuty when the alert fires

   thresholds

   Trigger point for each environment

   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).

8.  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

   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()

9.  case class EnvironmentThresholds(development: Option[Int] = None, externaltest: Option[Int] = None, integration: Option[Int] = None, management: Option[Int] = None, production: Option[Int] = None, qa: Option[Int] = None, staging: Option[Int] = None) extends Product with Serializable

   Define thresholds for any environments you want this custom alert to be active in.

   Define thresholds for any environments you want this custom alert to be active in.

   development

   The threshold for the development environment.

   externaltest

   The threshold for the external test environment.

   integration

   The threshold for the integration environment.

   management

   The threshold for the management environment.

   production

   The threshold for the production environment.

   qa

   The threshold for the quality assurance environment.

   staging

   The threshold for the staging environment.

10.  case class EnvironmentsEnabled(development: Boolean = false, externaltest: Boolean = false, integration: Boolean = false, management: Boolean = false, production: Boolean = false, qa: Boolean = false, staging: Boolean = false) extends Product with Serializable

    Define which environments this alert should be active in

    Define which environments this alert should be active in

    development

    Set to true if alert should be active in the Development environment.

    externaltest

    Set to true if alert should be active in the External Test environment.

    integration

    Set to true if alert should be active in the Integration environment.

    management

    Set to true if alert should be active in the Management environment.

    production

    Set to true if alert should be active in the Production environment.

    qa

    Set to true if alert should be active in the QA environment.

    staging

    Set to true if alert should be active in the Staging environment.