Class: Google::Apis::GkehubV1::MonitoringConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/gkehub_v1/classes.rb,
lib/google/apis/gkehub_v1/representations.rb,
lib/google/apis/gkehub_v1/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.



4582
4583
4584
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 4582

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) 


4556
4557
4558
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 4556

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) 


4562
4563
4564
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 4562

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) 


4570
4571
4572
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 4570

def kubernetes_metrics_prefix
  @kubernetes_metrics_prefix
end

#location ⇒ String

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

Returns:

  • (String) 


4575
4576
4577
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 4575

def location
  @location
end

#project_id ⇒ String

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

Returns:

  • (String) 


4580
4581
4582
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 4580

def project_id
  @project_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4587
4588
4589
4590
4591
4592
4593
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 4587

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