services

Creates, updates, deletes, gets or lists a services resource.

Overview

Name	services
Type	Resource
Id	google.monitoring.services

Fields

Name	Datatype	Description
name	string	Identifier. Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
appEngine	object	App Engine service. Learn more at https://cloud.google.com/appengine.
basicService	object	A well-known service type, defined by its service type and service labels. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli).
cloudEndpoints	object	Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints.
cloudRun	object	Cloud Run service. Learn more at https://cloud.google.com/run.
clusterIstio	object	Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type.
custom	object	Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service.
displayName	string	Name used for UI elements listing this Service.
gkeNamespace	object	GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod).
gkeService	object	GKE Service. The "service" here represents a Kubernetes service object (https://kubernetes.io/docs/concepts/services-networking/service). The field names correspond to the resource labels on k8s_service monitored resources (https://cloud.google.com/monitoring/api/resources#tag_k8s_service).
gkeWorkload	object	A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, k8s_container or k8s_pod).
istioCanonicalService	object	Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type.
meshIstio	object	Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type.
telemetry	object	Configuration for how to query telemetry on a Service.
userLabels	object	Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value.

Methods

Name	Accessible by	Required Params	Description
services_list	SELECT	parent, parentType	List Services for this Metrics Scope.
services_create	INSERT	parent, parentType	Create a Service.

SELECT examples

List Services for this Metrics Scope.

SELECT
name,
appEngine,
basicService,
cloudEndpoints,
cloudRun,
clusterIstio,
custom,
displayName,
gkeNamespace,
gkeService,
gkeWorkload,
istioCanonicalService,
meshIstio,
telemetry,
userLabels
FROM google.monitoring.services
WHERE parent = '{{ parent }}'
AND parentType = '{{ parentType }}';

INSERT example

Use the following StackQL query and manifest file to create a new services resource.

All Properties

/*+ create */
INSERT INTO google.monitoring.services (
parent,
parentType,
name,
displayName,
custom,
appEngine,
cloudEndpoints,
clusterIstio,
meshIstio,
istioCanonicalService,
cloudRun,
gkeNamespace,
gkeWorkload,
gkeService,
basicService,
telemetry,
userLabels
)
SELECT 
'{{ parent }}',
'{{ parentType }}',
'{{ name }}',
'{{ displayName }}',
'{{ custom }}',
'{{ appEngine }}',
'{{ cloudEndpoints }}',
'{{ clusterIstio }}',
'{{ meshIstio }}',
'{{ istioCanonicalService }}',
'{{ cloudRun }}',
'{{ gkeNamespace }}',
'{{ gkeWorkload }}',
'{{ gkeService }}',
'{{ basicService }}',
'{{ telemetry }}',
'{{ userLabels }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: custom
      value: []
    - name: appEngine
      value:
        - name: moduleId
          value: string
    - name: cloudEndpoints
      value:
        - name: service
          value: string
    - name: clusterIstio
      value:
        - name: location
          value: string
        - name: clusterName
          value: string
        - name: serviceNamespace
          value: string
        - name: serviceName
          value: string
    - name: meshIstio
      value:
        - name: meshUid
          value: string
        - name: serviceNamespace
          value: string
        - name: serviceName
          value: string
    - name: istioCanonicalService
      value:
        - name: meshUid
          value: string
        - name: canonicalServiceNamespace
          value: string
        - name: canonicalService
          value: string
    - name: cloudRun
      value:
        - name: serviceName
          value: string
        - name: location
          value: string
    - name: gkeNamespace
      value:
        - name: projectId
          value: string
        - name: location
          value: string
        - name: clusterName
          value: string
        - name: namespaceName
          value: string
    - name: gkeWorkload
      value:
        - name: projectId
          value: string
        - name: location
          value: string
        - name: clusterName
          value: string
        - name: namespaceName
          value: string
        - name: topLevelControllerType
          value: string
        - name: topLevelControllerName
          value: string
    - name: gkeService
      value:
        - name: projectId
          value: string
        - name: location
          value: string
        - name: clusterName
          value: string
        - name: namespaceName
          value: string
        - name: serviceName
          value: string
    - name: basicService
      value:
        - name: serviceType
          value: string
        - name: serviceLabels
          value: object
    - name: telemetry
      value:
        - name: resourceName
          value: string
    - name: userLabels
      value: object