xref: /dpdk/usertools/dpdk-telemetry-client.py (revision 90197eb0945b50c9cd6e11f310cfc5078b28f75e)
1#! /usr/bin/env python
2# SPDK-License-Identifier: BSD-3-Clause
3# Copyright(c) 2018 Intel Corporation
4
5import socket
6import os
7import sys
8import time
9
10BUFFER_SIZE = 200000
11
12METRICS_REQ = "{\"action\":0,\"command\":\"ports_all_stat_values\",\"data\":null}"
13API_REG = "{\"action\":1,\"command\":\"clients\",\"data\":{\"client_path\":\""
14API_UNREG = "{\"action\":2,\"command\":\"clients\",\"data\":{\"client_path\":\""
15GLOBAL_METRICS_REQ = "{\"action\":0,\"command\":\"global_stat_values\",\"data\":null}"
16DEFAULT_FP = "/var/run/dpdk/default_client"
17
18class Socket:
19
20    def __init__(self):
21        self.send_fd = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET)
22        self.recv_fd = socket.socket(socket.AF_UNIX, socket.SOCK_SEQPACKET)
23        self.client_fd = None
24
25    def __del__(self):
26        try:
27            self.send_fd.close()
28            self.recv_fd.close()
29            self.client_fd.close()
30        except:
31            print("Error - Sockets could not be closed")
32
33class Client:
34
35    def __init__(self): # Creates a client instance
36        self.socket = Socket()
37        self.file_path = None
38        self.choice = None
39        self.unregistered = 0
40
41    def __del__(self):
42        try:
43            if self.unregistered == 0:
44                self.unregister();
45        except:
46            print("Error - Client could not be destroyed")
47
48    def getFilepath(self, file_path): # Gets arguments from Command-Line and assigns to instance of client
49        self.file_path = file_path
50
51    def register(self): # Connects a client to DPDK-instance
52        if os.path.exists(self.file_path):
53            os.unlink(self.file_path)
54        try:
55            self.socket.recv_fd.bind(self.file_path)
56        except socket.error as msg:
57            print ("Error - Socket binding error: " + str(msg) + "\n")
58        self.socket.recv_fd.settimeout(2)
59        self.socket.send_fd.connect("/var/run/dpdk/rte/telemetry")
60        JSON = (API_REG + self.file_path + "\"}}")
61        self.socket.send_fd.sendall(JSON)
62        self.socket.recv_fd.listen(1)
63        self.socket.client_fd = self.socket.recv_fd.accept()[0]
64
65    def unregister(self): # Unregister a given client
66        self.socket.client_fd.send(API_UNREG + self.file_path + "\"}}")
67        self.socket.client_fd.close()
68
69    def requestMetrics(self): # Requests metrics for given client
70        self.socket.client_fd.send(METRICS_REQ)
71        data = self.socket.client_fd.recv(BUFFER_SIZE)
72        print "\nResponse: \n", str(data)
73
74    def repeatedlyRequestMetrics(self, sleep_time): # Recursively requests metrics for given client
75        print("\nPlease enter the number of times you'd like to continuously request Metrics:")
76        n_requests = int(input("\n:"))
77        print("\033[F") #Removes the user input from screen, cleans it up
78        print("\033[K")
79        for i in range(n_requests):
80            self.requestMetrics()
81            time.sleep(sleep_time)
82
83    def requestGlobalMetrics(self): #Requests global metrics for given client
84        self.socket.client_fd.send(GLOBAL_METRICS_REQ)
85        data = self.socket.client_fd.recv(BUFFER_SIZE)
86        print "\nResponse: \n", str(data)
87
88    def interactiveMenu(self, sleep_time): # Creates Interactive menu within the script
89        while self.choice != 4:
90            print("\nOptions Menu")
91            print("[1] Send for Metrics for all ports")
92            print("[2] Send for Metrics for all ports recursively")
93            print("[3] Send for global Metrics")
94            print("[4] Unregister client")
95
96            try:
97                self.choice = int(input("\n:"))
98                print("\033[F") #Removes the user input for screen, cleans it up
99                print("\033[K")
100                if self.choice == 1:
101                    self.requestMetrics()
102                elif self.choice == 2:
103                    self.repeatedlyRequestMetrics(sleep_time)
104                elif self.choice == 3:
105                    self.requestGlobalMetrics()
106                elif self.choice == 4:
107                    self.unregister()
108                    self.unregistered = 1
109                else:
110                    print("Error - Invalid request choice")
111            except:
112                pass
113
114if __name__ == "__main__":
115
116    sleep_time = 1
117    file_path = ""
118    if (len(sys.argv) == 2):
119	file_path = sys.argv[1]
120    else:
121        print("Warning - No filepath passed, using default (" + DEFAULT_FP + ").")
122	file_path = DEFAULT_FP
123    client = Client()
124    client.getFilepath(file_path)
125    client.register()
126    client.interactiveMenu(sleep_time)
127