forked from kubernetes-client/python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmetrics_example.py
More file actions
190 lines (144 loc) · 6.47 KB
/
metrics_example.py
File metadata and controls
190 lines (144 loc) · 6.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
8000
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
#!/usr/bin/env python
# Copyright 2024 The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Example demonstrating how to fetch and display metrics from the Kubernetes
metrics-server using the Python client.
This example shows:
1. Fetching node metrics
2. Fetching pod metrics in a namespace
3. Fetching pod metrics across multiple namespaces
4. Filtering pod metrics by labels
Prerequisites:
- A running Kubernetes cluster with metrics-server installed
- kubectl configured to access the cluster
- The kubernetes Python client library installed
"""
from kubernetes import client, config, utils
def print_node_metrics(api_client):
"""Fetch and display node metrics."""
print("\n" + "="*60)
print("NODE METRICS")
print("="*60)
try:
metrics = utils.get_nodes_metrics(api_client)
print(f"Found {len(metrics.get('items', []))} nodes\n")
for node in metrics.get('items', []):
node_name = node['metadata']['name']
timestamp = node.get('timestamp', 'N/A')
window = node.get('window', 'N/A')
usage = node.get('usage', {})
print(f"Node: {node_name}")
print(f" Timestamp: {timestamp}")
print(f" Window: {window}")
print(f" CPU Usage: {usage.get('cpu', 'N/A')}")
print(f" Memory Usage: {usage.get('memory', 'N/A')}")
print()
except Exception as e:
print(f"Error fetching node metrics: {e}")
def print_pod_metrics(api_client, namespace):
"""Fetch and display pod metrics for a namespace."""
print("\n" + "="*60)
print(f"POD METRICS IN NAMESPACE: {namespace}")
print("="*60)
try:
metrics = utils.get_pods_metrics(api_client, namespace)
print(f"Found {len(metrics.get('items', []))} pods\n")
for pod in metrics.get('items', []):
pod_name = pod['metadata']['name']
timestamp = pod.get('timestamp', 'N/A')
window = pod.get('window', 'N/A')
print(f"Pod: {pod_name}")
print(f" Timestamp: {timestamp}")
print(f" Window: {window}")
print(f" Containers:")
for container in pod.get('containers', []):
container_name = container['name']
usage = container.get('usage', {})
print(f" - {container_name}:")
print(f" CPU: {usage.get('cpu', 'N/A')}")
print(f" Memory: {usage.get('memory', 'N/A')}")
print()
except Exception as e:
print(f"Error fetching pod metrics: {e}")
def print_filtered_pod_metrics(api_client, namespace, labels):
"""Fetch and display pod metrics filtered by labels."""
print("\n" + "="*60)
print(f"POD METRICS IN NAMESPACE: {namespace}")
print(f"FILTERED BY LABELS: {labels}")
print("="*60)
try:
metrics = utils.get_pods_metrics(api_client, namespace, labels)
pods = metrics.get('items', [])
print(f"Found {len(pods)} pods matching labels\n")
for pod in pods:
pod_name = pod['metadata']['name']
print(f"Pod: {pod_name}")
for container in pod.get('containers', []):
container_name = container['name']
usage = container.get('usage', {})
print(f" {container_name}: CPU={usage.get('cpu')}, Memory={usage.get('memory')}")
print()
except Exception as e:
print(f"Error fetching filtered pod metrics: {e}")
def print_multi_namespace_metrics(api_client, namespaces):
"""Fetch and display pod metrics across multiple namespaces."""
print("\n" + "="*60)
print(f"POD METRICS ACROSS MULTIPLE NAMESPACES")
print("="*60)
try:
all_metrics = utils.get_pods_metrics_in_all_namespaces(api_client, namespaces)
for ns, result in all_metrics.items():
print(f"\nNamespace: {ns}")
if 'error' in result:
print(f" Error: {result['error']}")
else:
pod_count = len(result.get('items', []))
print(f" Pods: {pod_count}")
# Calculate total resource usage for namespace
total_containers = 0
for pod in result.get('items', []):
total_containers += len(pod.get('containers', []))
print(f" Total containers: {total_containers}")
except Exception as e:
print(f"Error fetching multi-namespace metrics: {e}")
def main():
"""Main function to demonstrate metrics API usage."""
# Load kubernetes configuration
# This will use your current kubectl context
config.load_kube_config()
# Create API client
api_client = client.ApiClient()
print("\nKubernetes Metrics API Example")
print("================================")
print("\nThis example demonstrates fetching resource usage metrics")
print("from the Kubernetes metrics-server.")
print("\nNote: metrics-server must be installed in your cluster for this to work.")
# Example 1: Fetch node metrics
print_node_metrics(api_client)
# Example 2: Fetch pod metrics in default namespace
print_pod_metrics(api_client, 'default')
# Example 3: Fetch pod metrics in kube-system namespace
print_pod_metrics(api_client, 'kube-system')
# Example 4: Fetch pod metrics with label filter
# Uncomment and modify the label selector to match your pods
# print_filtered_pod_metrics(api_client, 'default', 'app=nginx')
# Example 5: Fetch metrics across multiple namespaces
namespaces_to_query = ['default', 'kube-system']
print_multi_namespace_metrics(api_client, namespaces_to_query)
print("\n" + "="*60)
print("Example completed successfully!")
print("="*60 + "\n")
if __name__ == '__main__':
main()