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

This field informs Fleet-based applications/services/UIs with the necessary information for where each underlying Cluster reports its metrics.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MonitoringConfig

Returns a new instance of MonitoringConfig.



3144
3145
3146
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3144

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

Instance Attribute Details

#cluster ⇒ String

Immutable. Cluster name used to report metrics. For Anthos on VMWare/Baremetal, it would be in format memberClusters/cluster_name; And for Anthos on MultiCloud, it would be in format `azureClusters, awsClusters/cluster_name. Corresponds to the JSON propertycluster`

Returns:

  • (String) 


3116
3117
3118
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3116

def cluster
  @cluster
end

#cluster_hash ⇒ String

Immutable. Cluster hash, this is a unique string generated by google code, which does not contain any PII, which we can use to reference the cluster. This is expected to be created by the monitoring stack and persisted into the Cluster object as well as to GKE-Hub. Corresponds to the JSON property clusterHash

Returns:

  • (String) 


3124
3125
3126
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3124

def cluster_hash
  @cluster_hash
end

#kubernetes_metrics_prefix ⇒ String

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) 


3132
3133
3134
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3132

def kubernetes_metrics_prefix
  @kubernetes_metrics_prefix
end

#location ⇒ String

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

Returns:

  • (String) 


3137
3138
3139
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3137

def location
  @location
end

#project_id ⇒ String

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

Returns:

  • (String) 


3142
3143
3144
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3142

def project_id
  @project_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3149
3150
3151
3152
3153
3154
3155
 
# File 'lib/google/apis/gkehub_v1/classes.rb', line 3149

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