REST Resource: projects.monitoredResourceDescriptors

Resource: MonitoredResourceDescriptor

An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.

Different services can support different monitored resource types.

The following are specific rules to service defined monitored resources for Monitoring and Logging:

  • The type, displayName, description, labels and launchStage fields are all required.
  • The first label of the monitored resource descriptor must be resourceContainer. There are legacy monitored resource descritptors start with project_id.
  • It must include a location label.
  • Maximum of default 5 service defined monitored resource descriptors is allowed per service.
  • Maximum of default 10 labels per monitored resource is allowed.

The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas

JSON representation
{
  "name": string,
  "type": string,
  "displayName": string,
  "description": string,
  "labels": [
    {
      object (LabelDescriptor)
    }
  ],
  "launchStage": enum (LaunchStage)
}
Fields
name

string

Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".

type

string

Required. The monitored resource type. For example, the type cloudsql_database represents databases in Google Cloud SQL.

All service defined monitored resource types must be prefixed with the service name, in the format of {service name}/{relative resource name}. The relative resource name must follow:

  • Only upper and lower-case letters and digits are allowed.
  • It must start with upper case character and is recommended to use Upper Camel Case style.
  • The maximum number of characters allowed for the relative_resource_name is 100.

Note there are legacy service monitored resources not following this rule.

displayName

string

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".

description

string

Optional. A detailed description of the monitored resource type that might be used in documentation.

labels[]

object (LabelDescriptor)

Required. A set of labels used to describe instances of this monitored resource type. The label key name must follow:

  • Only upper and lower-case letters, digits and underscores (_) are allowed.
  • Label name must start with a letter or digit.
  • The maximum length of a label name is 100 characters.

For example, an individual Google Cloud SQL database is identified by values for the labels database_id and location.

launchStage

enum (LaunchStage)

Optional. The launch stage of the monitored resource definition.

Methods

get

Gets a single monitored resource descriptor.

list

Lists monitored resource descriptors that match a filter.