StackStorm / StackStorm/st2

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

Open
#3,779 5 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

CLI enhancement good first issue
Dominant language
Python
Stars
6.5k
Forks
787
PR merge metrics
No merged PRs in 30d

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the st2ctl status implementation and the service definitions in /etc/st2/st2.conf; determine how existing process checks are organized and how connections to nginx, MongoDB, PostgreSQL, and RabbitMQ could be tested. Done means the command reports dependency status, including failures such as RabbitMQ being unavailable or broken.

Written by the indexing model from the issue text.

Assessment

Tech stack
mongodb, nginx, postgresql, python, rabbitmq
Domain
cli, databases, devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.