The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Cloud Monitoring. An alerting policy is 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. In addition to using this API, alert policies can also be managed through [Cloud Monitoring](https://cloud.google.com/monitoring/docs/), which can be reached by clicking the "Monitoring" tab in [Cloud console](https://console.cloud.google.com/). v3

v3.GroupServiceClient

The Group API lets you inspect and manage your [groups](#google.monitoring.v3.Group).

A group is a named filter that is used to identify a collection of monitored resources. Groups are typically used to mirror the physical and/or logical topology of the environment. Because group membership is computed dynamically, monitored resources that are started in the future are automatically placed in matching groups. By using a group to name monitored resources in, for example, an alert policy, the target of that alert policy is updated automatically as monitored resources are added and removed from the infrastructure. v3

v3.MetricServiceClient

Manages metric descriptors, monitored resource descriptors, and time series data. v3

v3.NotificationChannelServiceClient

The Notification Channel API provides access to configuration that controls how messages related to incidents are sent. v3

v3.QueryServiceClient

The QueryService API is used to manage time series data in Cloud Monitoring. Time series data is a collection of data points that describes the time-varying values of a metric. v3

v3.ServiceMonitoringServiceClient

The Cloud Monitoring Service-Oriented Monitoring API has endpoints for managing and querying aspects of a Metrics Scope's services. These include the Service's monitored resources, its Service-Level Objectives, and a taxonomy of categorized Health Metrics. v3

v3.SnoozeServiceClient

The SnoozeService API is used to temporarily prevent an alert policy from generating alerts. A Snooze is a description of the criteria under which one or more alert policies should not fire alerts for the specified duration. v3

v3.UptimeCheckServiceClient

The UptimeCheckService API is used to manage (list, create, delete, edit) Uptime check configurations in the Cloud Monitoring product. An Uptime check is a piece of configuration that determines which resources and services to monitor for availability. These configurations can also be configured interactively by navigating to the [Cloud console] (https://console.cloud.google.com), selecting the appropriate project, clicking on "Monitoring" on the left-hand side to navigate to Cloud Monitoring, and then clicking on "Uptime". v3

Variables

_default

_default: {
    v3: typeof v3;
    AlertPolicyServiceClient: typeof v3.AlertPolicyServiceClient;
    GroupServiceClient: typeof v3.GroupServiceClient;
    MetricServiceClient: typeof v3.MetricServiceClient;
    NotificationChannelServiceClient: typeof v3.NotificationChannelServiceClient;
    QueryServiceClient: typeof v3.QueryServiceClient;
    ServiceMonitoringServiceClient: typeof v3.ServiceMonitoringServiceClient;
    SnoozeServiceClient: typeof v3.SnoozeServiceClient;
    UptimeCheckServiceClient: typeof v3.UptimeCheckServiceClient;
}

AlertPolicyServiceClient

AlertPolicyServiceClient: typeof v3.AlertPolicyServiceClient

GroupServiceClient

GroupServiceClient: typeof v3.GroupServiceClient

MetricServiceClient

MetricServiceClient: typeof v3.MetricServiceClient

NotificationChannelServiceClient

NotificationChannelServiceClient: typeof v3.NotificationChannelServiceClient

QueryServiceClient

QueryServiceClient: typeof v3.QueryServiceClient

ServiceMonitoringServiceClient

ServiceMonitoringServiceClient: typeof v3.ServiceMonitoringServiceClient

SnoozeServiceClient

SnoozeServiceClient: typeof v3.SnoozeServiceClient

UptimeCheckServiceClient

UptimeCheckServiceClient: typeof v3.UptimeCheckServiceClient

Type Aliases

AlertPolicyServiceClient

type AlertPolicyServiceClient = v3.AlertPolicyServiceClient;

GroupServiceClient

type GroupServiceClient = v3.GroupServiceClient;

MetricServiceClient

type MetricServiceClient = v3.MetricServiceClient;

NotificationChannelServiceClient

type NotificationChannelServiceClient = v3.NotificationChannelServiceClient;

protos.google.monitoring.v3.AlertPolicyService.CreateAlertPolicyCallback

type CreateAlertPolicyCallback = (error: (Error|null), response?: google.monitoring.v3.AlertPolicy) => void;

Callback as used by .

protos.google.monitoring.v3.AlertPolicyService.DeleteAlertPolicyCallback

type DeleteAlertPolicyCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.monitoring.v3.AlertPolicyService.GetAlertPolicyCallback

type GetAlertPolicyCallback = (error: (Error|null), response?: google.monitoring.v3.AlertPolicy) => void;

Callback as used by .

protos.google.monitoring.v3.AlertPolicyService.ListAlertPoliciesCallback

type ListAlertPoliciesCallback = (error: (Error|null), response?: google.monitoring.v3.ListAlertPoliciesResponse) => void;

Callback as used by .

protos.google.monitoring.v3.AlertPolicyService.UpdateAlertPolicyCallback

type UpdateAlertPolicyCallback = (error: (Error|null), response?: google.monitoring.v3.AlertPolicy) => void;

Callback as used by .

protos.google.monitoring.v3.GroupService.CreateGroupCallback

type CreateGroupCallback = (error: (Error|null), response?: google.monitoring.v3.Group) => void;

Callback as used by .

protos.google.monitoring.v3.GroupService.DeleteGroupCallback

type DeleteGroupCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.monitoring.v3.GroupService.GetGroupCallback

type GetGroupCallback = (error: (Error|null), response?: google.monitoring.v3.Group) => void;

Callback as used by .

protos.google.monitoring.v3.GroupService.ListGroupMembersCallback

type ListGroupMembersCallback = (error: (Error|null), response?: google.monitoring.v3.ListGroupMembersResponse) => void;

Callback as used by .

protos.google.monitoring.v3.GroupService.ListGroupsCallback

type ListGroupsCallback = (error: (Error|null), response?: google.monitoring.v3.ListGroupsResponse) => void;

Callback as used by .

protos.google.monitoring.v3.GroupService.UpdateGroupCallback

type UpdateGroupCallback = (error: (Error|null), response?: google.monitoring.v3.Group) => void;

Callback as used by .

protos.google.monitoring.v3.MetricService.CreateMetricDescriptorCallback

type CreateMetricDescriptorCallback = (error: (Error|null), response?: google.api.MetricDescriptor) => void;

Callback as used by .

protos.google.monitoring.v3.MetricService.CreateServiceTimeSeriesCallback

type CreateServiceTimeSeriesCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.monitoring.v3.MetricService.CreateTimeSeriesCallback

type CreateTimeSeriesCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.monitoring.v3.MetricService.DeleteMetricDescriptorCallback

type DeleteMetricDescriptorCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.monitoring.v3.MetricService.GetMetricDescriptorCallback

type GetMetricDescriptorCallback = (error: (Error|null), response?: google.api.MetricDescriptor) => void;

Callback as used by .

protos.google.monitoring.v3.MetricService.GetMonitoredResourceDescriptorCallback

type GetMonitoredResourceDescriptorCallback = (error: (Error|null), response?: google.api.MonitoredResourceDescriptor) => void;

Callback as used by .

protos.google.monitoring.v3.MetricService.ListMetricDescriptorsCallback

type ListMetricDescriptorsCallback = (error: (Error|null), response?: google.monitoring.v3.ListMetricDescriptorsResponse) => void;

Callback as used by .

protos.google.monitoring.v3.MetricService.ListMonitoredResourceDescriptorsCallback

type ListMonitoredResourceDescriptorsCallback = (error: (Error|null), response?: google.monitoring.v3.ListMonitoredResourceDescriptorsResponse) => void;

Callback as used by .

protos.google.monitoring.v3.MetricService.ListTimeSeriesCallback

type ListTimeSeriesCallback = (error: (Error|null), response?: google.monitoring.v3.ListTimeSeriesResponse) => void;

Callback as used by .

protos.google.monitoring.v3.NotificationChannelService.CreateNotificationChannelCallback

type CreateNotificationChannelCallback = (error: (Error|null), response?: google.monitoring.v3.NotificationChannel) => void;

Callback as used by .

protos.google.monitoring.v3.NotificationChannelService.DeleteNotificationChannelCallback

type DeleteNotificationChannelCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.monitoring.v3.NotificationChannelService.GetNotificationChannelCallback

type GetNotificationChannelCallback = (error: (Error|null), response?: google.monitoring.v3.NotificationChannel) => void;

Callback as used by .

protos.google.monitoring.v3.NotificationChannelService.GetNotificationChannelDescriptorCallback

type GetNotificationChannelDescriptorCallback = (error: (Error|null), response?: google.monitoring.v3.NotificationChannelDescriptor) => void;

Callback as used by .

protos.google.monitoring.v3.NotificationChannelService.GetNotificationChannelVerificationCodeCallback

type GetNotificationChannelVerificationCodeCallback = (error: (Error|null), response?: google.monitoring.v3.GetNotificationChannelVerificationCodeResponse) => void;

Callback as used by .

protos.google.monitoring.v3.NotificationChannelService.ListNotificationChannelDescriptorsCallback

type ListNotificationChannelDescriptorsCallback = (error: (Error|null), response?: google.monitoring.v3.ListNotificationChannelDescriptorsResponse) => void;

Callback as used by .

protos.google.monitoring.v3.NotificationChannelService.ListNotificationChannelsCallback

type ListNotificationChannelsCallback = (error: (Error|null), response?: google.monitoring.v3.ListNotificationChannelsResponse) => void;

Callback as used by .

protos.google.monitoring.v3.NotificationChannelService.SendNotificationChannelVerificationCodeCallback

type SendNotificationChannelVerificationCodeCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.monitoring.v3.NotificationChannelService.UpdateNotificationChannelCallback

type UpdateNotificationChannelCallback = (error: (Error|null), response?: google.monitoring.v3.NotificationChannel) => void;

Callback as used by .

protos.google.monitoring.v3.NotificationChannelService.VerifyNotificationChannelCallback

type VerifyNotificationChannelCallback = (error: (Error|null), response?: google.monitoring.v3.NotificationChannel) => void;

Callback as used by .

protos.google.monitoring.v3.QueryService.QueryTimeSeriesCallback

type QueryTimeSeriesCallback = (error: (Error|null), response?: google.monitoring.v3.QueryTimeSeriesResponse) => void;

Callback as used by .

protos.google.monitoring.v3.ServiceMonitoringService.CreateServiceCallback

type CreateServiceCallback = (error: (Error|null), response?: google.monitoring.v3.Service) => void;

Callback as used by .

protos.google.monitoring.v3.ServiceMonitoringService.CreateServiceLevelObjectiveCallback

type CreateServiceLevelObjectiveCallback = (error: (Error|null), response?: google.monitoring.v3.ServiceLevelObjective) => void;

Callback as used by .

protos.google.monitoring.v3.ServiceMonitoringService.DeleteServiceCallback

type DeleteServiceCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.monitoring.v3.ServiceMonitoringService.DeleteServiceLevelObjectiveCallback

type DeleteServiceLevelObjectiveCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.monitoring.v3.ServiceMonitoringService.GetServiceCallback

type GetServiceCallback = (error: (Error|null), response?: google.monitoring.v3.Service) => void;

Callback as used by .

protos.google.monitoring.v3.ServiceMonitoringService.GetServiceLevelObjectiveCallback

type GetServiceLevelObjectiveCallback = (error: (Error|null), response?: google.monitoring.v3.ServiceLevelObjective) => void;

Callback as used by .

protos.google.monitoring.v3.ServiceMonitoringService.ListServiceLevelObjectivesCallback

type ListServiceLevelObjectivesCallback = (error: (Error|null), response?: google.monitoring.v3.ListServiceLevelObjectivesResponse) => void;

Callback as used by .

protos.google.monitoring.v3.ServiceMonitoringService.ListServicesCallback

type ListServicesCallback = (error: (Error|null), response?: google.monitoring.v3.ListServicesResponse) => void;

Callback as used by .

protos.google.monitoring.v3.ServiceMonitoringService.UpdateServiceCallback

type UpdateServiceCallback = (error: (Error|null), response?: google.monitoring.v3.Service) => void;

Callback as used by .

protos.google.monitoring.v3.ServiceMonitoringService.UpdateServiceLevelObjectiveCallback

type UpdateServiceLevelObjectiveCallback = (error: (Error|null), response?: google.monitoring.v3.ServiceLevelObjective) => void;

Callback as used by .

protos.google.monitoring.v3.SnoozeService.CreateSnoozeCallback

type CreateSnoozeCallback = (error: (Error|null), response?: google.monitoring.v3.Snooze) => void;

Callback as used by .

protos.google.monitoring.v3.SnoozeService.GetSnoozeCallback

type GetSnoozeCallback = (error: (Error|null), response?: google.monitoring.v3.Snooze) => void;

Callback as used by .

protos.google.monitoring.v3.SnoozeService.ListSnoozesCallback

type ListSnoozesCallback = (error: (Error|null), response?: google.monitoring.v3.ListSnoozesResponse) => void;

Callback as used by .

protos.google.monitoring.v3.SnoozeService.UpdateSnoozeCallback

type UpdateSnoozeCallback = (error: (Error|null), response?: google.monitoring.v3.Snooze) => void;

Callback as used by .

protos.google.monitoring.v3.UptimeCheckService.CreateUptimeCheckConfigCallback

type CreateUptimeCheckConfigCallback = (error: (Error|null), response?: google.monitoring.v3.UptimeCheckConfig) => void;

Callback as used by .

protos.google.monitoring.v3.UptimeCheckService.DeleteUptimeCheckConfigCallback

type DeleteUptimeCheckConfigCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;

Callback as used by .

protos.google.monitoring.v3.UptimeCheckService.GetUptimeCheckConfigCallback

type GetUptimeCheckConfigCallback = (error: (Error|null), response?: google.monitoring.v3.UptimeCheckConfig) => void;

Callback as used by .

protos.google.monitoring.v3.UptimeCheckService.ListUptimeCheckConfigsCallback

type ListUptimeCheckConfigsCallback = (error: (Error|null), response?: google.monitoring.v3.ListUptimeCheckConfigsResponse) => void;

Callback as used by .

protos.google.monitoring.v3.UptimeCheckService.ListUptimeCheckIpsCallback

type ListUptimeCheckIpsCallback = (error: (Error|null), response?: google.monitoring.v3.ListUptimeCheckIpsResponse) => void;

Callback as used by .

protos.google.monitoring.v3.UptimeCheckService.UpdateUptimeCheckConfigCallback

type UpdateUptimeCheckConfigCallback = (error: (Error|null), response?: google.monitoring.v3.UptimeCheckConfig) => void;

Callback as used by .

QueryServiceClient

type QueryServiceClient = v3.QueryServiceClient;

ServiceMonitoringServiceClient

type ServiceMonitoringServiceClient = v3.ServiceMonitoringServiceClient;

SnoozeServiceClient

type SnoozeServiceClient = v3.SnoozeServiceClient;

UptimeCheckServiceClient

type UptimeCheckServiceClient = v3.UptimeCheckServiceClient;

Package @google-cloud/monitoring (5.2.0) Stay organized with collections Save and categorize content based on your preferences.

Classes

Package @google-cloud/monitoring (5.2.0)