|
2715 | 2715 | } |
2716 | 2716 | } |
2717 | 2717 | }, |
2718 | | - "revision": "20240929", |
| 2718 | + "revision": "20241003", |
2719 | 2719 | "rootUrl": "https://monitoring.googleapis.com/", |
2720 | 2720 | "schemas": { |
2721 | 2721 | "Aggregation": { |
|
2820 | 2820 | "type": "object" |
2821 | 2821 | }, |
2822 | 2822 | "AlertPolicy": { |
2823 | | - "description": "A description of the conditions under which some aspect of your system is considered to be \"unhealthy\" and the ways to notify people or services about this state. For an overview of alert policies, see Introduction to Alerting (https://cloud.google.com/monitoring/alerts/).", |
| 2823 | + "description": "A description of the conditions under which some aspect of your system is considered to be \"unhealthy\" and the ways to notify people or services about this state. For an overview of alerting policies, see Introduction to Alerting (https://cloud.google.com/monitoring/alerts/).", |
2824 | 2824 | "id": "AlertPolicy", |
2825 | 2825 | "properties": { |
2826 | 2826 | "alertStrategy": { |
2827 | 2827 | "$ref": "AlertStrategy", |
2828 | | - "description": "Control over how this alert policy's notification channels are notified." |
| 2828 | + "description": "Control over how this alerting policy's notification channels are notified." |
2829 | 2829 | }, |
2830 | 2830 | "combiner": { |
2831 | 2831 | "description": "How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.", |
|
2882 | 2882 | "type": "array" |
2883 | 2883 | }, |
2884 | 2884 | "severity": { |
2885 | | - "description": "Optional. The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications.", |
| 2885 | + "description": "Optional. The severity of an alerting policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications.", |
2886 | 2886 | "enum": [ |
2887 | 2887 | "SEVERITY_UNSPECIFIED", |
2888 | 2888 | "CRITICAL", |
|
2906 | 2906 | }, |
2907 | 2907 | "validity": { |
2908 | 2908 | "$ref": "Status", |
2909 | | - "description": "Read-only description of how the alert policy is invalid. This field is only set when the alert policy is invalid. An invalid alert policy will not generate incidents." |
| 2909 | + "description": "Read-only description of how the alerting policy is invalid. This field is only set when the alerting policy is invalid. An invalid alerting policy will not generate incidents." |
2910 | 2910 | } |
2911 | 2911 | }, |
2912 | 2912 | "type": "object" |
|
2916 | 2916 | "id": "AlertStrategy", |
2917 | 2917 | "properties": { |
2918 | 2918 | "autoClose": { |
2919 | | - "description": "If an alert policy that was active has no data for this long, any open incidents will close", |
| 2919 | + "description": "If an alerting policy that was active has no data for this long, any open incidents will close", |
2920 | 2920 | "format": "google-duration", |
2921 | 2921 | "type": "string" |
2922 | 2922 | }, |
|
2927 | 2927 | }, |
2928 | 2928 | "type": "array" |
2929 | 2929 | }, |
| 2930 | + "notificationPrompts": { |
| 2931 | + "description": "For log-based alert policies, the notification prompts is always OPENED. For non log-based alert policies, the notification prompts can be OPENED or OPENED, CLOSED.", |
| 2932 | + "items": { |
| 2933 | + "enum": [ |
| 2934 | + "NOTIFICATION_PROMPT_UNSPECIFIED", |
| 2935 | + "OPENED", |
| 2936 | + "CLOSED" |
| 2937 | + ], |
| 2938 | + "enumDescriptions": [ |
| 2939 | + "No strategy specified. Treated as error.", |
| 2940 | + "Notify when an incident is opened.", |
| 2941 | + "Notify when an incident is closed." |
| 2942 | + ], |
| 2943 | + "type": "string" |
| 2944 | + }, |
| 2945 | + "type": "array" |
| 2946 | + }, |
2930 | 2947 | "notificationRateLimit": { |
2931 | 2948 | "$ref": "NotificationRateLimit", |
2932 | | - "description": "Required for log-based alert policies, i.e. policies with a LogMatch condition.This limit is not implemented for alert policies that do not have a LogMatch condition." |
| 2949 | + "description": "Required for log-based alerting policies, i.e. policies with a LogMatch condition.This limit is not implemented for alerting policies that do not have a LogMatch condition." |
2933 | 2950 | } |
2934 | 2951 | }, |
2935 | 2952 | "type": "object" |
|
3256 | 3273 | }, |
3257 | 3274 | "conditionSql": { |
3258 | 3275 | "$ref": "SqlCondition", |
3259 | | - "description": "A condition that uses SQL to define alerts in Logs Analytics." |
| 3276 | + "description": "A condition that periodically evaluates a SQL query result." |
3260 | 3277 | }, |
3261 | 3278 | "conditionThreshold": { |
3262 | 3279 | "$ref": "MetricThreshold", |
|
3417 | 3434 | "description": "Optional. The time of day (in UTC) at which the query should run. If left unspecified, the server picks an arbitrary time of day and runs the query at the same time each day." |
3418 | 3435 | }, |
3419 | 3436 | "periodicity": { |
3420 | | - "description": "Required. LINT.IfChange The number of days between runs. Must be greater than or equal to 1 day and less than or equal to 31 days. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc)", |
| 3437 | + "description": "Required. The number of days between runs. Must be greater than or equal to 1 day and less than or equal to 31 days.", |
3421 | 3438 | "format": "int32", |
3422 | 3439 | "type": "integer" |
3423 | 3440 | } |
|
3890 | 3907 | "id": "Hourly", |
3891 | 3908 | "properties": { |
3892 | 3909 | "minuteOffset": { |
3893 | | - "description": "Optional. LINT.IfChange The number of minutes after the hour (in UTC) to run the query. Must be between 0 and 59 inclusive. If left unspecified, then an arbitrary offset is used. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc)", |
| 3910 | + "description": "Optional. The number of minutes after the hour (in UTC) to run the query. Must be greater than or equal to 0 minutes and less than or equal to 59 minutes. If left unspecified, then an arbitrary offset is used.", |
3894 | 3911 | "format": "int32", |
3895 | 3912 | "type": "integer" |
3896 | 3913 | }, |
3897 | 3914 | "periodicity": { |
3898 | | - "description": "Required. LINT.IfChange The number of hours between runs. Must be greater than or equal to 1 hour and less than or equal to 48 hours. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc)", |
| 3915 | + "description": "Required. The number of hours between runs. Must be greater than or equal to 1 hour and less than or equal to 48 hours.", |
3899 | 3916 | "format": "int32", |
3900 | 3917 | "type": "integer" |
3901 | 3918 | } |
|
4797 | 4814 | "id": "Minutes", |
4798 | 4815 | "properties": { |
4799 | 4816 | "periodicity": { |
4800 | | - "description": "Required. LINT.IfChange Number of minutes between runs. The interval must be between 5 minutes and 1440 minutes. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc)", |
| 4817 | + "description": "Required. Number of minutes between runs. The interval must be greater than or equal to 5 minutes and less than or equal to 1440 minutes.", |
4801 | 4818 | "format": "int32", |
4802 | 4819 | "type": "integer" |
4803 | 4820 | } |
|
4899 | 4916 | "type": "object" |
4900 | 4917 | }, |
4901 | 4918 | "MonitoringQueryLanguageCondition": { |
4902 | | - "description": "A condition type that allows alert policies to be defined using Monitoring Query Language (https://cloud.google.com/monitoring/mql).", |
| 4919 | + "description": "A condition type that allows alerting policies to be defined using Monitoring Query Language (https://cloud.google.com/monitoring/mql).", |
4903 | 4920 | "id": "MonitoringQueryLanguageCondition", |
4904 | 4921 | "properties": { |
4905 | 4922 | "duration": { |
|
5108 | 5125 | "type": "object" |
5109 | 5126 | }, |
5110 | 5127 | "NotificationRateLimit": { |
5111 | | - "description": "Control over the rate of notifications sent to this alert policy's notification channels.", |
| 5128 | + "description": "Control over the rate of notifications sent to this alerting policy's notification channels.", |
5112 | 5129 | "id": "NotificationRateLimit", |
5113 | 5130 | "properties": { |
5114 | 5131 | "period": { |
|
5239 | 5256 | "type": "object" |
5240 | 5257 | }, |
5241 | 5258 | "PrometheusQueryLanguageCondition": { |
5242 | | - "description": "A condition type that allows alert policies to be defined using Prometheus Query Language (PromQL) (https://prometheus.io/docs/prometheus/latest/querying/basics/).The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.A Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/). The semantics of a Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule).A Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). The semantics of a Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group).Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26).", |
| 5259 | + "description": "A condition type that allows alerting policies to be defined using Prometheus Query Language (PromQL) (https://prometheus.io/docs/prometheus/latest/querying/basics/).The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.A Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/). The semantics of a Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule).A Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). The semantics of a Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group).Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26).", |
5243 | 5260 | "id": "PrometheusQueryLanguageCondition", |
5244 | 5261 | "properties": { |
5245 | 5262 | "alertRule": { |
|
5670 | 5687 | "type": "object" |
5671 | 5688 | }, |
5672 | 5689 | "SqlCondition": { |
5673 | | - "description": "A condition that allows alert policies to be defined using GoogleSQL. SQL conditions examine a sliding window of logs using GoogleSQL. Alert policies with SQL conditions may incur additional billing.", |
| 5690 | + "description": "A condition that allows alerting policies to be defined using GoogleSQL. SQL conditions examine a sliding window of logs using GoogleSQL. Alert policies with SQL conditions may incur additional billing.", |
5674 | 5691 | "id": "SqlCondition", |
5675 | 5692 | "properties": { |
5676 | 5693 | "booleanTest": { |
|
5690 | 5707 | "description": "Schedule the query to execute every so many minutes." |
5691 | 5708 | }, |
5692 | 5709 | "query": { |
5693 | | - "description": "Required. The Log Analytics SQL query to run, as a string. The query must conform to the required shape. Specifically, the query must not try to filter the input by time. A filter will automatically be applied to filter the input so that the query receives all rows received since the last time the query was run.E.g. Extract all log entries containing an HTTP request:SELECT timestamp, log_name, severity, http_request, resource, labels FROM my-project.global._Default._AllLogs WHERE http_request IS NOT NULL", |
| 5710 | + "description": "Required. The Log Analytics SQL query to run, as a string. The query must conform to the required shape. Specifically, the query must not try to filter the input by time. A filter will automatically be applied to filter the input so that the query receives all rows received since the last time the query was run.For example, the following query extracts all log entries containing an HTTP request:SELECT timestamp, log_name, severity, http_request, resource, labels FROM my-project.global._Default._AllLogs WHERE http_request IS NOT NULL", |
5694 | 5711 | "type": "string" |
5695 | 5712 | }, |
5696 | 5713 | "rowCountTest": { |
|
5787 | 5804 | "id": "TimeOfDay", |
5788 | 5805 | "properties": { |
5789 | 5806 | "hours": { |
5790 | | - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", |
| 5807 | + "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", |
5791 | 5808 | "format": "int32", |
5792 | 5809 | "type": "integer" |
5793 | 5810 | }, |
5794 | 5811 | "minutes": { |
5795 | | - "description": "Minutes of hour of day. Must be from 0 to 59.", |
| 5812 | + "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", |
5796 | 5813 | "format": "int32", |
5797 | 5814 | "type": "integer" |
5798 | 5815 | }, |
5799 | 5816 | "nanos": { |
5800 | | - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", |
| 5817 | + "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", |
5801 | 5818 | "format": "int32", |
5802 | 5819 | "type": "integer" |
5803 | 5820 | }, |
5804 | 5821 | "seconds": { |
5805 | | - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", |
| 5822 | + "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", |
5806 | 5823 | "format": "int32", |
5807 | 5824 | "type": "integer" |
5808 | 5825 | } |
|
0 commit comments