blob: ee610d1fd5ce346663461a4d6171bb6e7e5467b4 [file] [log] [blame]
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -08001#!/bin/bash
2
3#
4# Copyright 2015-present Open Networking Foundation
5#
6# Licensed under the Apache License, Version 2.0 (the "License");
7# you may not use this file except in compliance with the License.
8# You may obtain a copy of the License at
9#
10# http://www.apache.org/licenses/LICENSE-2.0
11#
12# Unless required by applicable law or agreed to in writing, software
13# distributed under the License is distributed on an "AS IS" BASIS,
14# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15# See the License for the specific language governing permissions and
16# limitations under the License.
17#
18
19# -----------------------------------------------------------------------------
20# Tool to collect cluster-wide diagnostics into a single tar stream.
21# -----------------------------------------------------------------------------
22function usage() {
Thomas Vachuska1c188d32018-04-16 14:02:18 -070023 echo "usage: $(basename $0) [-x] [-n name] [-P port] [-u user] [-p password] [ip1 ip2...]"
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -080024 echo ""
25 echo "Environment Variables:"
26 echo " ONOS_INSTANCES IPs or hostnames of ONOS cluster machines"
27 echo " ONOS_WEB_USER username for REST API"
28 echo " ONOS_WEB_PASS password for REST API"
29 echo ""
30 echo "Example Usages:"
31 echo " # Collect compressed diagnostics for the cluster."
32 echo " # REST API user and password are drawn from environment variables."
33 echo " # Collection archive will be named /tmp/onos-diags.tar.gz"
34 echo " # The cluster node IPs will be drawn from ONOS_INSTANCES variable."
35 echo " > $(basename $0) "
36 echo ""
37 echo " # Collect diagnostics for the cluster and leave them extracted. "
38 echo " # Collection directory will be named /tmp/prague-diags/"
39 echo " # Collection archive will be named /tmp/prague-diags.tar.gz."
40 echo " # REST API user name is 'onos' and password is 'rules'."
41 echo " # The cluster node IPs will be drawn from ONOS_INSTANCES variable."
42 echo " > $(basename $0) -x -n prague -u onos -p rules"
43 echo ""
44 echo " # Collect compressed diagnostics for a cluster."
45 echo " # REST API user name is 'onos' and password is 'rules'."
46 echo " # Collection archive will be named /tmp/onos-diags.tar.gz"
47 echo " # The cluster node IPs are listed explicitly."
48 echo " > $(basename $0) -u onos -p rules 172.17.0.11 172.17.0.12 172.17.0.13"
49
50 exit 1
51}
52
Thomas Vachuska1c188d32018-04-16 14:02:18 -070053ONOS_WEB_USER=${ONOS_WEB_USER:-onos} # ONOS WEB User defaults to 'onos'
54ONOS_WEB_PASS=${ONOS_WEB_PASS:-rocks} # ONOS WEB Password defaults to 'rocks'
55ONOS_WEB_PORT=${ONOS_WEB_PORT:-8181} # REST API port defaults to '8181'
56
57. $(dirname $0)/_find-node
58
Charles Chan415bb232018-03-08 14:59:42 -080059# TODO We should make SR commands optional
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -080060CLI_COMMANDS=(
Thomas Vachuskae99e7a32018-02-01 15:52:10 -080061 "feature:repo-list"
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -080062 "feature:list"
63 "bundle:list"
64 "scr:list"
65
66 "summary"
67 "nodes"
68 "apps -s"
69 "netcfg"
70 "cfg get"
71
72 "devices"
73 "links"
74 "hosts"
Pier2d87c9f2018-04-05 20:45:40 +020075 "interfaces"
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -080076
77 "ports -e"
78 "portstats -nz"
79
Thomas Vachuskabee8a912018-02-28 10:02:16 -080080 "packet-processors"
81 "packet-requests"
82
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -080083 "intents"
84 "flows -s"
85 "groups"
86
87 "roles"
88 "masters"
89
Charles Chan415bb232018-03-08 14:59:42 -080090 "fpm-connections"
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -080091 "routes"
92 "obj-next-ids"
93 "obj-pending-nexts"
94
Charles Chan415bb232018-03-08 14:59:42 -080095 "sr-device-subnets"
96 "sr-ecmp-spg"
97 "sr-link-state"
98 "sr-mcast-next"
99 "sr-mcast-tree"
100 "sr-next-hops"
Andreas Pantelopoulosa1812332018-03-12 16:30:20 -0700101 "sr-pw-list"
Charles Chan415bb232018-03-08 14:59:42 -0800102 "dhcp-relay"
Pier2d87c9f2018-04-05 20:45:40 +0200103
104 "mcast-host-routes"
105 "mcast-host-show"
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -0800106)
107
Thomas Vachuska1c188d32018-04-16 14:02:18 -0700108port=${ONOS_WEB_PORT}
109user=${ONOS_WEB_USER}
110password=${ONOS_WEB_PASS}
111
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -0800112# Scan arguments for user/password or other options...
Thomas Vachuska1c188d32018-04-16 14:02:18 -0700113while getopts n:P:u:p:x?h o; do
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -0800114 case "$o" in
115 n) name=$OPTARG;;
Thomas Vachuska1c188d32018-04-16 14:02:18 -0700116 P) port=$OPTARG;;
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -0800117 u) user=$OPTARG;;
118 p) password=$OPTARG;;
119 x) extract=true;;
120 *) usage;;
121 esac
122done
Thomas Vachuskabee8a912018-02-28 10:02:16 -0800123
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -0800124let OPC=$OPTIND-1
125shift $OPC
126
127[ $# -lt 1 -a -z "$ONOS_INSTANCES" ] && usage;
128
129diags=/tmp/${name:-onos}-diags
130rm -fr $diags $diags.tar.gz; mkdir -p $diags
131
132[ -z $1 ] && nodes=$ONOS_INSTANCES || nodes=$*
133
134# Collect diagnostics from each cluster node
135for node in $nodes; do
136 printf "Collecting diagnostics on $node..."
137
138 # Prepare a clean place for collecting the node diagnostic data
139 cd $diags; rm -fr $node; mkdir -p $node; cd $node;
140
141 # Acquire locally obtained diagnostics via REST API and extract them
142 printf "logs "
143 curl -sS --fail --user $user:$password \
Thomas Vachuska1c188d32018-04-16 14:02:18 -0700144 http://$node:$port/onos/v1/diagnostics > ../$node.tar.gz
Thomas Vachuskabee8a912018-02-28 10:02:16 -0800145 tar zxf ../$node.tar.gz && rm ../$node.tar.gz
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -0800146
147 # Acquire remotely obtained diagnostics via ssh CLI
148 for cmd in "${CLI_COMMANDS[@]}"; do
149 cmdLog="$(echo $cmd | cut -d\ -f1 | sed 's/:/-/g').txt"
150 printf "$cmdLog "
151 onos $node $cmd 2>/dev/null >$cmdLog
152 done
153
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -0800154 printf " Done.\n"
Thomas Vachuskaaf0cf7a2018-01-30 13:57:38 -0800155done
156
157# Tar-up diagnostics from all the nodes
158cd $diags
159tar zcf $diags.tar.gz *
160[ -z $extract ] && rm -fr $diags