Create
|
|||||
|
|
Stackdriver Monitoring Agent only: Creates a new time series.
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and write monitoring data for all of your Google and third-party Cloud and API projects
- Publish metric data to your Google Cloud projects
Input
This building block consumes 24 input parameters
Name | Format | Description |
---|---|---|
name Required |
STRING |
The project in which to create the time series. The format is "projects/PROJECT_ID_OR_NUMBER" |
resource |
OBJECT |
An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }} |
resource.type |
STRING |
Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types and Logging resource types |
resource.labels |
OBJECT |
Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone" |
resource.labels.customKey.value Required |
STRING |
Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone" |
collectdPayloads[] |
OBJECT |
A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information |
collectdPayloads[].type |
STRING |
The measurement type. Example: "memory" |
collectdPayloads[].metadata |
OBJECT |
The measurement metadata. Example: "process_id" -> 12345 |
collectdPayloads[].metadata.customKey |
OBJECT |
Add additional named properties |
collectdPayloads[].metadata.customKey.doubleValue |
NUMBER |
A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision |
collectdPayloads[].metadata.customKey.int64Value |
INTEGER |
A 64-bit integer. Its range is approximately ±9.2x1018 |
collectdPayloads[].metadata.customKey.distributionValue |
OBJECT |
Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless |
collectdPayloads[].metadata.customKey.boolValue |
BOOLEAN |
A Boolean value: true or false |
collectdPayloads[].metadata.customKey.stringValue |
STRING |
A variable-length string value |
collectdPayloads[].plugin |
STRING |
The name of the plugin. Example: "disk" |
collectdPayloads[].pluginInstance |
STRING |
The instance name of the plugin Example: "hdcl" |
collectdPayloads[].endTime |
ANY |
The end time of the interval |
collectdPayloads[].startTime |
ANY |
The start time of the interval |
collectdPayloads[].values[] |
OBJECT |
A single data point from a collectd-based plugin |
collectdPayloads[].values[].value |
OBJECT |
A single strongly-typed value |
collectdPayloads[].values[].dataSourceType |
ENUMERATION |
The type of measurement |
collectdPayloads[].values[].dataSourceName |
STRING |
The data source for the collectd value. For example there are two data sources for network measurements: "rx" and "tx" |
collectdPayloads[].typeInstance |
STRING |
The measurement type instance. Example: "used" |
collectdVersion |
STRING |
The version of collectd that collected the data. Example: "5.3.0-192.el6" |
= Parameter name
= Format
name STRING Required The project in which to create the time series. The format is "projects/PROJECT_ID_OR_NUMBER" |
resource OBJECT An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }} |
resource.type STRING Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types and Logging resource types |
resource.labels OBJECT Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone" |
resource.labels.customKey.value STRING Required Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone" |
collectdPayloads[] OBJECT A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information |
collectdPayloads[].type STRING The measurement type. Example: "memory" |
collectdPayloads[].metadata OBJECT The measurement metadata. Example: "process_id" -> 12345 |
collectdPayloads[].metadata.customKey OBJECT Add additional named properties |
collectdPayloads[].metadata.customKey.doubleValue NUMBER A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision |
collectdPayloads[].metadata.customKey.int64Value INTEGER A 64-bit integer. Its range is approximately ±9.2x1018 |
collectdPayloads[].metadata.customKey.distributionValue OBJECT Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless |
collectdPayloads[].metadata.customKey.boolValue BOOLEAN A Boolean value: true or false |
collectdPayloads[].metadata.customKey.stringValue STRING A variable-length string value |
collectdPayloads[].plugin STRING The name of the plugin. Example: "disk" |
collectdPayloads[].pluginInstance STRING The instance name of the plugin Example: "hdcl" |
collectdPayloads[].endTime ANY The end time of the interval |
collectdPayloads[].startTime ANY The start time of the interval |
collectdPayloads[].values[] OBJECT A single data point from a collectd-based plugin |
collectdPayloads[].values[].value OBJECT A single strongly-typed value |
collectdPayloads[].values[].dataSourceType ENUMERATION The type of measurement |
collectdPayloads[].values[].dataSourceName STRING The data source for the collectd value. For example there are two data sources for network measurements: "rx" and "tx" |
collectdPayloads[].typeInstance STRING The measurement type instance. Example: "used" |
collectdVersion STRING The version of collectd that collected the data. Example: "5.3.0-192.el6" |
Output
This building block provides 10 output parameters
Name | Format | Description |
---|---|---|
payloadErrors[] |
OBJECT |
Describes the error status for payloads that were not written |
payloadErrors[].index |
INTEGER |
The zero-based index in CreateCollectdTimeSeriesRequest.collectd_payloads |
payloadErrors[].error |
OBJECT |
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors) |
payloadErrors[].error.code |
INTEGER |
The status code, which should be an enum value of google.rpc.Code |
payloadErrors[].error.message |
STRING |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client |
payloadErrors[].error.details[] |
OBJECT |
|
payloadErrors[].error.details[].customKey.value |
ANY |
|
payloadErrors[].valueErrors[] |
OBJECT |
Describes the error status for values that were not written |
payloadErrors[].valueErrors[].error |
OBJECT |
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors) |
payloadErrors[].valueErrors[].index |
INTEGER |
The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads |
= Parameter name
= Format
payloadErrors[] OBJECT Describes the error status for payloads that were not written |
payloadErrors[].index INTEGER The zero-based index in CreateCollectdTimeSeriesRequest.collectd_payloads |
payloadErrors[].error OBJECT The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors) |
payloadErrors[].error.code INTEGER The status code, which should be an enum value of google.rpc.Code |
payloadErrors[].error.message STRING A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client |
payloadErrors[].error.details[] OBJECT |
payloadErrors[].error.details[].customKey.value ANY |
payloadErrors[].valueErrors[] OBJECT Describes the error status for values that were not written |
payloadErrors[].valueErrors[].error OBJECT The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors) |
payloadErrors[].valueErrors[].index INTEGER The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads |