@google-cloud/monitoring - npm Package Compare versions

Comparing version 1.3.0 to 1.4.0

CHANGELOG.md

@@ -7,2 +7,15 @@ # Changelog
 
+## [1.4.0](https://www.github.com/googleapis/nodejs-monitoring/compare/v1.3.0...v1.4.0) (2019-10-12)
+
+
+### Features
+
+* .d.ts for protos ([#298](https://www.github.com/googleapis/nodejs-monitoring/issues/298)) ([dc6e8a1](https://www.github.com/googleapis/nodejs-monitoring/commit/dc6e8a1b82b41638ad873ec35007415f602c8b0b))
+
+
+### Bug Fixes
+
+* update sample for enabling or disabling a policy ([#305](https://www.github.com/googleapis/nodejs-monitoring/issues/305)) ([fd84c71](https://www.github.com/googleapis/nodejs-monitoring/commit/fd84c71ab4511c11963c8480cda70117f78f8651))
+* use compatible version of google-gax ([c210d32](https://www.github.com/googleapis/nodejs-monitoring/commit/c210d320a392fb33e6a6779ae4d727a6970326da))
+
 ## [1.3.0](https://www.github.com/googleapis/nodejs-monitoring/compare/v1.2.3...v1.3.0) (2019-09-16)
@@ -9,0 +22,0 @@

package.json

 {
   "name": "@google-cloud/monitoring",
   "description": "Stackdriver Monitoring API client for Node.js",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "license": "Apache-2.0",
@@ -45,3 +45,3 @@ "author": "Google Inc",
   "dependencies": {
-    "google-gax": "^1.0.0"
+    "google-gax": "^1.6.3"
   },
@@ -48,0 +48,0 @@ "devDependencies": {

src/v3/doc/google/monitoring/v3/doc_alert.js

@@ -257,7 +257,3 @@ // Copyright 2019 Google LLC
      *
-     *   The filter is similar to the one that is specified in the
-     *   [`MetricService.ListTimeSeries`
-     *   request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that
-     *   call is useful to verify the time series that will be retrieved /
-     *   processed) and must specify the metric type and optionally may contain
+     *   The filter must specify the metric type and optionally may contain
      *   restrictions on resource type, resource labels, and metric labels.
@@ -278,8 +274,2 @@ *   This field may not exceed 2048 Unicode characters in length.
      *
-     *   This field is similar to the one in the
-     *   [`MetricService.ListTimeSeries`
-     *   request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). It
-     *   is advisable to use the `ListTimeSeries` method when debugging this
-     *   field.
-     *
      *   This object should have the same structure as [Aggregation]{@link google.monitoring.v3.Aggregation}
@@ -286,0 +276,0 @@ *

src/v3/doc/google/monitoring/v3/doc_uptime_service.js

@@ -22,3 +22,3 @@ // Copyright 2019 Google LLC
  * @property {string} parent
- *   The project whose uptime check configurations are listed. The format
+ *   The project whose Uptime check configurations are listed. The format
  *     is `projects/[PROJECT_ID]`.
@@ -49,3 +49,3 @@ *
  * @property {Object[]} uptimeCheckConfigs
- *   The returned uptime check configurations.
+ *   The returned Uptime check configurations.
  *
@@ -62,3 +62,3 @@ *   This object should have the same structure as [UptimeCheckConfig]{@link google.monitoring.v3.UptimeCheckConfig}
  * @property {number} totalSize
- *   The total number of uptime check configurations for the project,
+ *   The total number of Uptime check configurations for the project,
  *   irrespective of any pagination.
@@ -78,3 +78,3 @@ *
  * @property {string} name
- *   The uptime check configuration to retrieve. The format
+ *   The Uptime check configuration to retrieve. The format
  *     is `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
@@ -94,7 +94,7 @@ *
  * @property {string} parent
- *   The project in which to create the uptime check. The format
+ *   The project in which to create the Uptime check. The format
  *     is `projects/[PROJECT_ID]`.
  *
  * @property {Object} uptimeCheckConfig
- *   The new uptime check configuration.
+ *   The new Uptime check configuration.
  *
@@ -115,3 +115,3 @@ *   This object should have the same structure as [UptimeCheckConfig]{@link google.monitoring.v3.UptimeCheckConfig}
  * @property {Object} updateMask
- *   Optional. If present, only the listed fields in the current uptime check
+ *   Optional. If present, only the listed fields in the current Uptime check
  *   configuration are updated with values from the new configuration. If this
@@ -124,7 +124,7 @@ *   field is empty, then the current configuration is completely replaced with
  * @property {Object} uptimeCheckConfig
- *   Required. If an `"updateMask"` has been specified, this field gives
- *   the values for the set of fields mentioned in the `"updateMask"`. If an
- *   `"updateMask"` has not been given, this uptime check configuration replaces
- *   the current configuration. If a field is mentioned in `"updateMask"` but
- *   the corresonding field is omitted in this partial uptime check
+ *   Required. If an `updateMask` has been specified, this field gives
+ *   the values for the set of fields mentioned in the `updateMask`. If an
+ *   `updateMask` has not been given, this Uptime check configuration replaces
+ *   the current configuration. If a field is mentioned in `updateMask` but
+ *   the corresonding field is omitted in this partial Uptime check
  *   configuration, it has the effect of deleting/clearing the field from the
@@ -151,3 +151,3 @@ *   configuration on the server.
  * @property {string} name
- *   The uptime check configuration to delete. The format
+ *   The Uptime check configuration to delete. The format
  *     is `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
@@ -154,0 +154,0 @@ *

src/v3/doc/google/monitoring/v3/doc_uptime.js

@@ -19,3 +19,3 @@ // Copyright 2019 Google LLC
 /**
- * An internal checker allows uptime checks to run on private/internal GCP
+ * An internal checker allows Uptime checks to run on private/internal GCP
  * resources.
@@ -28,4 +28,4 @@ *
  *
- *   PROJECT_ID is the stackdriver workspace project for the
- *   uptime check config associated with the internal checker.
+ *   `[PROJECT_ID]` is the Stackdriver Workspace project for the
+ *   Uptime check config associated with the internal checker.
  *
@@ -42,8 +42,8 @@ * @property {string} displayName
  * @property {string} gcpZone
- *   The GCP zone the uptime check should egress from. Only respected for
- *   internal uptime checks, where internal_network is specified.
+ *   The GCP zone the Uptime check should egress from. Only respected for
+ *   internal Uptime checks, where internal_network is specified.
  *
  * @property {string} peerProjectId
- *   The GCP project_id where the internal checker lives. Not necessary
- *   the same as the workspace project.
+ *   The GCP project ID where the internal checker lives. Not necessary
+ *   the same as the Workspace project.
  *
@@ -77,4 +77,6 @@ * @property {number} state
      * The checker is being created, provisioned, and configured. A checker in
-     * this state can be returned by ListInternalCheckers or GetInternalChecker,
-     * as well as by examining the longrunning.Operation that created it.
+     * this state can be returned by `ListInternalCheckers` or
+     * `GetInternalChecker`, as well as by examining the [long running
+     * Operation](https://cloud.google.com/apis/design/design_patterns#long_running_operations)
+     * that created it.
      */
@@ -85,4 +87,6 @@ CREATING: 1,
      * The checker is running and available for use. A checker in this state
-     * can be returned by ListInternalCheckers or GetInternalChecker as well
-     * as by examining the longrunning.Operation that created it.
+     * can be returned by `ListInternalCheckers` or `GetInternalChecker` as
+     * well as by examining the [long running
+     * Operation](https://cloud.google.com/apis/design/design_patterns#long_running_operations)
+     * that created it.
      * If a checker is being torn down, it is neither visible nor usable, so
@@ -100,8 +104,7 @@ * there is no "deleting" or "down" state.
  * @property {string} name
- *   A unique resource name for this UptimeCheckConfig. The format is:
+ *   A unique resource name for this Uptime check configuration. The format is:
  *
- *
  *     `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
  *
- *   This field should be omitted when creating the uptime check configuration;
+ *   This field should be omitted when creating the Uptime check configuration;
  *   on create, the resource name is assigned by the server and included in the
@@ -111,3 +114,3 @@ *   response.
  * @property {string} displayName
- *   A human-friendly name for the uptime check configuration. The display name
+ *   A human-friendly name for the Uptime check configuration. The display name
  *   should be unique within a Stackdriver Workspace in order to make it easier
@@ -120,8 +123,8 @@ *   to identify; however, uniqueness is not enforced. Required.
  *   with the configuration.
- *   The following monitored resource types are supported for uptime checks:
- *     uptime_url
- *     gce_instance
- *     gae_app
- *     aws_ec2_instance
- *     aws_elb_load_balancer
+ *   The following monitored resource types are supported for Uptime checks:
+ *     `uptime_url`,
+ *     `gce_instance`,
+ *     `gae_app`,
+ *     `aws_ec2_instance`,
+ *     `aws_elb_load_balancer`
  *
@@ -146,3 +149,3 @@ *   This object should have the same structure as [MonitoredResource]{@link google.api.MonitoredResource}
  * @property {Object} period
- *   How often, in seconds, the uptime check is performed.
+ *   How often, in seconds, the Uptime check is performed.
  *   Currently, the only supported values are `60s` (1 minute), `300s`
@@ -161,7 +164,7 @@ *   (5 minutes), `600s` (10 minutes), and `900s` (15 minutes). Optional,
  * @property {Object[]} contentMatchers
- *   The expected content on the page the check is run against.
- *   Currently, only the first entry in the list is supported, and other entries
- *   will be ignored. The server will look for an exact match of the string in
- *   the page response's content. This field is optional and should only be
- *   specified if a content match is required.
+ *   The content that is expected to appear in the data returned by the target
+ *   server against which the check is run.  Currently, only the first entry
+ *   in the `content_matchers` list is supported, and additional entries will
+ *   be ignored. This field is optional and should only be specified if a
+ *   content match is required as part of the/ Uptime check.
  *
@@ -173,6 +176,5 @@ *   This object should have the same structure as [ContentMatcher]{@link google.monitoring.v3.ContentMatcher}
  *   Some regions contain one location, and others contain more than one.
- *   If this field is specified, enough regions to include a minimum of
- *   3 locations must be provided, or an error message is returned.
- *   Not specifying this field will result in uptime checks running from all
- *   regions.
+ *   If this field is specified, enough regions must be provided to include a
+ *   minimum of 3 locations.  Not specifying this field will result in Uptime
+ *   checks running from all available regions.
  *
@@ -183,4 +185,5 @@ *   The number should be among the values of [UptimeCheckRegion]{@link google.monitoring.v3.UptimeCheckRegion}
  *   The internal checkers that this check will egress from. If `is_internal` is
- *   true and this list is empty, the check will egress from all the
- *   InternalCheckers configured for the project that owns this CheckConfig.
+ *   `true` and this list is empty, the check will egress from all the
+ *   InternalCheckers configured for the project that owns this
+ *   `UptimeCheckConfig`.
  *
@@ -201,4 +204,4 @@ *   This object should have the same structure as [InternalChecker]{@link google.monitoring.v3.InternalChecker}
    * @property {string} groupId
-   *   The group of resources being monitored. Should be only the
-   *   group_id, not projects/<project_id>/groups/<group_id>.
+   *   The group of resources being monitored. Should be only the `[GROUP_ID]`,
+   *   and not the full-path `projects/[PROJECT_ID]/groups/[GROUP_ID]`.
    *
@@ -219,17 +222,19 @@ * @property {number} resourceType
   /**
-   * Information involved in an HTTP/HTTPS uptime check request.
+   * Information involved in an HTTP/HTTPS Uptime check request.
    *
    * @property {boolean} useSsl
-   *   If true, use HTTPS instead of HTTP to run the check.
+   *   If `true`, use HTTPS instead of HTTP to run the check.
    *
    * @property {string} path
-   *   The path to the page to run the check against. Will be combined with the
-   *   host (specified within the MonitoredResource) and port to construct the
-   *   full URL. Optional (defaults to "/"). If the provided path does not
-   *   begin with "/", it will be prepended automatically.
+   *   Optional (defaults to "/"). The path to the page against which to run
+   *   the check. Will be combined with the `host` (specified within the
+   *   `monitored_resource`) and `port` to construct the full URL. If the
+   *   provided path does not begin with "/", a "/" will be prepended
+   *   automatically.
    *
    * @property {number} port
-   *   The port to the page to run the check against. Will be combined with host
-   *   (specified within the MonitoredResource) and path to construct the full
-   *   URL. Optional (defaults to 80 without SSL, or 443 with SSL).
+   *   Optional (defaults to 80 when `use_ssl` is `false`, and 443 when
+   *   `use_ssl` is `true`). The TCP port on the HTTP server against which to
+   *   run the check. Will be combined with host (specified within the
+   *   `monitored_resource`) and `path` to construct the full URL.
    *
@@ -247,7 +252,7 @@ * @property {Object} authInfo
    *   server will be responsible for encrypting the headers.
-   *   On Get/List calls, if mask_headers is set to True then the headers
-   *   will be obscured with ******.
+   *   On Get/List calls, if `mask_headers` is set to `true` then the headers
+   *   will be obscured with `******.`
    *
    * @property {Object.<string, string>} headers
-   *   The list of headers to send as part of the uptime check request.
+   *   The list of headers to send as part of the Uptime check request.
    *   If two headers have the same key and different values, they should
@@ -262,5 +267,6 @@ *   be entered as a single header, with the value being a comma-separated
    * @property {boolean} validateSsl
-   *   Boolean specifying whether to validate SSL certificates.
-   *   Only applies to uptime_url checks. If use_ssl is false, setting this to
-   *   true has no effect.
+   *   Boolean specifying whether to include SSL certificate validation as a
+   *   part of the Uptime check. Only applies to checks where
+   *   `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`,
+   *   setting `validate_ssl` to `true` has no effect.
    *
@@ -275,11 +281,12 @@ * @typedef HttpCheck
     /**
-     * A type of authentication to perform against the specified resource or URL
-     * that uses username and password.
-     * Currently, only Basic authentication is supported in Uptime Monitoring.
+     * The authentication parameters to provide to the specified resource or
+     * URL that requires a username and password. Currently, only
+     * [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
+     * supported in Uptime checks.
      *
      * @property {string} username
-     *   The username to authenticate.
+     *   The username to use when authenticating with the HTTP server.
      *
      * @property {string} password
-     *   The password to authenticate.
+     *   The password to use when authenticating with the HTTP server.
      *
@@ -296,8 +303,8 @@ * @typedef BasicAuthentication
   /**
-   * Information required for a TCP uptime check request.
+   * Information required for a TCP Uptime check request.
    *
    * @property {number} port
-   *   The port to the page to run the check against. Will be combined with host
-   *   (specified within the MonitoredResource) to construct the full URL.
-   *   Required.
+   *   The TCP port on the server against which to run the check. Will be
+   *   combined with host (specified within the `monitored_resource`) to
+   *   construct the full URL. Required.
    *
@@ -320,5 +327,4 @@ * @typedef TcpCheck
    * @property {number} matcher
-   *   The matcher representing content match options which the check will run
-   *   with. If the field is not specified (in previous versions), the option is
-   *   set to be CONTAINS_STRING which performs content substring matching.
+   *   The type of content matcher that will be applied to the server output,
+   *   compared to the `content` string when the check is run.
    *
@@ -343,3 +349,5 @@ *   The number should be among the values of [ContentMatcherOption]{@link google.monitoring.v3.ContentMatcherOption}
       /**
-       * No content macher option specified. Treated as CONTAINS_STRING.
+       * No content matcher type specified (maintained for backward
+       * compatibility, but deprecated for future use).
+       * Treated as `CONTAINS_STRING`.
        */
@@ -349,4 +357,6 @@ CONTENT_MATCHER_OPTION_UNSPECIFIED: 0,
       /**
-       * Allows checking substring matching.
-       * Default value for previous versions without option.
+       * Selects substring matching (there is a match if the output contains
+       * the `content` string).  This is the default value for checks without
+       * a `matcher` option, or where the value of `matcher` is
+       * `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
        */
@@ -356,4 +366,4 @@ CONTAINS_STRING: 1,
       /**
-       * Allows checking negation of substring matching (doesn't contain the
-       * substring).
+       * Selects negation of substring matching (there is a match if the output
+       * does NOT contain the `content` string).
        */
@@ -363,3 +373,4 @@ NOT_CONTAINS_STRING: 2,
       /**
-       * Allows checking regular expression matching.
+       * Selects regular expression matching (there is a match of the output
+       * matches the regular expression specified in the `content` string).
        */
@@ -369,3 +380,5 @@ MATCHES_REGEX: 3,
       /**
-       * Allows checking negation of regular expression matching.
+       * Selects negation of regular expression matching (there is a match if
+       * the output does NOT match the regular expression specified in the
+       * `content` string).
        */
@@ -392,6 +405,6 @@ NOT_MATCHES_REGEX: 4
  * @property {string} ipAddress
- *   The IP address from which the uptime check originates. This is a full
- *   IP address (not an IP address range). Most IP addresses, as of this
- *   publication, are in IPv4 format; however, one should not rely on the
- *   IP addresses being in IPv4 format indefinitely and should support
+ *   The IP address from which the Uptime check originates. This is a fully
+ *   specified IP address (not an IP address range). Most IP addresses, as of
+ *   this publication, are in IPv4 format; however, one should not rely on the
+ *   IP addresses being in IPv4 format indefinitely, and should support
  *   interpreting this field in either IPv4 or IPv6 format.
@@ -437,3 +450,3 @@ *
 /**
- * The regions from which an uptime check can be run.
+ * The regions from which an Uptime check can be run.
  *
@@ -446,3 +459,3 @@ * @enum {number}
   /**
-   * Default value if no region is specified. Will result in uptime checks
+   * Default value if no region is specified. Will result in Uptime checks
    * running from all regions.
@@ -449,0 +462,0 @@ */

src/v3/uptime_check_service_client.js

@@ -25,3 +25,3 @@ // Copyright 2019 Google LLC
  * The UptimeCheckService API is used to manage (list, create, delete, edit)
- * uptime check configurations in the Stackdriver Monitoring product. An uptime
+ * Uptime check configurations in the Stackdriver Monitoring product. An Uptime
  * check is a piece of configuration that determines which resources and
@@ -256,4 +256,4 @@ * services to monitor for availability. These configurations can also be
   /**
-   * Lists the existing valid uptime check configurations for the project,
-   * leaving out any invalid configurations.
+   * Lists the existing valid Uptime check configurations for the project
+   * (leaving out any invalid configurations).
    *
@@ -263,3 +263,3 @@ * @param {Object} request
    * @param {string} request.parent
-   *   The project whose uptime check configurations are listed. The format
+   *   The project whose Uptime check configurations are listed. The format
    *     is `projects/[PROJECT_ID]`.
@@ -381,3 +381,3 @@ * @param {number} [request.pageSize]
    * @param {string} request.parent
-   *   The project whose uptime check configurations are listed. The format
+   *   The project whose Uptime check configurations are listed. The format
    *     is `projects/[PROJECT_ID]`.
@@ -423,3 +423,3 @@ * @param {number} [request.pageSize]
   /**
-   * Gets a single uptime check configuration.
+   * Gets a single Uptime check configuration.
    *
@@ -429,3 +429,3 @@ * @param {Object} request
    * @param {string} request.name
-   *   The uptime check configuration to retrieve. The format
+   *   The Uptime check configuration to retrieve. The format
    *     is `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
@@ -480,3 +480,3 @@ * @param {Object} [options]
   /**
-   * Creates a new uptime check configuration.
+   * Creates a new Uptime check configuration.
    *
@@ -486,6 +486,6 @@ * @param {Object} request
    * @param {string} request.parent
-   *   The project in which to create the uptime check. The format
+   *   The project in which to create the Uptime check. The format
    *     is `projects/[PROJECT_ID]`.
    * @param {Object} request.uptimeCheckConfig
-   *   The new uptime check configuration.
+   *   The new Uptime check configuration.
    *
@@ -550,5 +550,5 @@ *   This object should have the same structure as [UptimeCheckConfig]{@link google.monitoring.v3.UptimeCheckConfig}
   /**
-   * Updates an uptime check configuration. You can either replace the entire
+   * Updates an Uptime check configuration. You can either replace the entire
    * configuration with a new one or replace only certain fields in the current
-   * configuration by specifying the fields to be updated via `"updateMask"`.
+   * configuration by specifying the fields to be updated via `updateMask`.
    * Returns the updated configuration.
@@ -559,7 +559,7 @@ *
    * @param {Object} request.uptimeCheckConfig
-   *   Required. If an `"updateMask"` has been specified, this field gives
-   *   the values for the set of fields mentioned in the `"updateMask"`. If an
-   *   `"updateMask"` has not been given, this uptime check configuration replaces
-   *   the current configuration. If a field is mentioned in `"updateMask"` but
-   *   the corresonding field is omitted in this partial uptime check
+   *   Required. If an `updateMask` has been specified, this field gives
+   *   the values for the set of fields mentioned in the `updateMask`. If an
+   *   `updateMask` has not been given, this Uptime check configuration replaces
+   *   the current configuration. If a field is mentioned in `updateMask` but
+   *   the corresonding field is omitted in this partial Uptime check
    *   configuration, it has the effect of deleting/clearing the field from the
@@ -574,3 +574,3 @@ *   configuration on the server.
    * @param {Object} [request.updateMask]
-   *   Optional. If present, only the listed fields in the current uptime check
+   *   Optional. If present, only the listed fields in the current Uptime check
    *   configuration are updated with values from the new configuration. If this
@@ -633,4 +633,4 @@ *   field is empty, then the current configuration is completely replaced with
   /**
-   * Deletes an uptime check configuration. Note that this method will fail
-   * if the uptime check configuration is referenced by an alert policy or
+   * Deletes an Uptime check configuration. Note that this method will fail
+   * if the Uptime check configuration is referenced by an alert policy or
    * other dependent configs that would be rendered invalid by the deletion.
@@ -641,3 +641,3 @@ *
    * @param {string} request.name
-   *   The uptime check configuration to delete. The format
+   *   The Uptime check configuration to delete. The format
    *     is `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
@@ -688,3 +688,3 @@ * @param {Object} [options]
   /**
-   * Returns the list of IPs that checkers run from
+   * Returns the list of IP addresses that checkers run from
    *
@@ -691,0 +691,0 @@ * @param {Object} request

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3498396

increased by419.71%

Number of package files

63

increased by3.28%

Lines of code

59514

increased by354.76%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• Updatedgoogle-gax@^1.6.3