Class: Google::Apis::GkehubV1beta1::MonitoringConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/gkehub_v1beta1/classes.rb,
lib/google/apis/gkehub_v1beta1/representations.rb,
lib/google/apis/gkehub_v1beta1/representations.rb

Overview

MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MonitoringConfig

Returns a new instance of MonitoringConfig.



1008
1009
1010
 
# File 'lib/google/apis/gkehub_v1beta1/classes.rb', line 1008

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cluster ⇒ String

Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/ MultiCloud clusters, it would be in format cluster_type/cluster_name, e.g., "awsClusters/cluster_1". Corresponds to the JSON property cluster

Returns:

  • (String) 


982
983
984
 
# File 'lib/google/apis/gkehub_v1beta1/classes.rb', line 982

def cluster
  @cluster
end

#cluster_hash ⇒ String

Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. Corresponds to the JSON property clusterHash

Returns:

  • (String) 


988
989
990
 
# File 'lib/google/apis/gkehub_v1beta1/classes.rb', line 988

def cluster_hash
  @cluster_hash
end

#kubernetes_metrics_prefix ⇒ String

Optional. Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos. Corresponds to the JSON property kubernetesMetricsPrefix

Returns:

  • (String) 


996
997
998
 
# File 'lib/google/apis/gkehub_v1beta1/classes.rb', line 996

def kubernetes_metrics_prefix
  @kubernetes_metrics_prefix
end

#location ⇒ String

Optional. Location used to report Metrics Corresponds to the JSON property location

Returns:

  • (String) 


1001
1002
1003
 
# File 'lib/google/apis/gkehub_v1beta1/classes.rb', line 1001

def location
  @location
end

#project_id ⇒ String

Optional. Project used to report Metrics Corresponds to the JSON property projectId

Returns:

  • (String) 


1006
1007
1008
 
# File 'lib/google/apis/gkehub_v1beta1/classes.rb', line 1006

def project_id
  @project_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/google/apis/gkehub_v1beta1/classes.rb', line 1013

def update!(**args)
  @cluster = args[:cluster] if args.key?(:cluster)
  @cluster_hash = args[:cluster_hash] if args.key?(:cluster_hash)
  @kubernetes_metrics_prefix = args[:kubernetes_metrics_prefix] if args.key?(:kubernetes_metrics_prefix)
  @location = args[:location] if args.key?(:location)
  @project_id = args[:project_id] if args.key?(:project_id)
end