- Resource: Service
- Custom
- AppEngine
- ClusterIstio
- MeshIstio
- IstioCanonicalService
- CloudRun
- GkeNamespace
- GkeWorkload
- GkeService
- BasicService
- Telemetry
- Methods
Resource: Service
A Service
is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia). In Cloud Monitoring, a Service
acts as the root resource under which operational aspects of the service are accessible.
JSON representation |
---|
{ "name": string, "displayName": string, "basicService": { object ( |
Fields | |
---|---|
name |
Identifier. Resource name for this Service. The format is:
|
display |
Name used for UI elements listing this Service. |
basic |
Message that contains the service type and service labels of this service if it is a basic service. Documentation and examples here. |
telemetry |
Configuration for how to query telemetry on a Service. |
user |
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. |
Union field identifier . REQUIRED. Service-identifying atoms specifying the underlying service. identifier can be only one of the following: |
|
custom |
Custom service type. |
app |
Type used for App Engine services. |
cluster |
Type used for Istio services that live in a Kubernetes cluster. |
mesh |
Type used for Istio services scoped to an Istio mesh. |
istio |
Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here |
cloud |
Type used for Cloud Run services. |
gke |
Type used for GKE Namespaces. |
gke |
Type used for GKE Workloads. |
gke |
Type used for GKE Services (the Kubernetes concept of a service). |
Custom
This type has no fields.
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.
AppEngine
App Engine service. Learn more at https://cloud.google.com/appengine.
JSON representation |
---|
{ "moduleId": string } |
Fields | |
---|---|
module |
The ID of the App Engine module underlying this service. Corresponds to the |
ClusterIstio
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.
JSON representation |
---|
{ "location": string, "clusterName": string, "serviceNamespace": string, "serviceName": string } |
Fields | |
---|---|
location |
The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the |
cluster |
The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the |
service |
The namespace of the Istio service underlying this service. Corresponds to the |
service |
The name of the Istio service underlying this service. Corresponds to the |
MeshIstio
Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type.
JSON representation |
---|
{ "meshUid": string, "serviceNamespace": string, "serviceName": string } |
Fields | |
---|---|
mesh |
Identifier for the mesh in which this Istio service is defined. Corresponds to the |
service |
The namespace of the Istio service underlying this service. Corresponds to the |
service |
The name of the Istio service underlying this service. Corresponds to the |
IstioCanonicalService
Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type.
JSON representation |
---|
{ "meshUid": string, "canonicalServiceNamespace": string, "canonicalService": string } |
Fields | |
---|---|
mesh |
Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the |
canonical |
The namespace of the canonical service underlying this service. Corresponds to the |
canonical |
The name of the canonical service underlying this service. Corresponds to the |
CloudRun
Cloud Run service. Learn more at https://cloud.google.com/run.
JSON representation |
---|
{ "serviceName": string, "location": string } |
Fields | |
---|---|
service |
The name of the Cloud Run service. Corresponds to the |
location |
The location the service is run. Corresponds to the |
GkeNamespace
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
).
JSON representation |
---|
{ "projectId": string, "location": string, "clusterName": string, "namespaceName": string } |
Fields | |
---|---|
project |
Output only. The project this resource lives in. For legacy services migrated from the |
location |
The location of the parent cluster. This may be a zone or region. |
cluster |
The name of the parent cluster. |
namespace |
The name of this namespace. |
GkeWorkload
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
).
JSON representation |
---|
{ "projectId": string, "location": string, "clusterName": string, "namespaceName": string, "topLevelControllerType": string, "topLevelControllerName": string } |
Fields | |
---|---|
project |
Output only. The project this resource lives in. For legacy services migrated from the |
location |
The location of the parent cluster. This may be a zone or region. |
cluster |
The name of the parent cluster. |
namespace |
The name of the parent namespace. |
top |
The type of this workload (for example, "Deployment" or "DaemonSet") |
top |
The name of this workload. |
GkeService
GKE Service. The "service" here represents a Kubernetes service object. The field names correspond to the resource labels on k8s_service
monitored resources.
JSON representation |
---|
{ "projectId": string, "location": string, "clusterName": string, "namespaceName": string, "serviceName": string } |
Fields | |
---|---|
project |
Output only. The project this resource lives in. For legacy services migrated from the |
location |
The location of the parent cluster. This may be a zone or region. |
cluster |
The name of the parent cluster. |
namespace |
The name of the parent namespace. |
service |
The name of this service. |
BasicService
A well-known service type, defined by its service type and service labels. Documentation and examples here.
JSON representation |
---|
{ "serviceType": string, "serviceLabels": { string: string, ... } } |
Fields | |
---|---|
service |
The type of service that this basic service defines, e.g. APP_ENGINE service type. Documentation and valid values here. |
service |
Labels that specify the resource that emits the monitoring data which is used for SLO reporting of this |
Telemetry
Configuration for how to query telemetry on a Service.
JSON representation |
---|
{ "resourceName": string } |
Fields | |
---|---|
resource |
The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resourceNames. |
Methods |
|
---|---|
|
Create a Service . |
|
Soft delete this Service . |
|
Get the named Service . |
|
List Service s for this Metrics Scope. |
|
Update this Service . |