StackStorm/st2

`st2ctl status` should report nginx, MongoDB, PostgreSQL & RabbitMQ status

Open

#3779 opened on Oct 5, 2017

View on GitHub
 (5 comments) (2 reactions) (0 assignees)Python (5,794 stars) (740 forks)batch import
CLIenhancementgood first issue

Description

st2ctl status reports on the status of st2 processes. It does not report anything about nginx, MongoDB, PostgreSQL or RabbitMQ.

This can be confusing for users who are experiencing issues with those services. They run st2ctl status, and it appears to report that everything is working, when in reality RabbitMQ is broken because they ran out of disk space. This wastes everyone's time.

The challenge here is that those dependencies may be running on a separate system.

Perhaps we should add a check that makes a test connection to those services (based on their definition in /etc/st2/st2.conf, and reports the results?

Contributor guide

Tech stack
pythonmongodbpostgresqlrabbitmq
Domain
backenddevopsinfrastructure
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Pythonst2ctl command structurest2.conf configurationbasic networking
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Investigate the existing st2ctl command implementation to understand how it currently reports status. Look at the configuration file `/etc/st2/st2.conf` to see how connection parameters for nginx, MongoDB, PostgreSQL, and RabbitMQ are defined. Determine a method to test connectivity to each service (e.g., using Python clients or system commands). Implement the checks and integrate them into the st2ctl status output. Review any existing comments in the issue for additional insights.