scylladb/scylladb

Upload of health check report to upload.scylladb.com

Open

#2800 opened on Sep 14, 2017

View on GitHub
 (0 comments) (0 reactions) (1 assignee)C++ (11,972 stars) (1,169 forks)batch import
good_first_issuesymptom/ux

Description

Installation details Scylla version (or git commit hash): 2.0

node_health_check.sh is a tool for collecting relevant information on Scylla. A documented procedure allows one to upload the report to a upload.scylladb.com for the Scylla team to check.

It will be easier for users to simplify these steps by including the uploading as an optional part of a script.

For example

> report_node_health.sh
Your report was uploaded to http://upload.scylladb.com/0af4c623-3f30-47db-b9b2-6f49101f0906/

(internally running node_health_check.sh)

Contributor guide

Tech stack
shellrest api
Domain
devopscli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic shell scriptingUnderstanding of HTTP requests
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue is old but still open. The main file to modify is the node health check.sh script. Look into how the script currently collects information and add an optional flag (e.g., upload) that uses curl to send the report to upload.scylladb.com. Reference the documented procedure at http://docs.scylladb.com/operating scylla/troubleshooting/report scylla problem/ for the exact endpoint and required data format. Ensure the script outputs the unique URL returned by the server.