Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

Troubleshoot Using the Deployment Shell CLI Commands

Read the following topics to understand how to use the Deployment Shell CLI commands to troubleshoot issues with your Routing Director cluster.

Overview

Routing Director enables you to troubleshoot Routing Director cluster-related issues using Deployment Shell CLI commands. To execute these Deployment Shell CLI troubleshooting commands, you must log in to any of the cluster nodes. When you execute these commands, a series of commands are executed one after the other.

The Deployment Shell CLI troubleshooting commands are:

Routing Director also enables you to debug issues by collecting data from the Redis database, Kafka messages, service logs, and the time series database (TSDB). These commands are not part of the Deployment Shell CLI troubleshooting commands, and must be run separately. See Other Troubleshooting Commands to Debug Issues for more information.

request deployment support information

The request deployment support information command displays an in-depth status report of your Routing Director cluster configuration.

The show commands that are executed when you run the request deployment support information command are listed in Table 1.

Table 1: request deployment support information Commands

Command

Description

show deployment cluster nodes

Show node information of your Routing Director cluster.

show deployment cluster pods

Show pod information of your Routing Director cluster.

show deployment cluster namespaces

Show namespace information of your Routing Director cluster.

show deployment cluster details

Show storage and controller node information of your Routing Director cluster.

show deployment version

Show the version of your Routing Director cluster.

show deployment images version

Show the version of pods in your Routing Director cluster.

show deployment cluster pods namespace healthbot sort memory

Show the top pods of the healthbot namespace sorted by memory utilization.

show deployment cluster pods namespace healthbot sort cpu

Show the top pods of the healthbot namespace sorted by CPU utilization.

show deployment pvc details

Show the persistent volume (PV) and persistent volume claim (PVC) information.

The request deployment support information command also runs many kubectl commands. These commands provide you debugging information such as Helm deployment service information for the NorthStar namespace, Kubernetes deployment information for api-aggregator service and so on.

request deployment troubleshooting information

The request deployment troubleshooting information command provides troubleshooting information of the ems, foghorn, insights, paa, trust, and pathfinder Routing Director services.

To view the list of available services, run the following command:

When you run the request deployment troubleshooting information command, a troubleshooting_date_time.tar.gz file is generated. You can share this file with the Juniper Technical Assistance Center (JTAC) for further evaluation. This .tar.gz file is saved in the /root/troubleshooting/ directory.

The commands that are executed when you run the request deployment troubleshooting information command are listed in Table 2.

Table 2: request deployment troubleshooting information Commands

Command

Description

request deployment debug logs namespace healthbot service tsdb-shim

Generate a log file of the tsdb-shim service within the healthbot namespace.

request deployment debug logs namespace healthbot service tand

Generate a log file of the tand service within the healthbot namespace.

request deployment debug logs namespace healthbot service jtimon

Generate a log file of the jtimon service within the healthbot namespace.

request deployment debug logs namespace healthbot service config-server container config-server

Generate a log file of the config-server service within the healthbot namespace.

request deployment debug logs namespace healthbot service api-server

Generate a log file of the api-server service within the healthbot namespace.

request deployment debug logs namespace healthbot service analytical-engine

Generate a log file of the analytical-engine service within the healthbot namespace.

request deployment debug logs namespace healthbot service alerta

Generate a log file of the alerta service within the healthbot namespace.

request deployment debug postgres database postgres username healthbot measurement db_counters output file

Generate a text file (JSON format) with Postgres information.

request deployment debug logs namespace foghorn service order-management

Generate a log file of the order-management service within the foghorn namespace.

request deployment debug logs namespace foghorn service placement

Generate a log file of the placement service within the foghorn namespace.

request deployment debug logs namespace foghorn service cmgd

Generate a log file of the cmgd service within the foghorn namespace.

request deployment debug logs namespace airflow service workflow-manager

Generate a log file of the workflow-manager service within the airflow namespace.

request deployment debug logs namespace northstar service toposerver

Generate a log file of the toposerver service within the northstar namespace.

request deployment debug logs namespace northstar service configmonitor

Generate a log file of the configmonitor service within the northstar namespace.

request deployment debug logs namespace northstar service web

Generate a log file of the web service within the northstar namespace.

request deployment debug logs namespace northstar service api-aggregator

Generate a log file of the api-aggregator service within the northstar namespace.

request deployment debug logs namespace papi service oc-term

Generate a log file of the oc-term service within the papi namespace.

request deployment debug logs namespace papi service papi

Generate a log file of the papi service within the papi namespace.

request deployment debug logs namespace papi service papi-ws

Generate a log file of the papi-ws service within the papi namespace.

Other Troubleshooting Commands to Debug Issues

You can run commands to collect data from the Redis database, Kafka messages, service logs, and the time series database (TSDB). You can use this data to troubleshoot issues with your Routing Director cluster. These commands are not part of the Deployment Shell CLI troubleshooting commands, and must be run separately. Table 3 lists the commands.

Table 3: Alternative Commands to Debug Issues

Command

Description

Kafka

request deployment debug kafka ?

Display possible completions for the request deployment debug kafka command.

request deployment debug kafka options "-C -t topic-name -o s@start-time -o e@end-time -e -JB" output-file "file-name"

Generate an output file of Kafka messages for a topic for a specified period of time.

Insights Kafka

request deployment debug insights-kafka-data ?

Display possible completions for the request deployment debug insights-kafka-data command.

request deployment debug insights-kafka-data device "device-id" time-period "duration"

Display insights-kafka-data information for a device, for a specific time period. An output file of the information is generated.

Redis

request deployment debug redis ?

Display possible completions for the request deployment debug redis command.

request deployment debug redis redis-key-pattern "insights"

Display Redis key pattern information for redis-keys with pattern "insights".

request deployment debug redis-key-pattern "insights" output file

Generate an output file of Redis key pattern information for redis-keys with pattern "insights".

Service Logs

request deployment debug logs ?

Display possible completions for the request deployment debug logs command.

request deployment debug logs namespace name service service-name time duration

Generate a log file for a service within a namespace for the specified time period.

TSDB

request deployment debug get-tsdb-data ?

Display possible completions for the request deployment debug get-tsdb-data command.

request deployment debug get-tsdb-data device device-id topic "topic-name" output file

Generate an output file of TSDB data for a particular device.

Postgres

request deployment debug postgres ?

Display possible completions for the request deployment debug postgres command.

request deployment debug postgres database database-name username username measurement measurement-name output (file)

Generate an output file of the measurement value information of the Postgres database.