elastic / elastic/eck-diagnostics

[Enhancement Request] Separate ECK diagnostics and ES/Kibana Diagnostics into different folders

Open
#124 0 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Go
Stars
29
Forks
21
Avg merge
3d 13h
Merged PRs (30d)
10

Description

Currently, when taking an ECK diagnostic, we will get an "all-in-one" compressed file containing ECK diagnostic bundle, ES diagnostic bundle, and Kibana diagnostic bundle.

Although it's handy to have them in one file, some recent feedback comments from our support team internally are, it might be better to reformat it, into 3 separate bundle folders
- 1st for ECK diagnostic bundle
- 2nd for ES diagnostic bundle
- 3rd for Kibana diagnostic bundle

The biggest reason here is due to an internal reason, that we now have an analyzer tool to use for supporting purpose.
However, when it comes to an all-in-one file, it adds extra processes to unzip it > pick up the ES diag > zip it again > upload it to our internal tool.

(Things might change eventually based on our internal tool's improvement. However, for now, it could benefit folks more if we could zip them into separate folders.)

Side notes:
About file name, there's no special constraint/limitation/requirement on this part.
There's a `manifest.json` inside the diagnostic bundle (for ES and Kibana) and our internal tool relies on that to parse.
So it can be any name that makes logical sense, i.e.
- for ES diag: `es-local-diagnostics-20220907-021328.zip`
- for Kibana diag: `kb-local-diagnostics-20220907-021530.zip`

Format convention:
- component name - local/api (depending on which type is used) - diagnostics - date - time.zip

---

cc @VimCommando as we talked it in an internal meeting for this topic.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue does not name specific files or tests. Start by locating the code that creates the all-in-one compressed diagnostic bundle and inspect how ECK, Elasticsearch, and Kibana outputs are packaged. Done means the outputs are separated into three bundles or folders, with ES and Kibana bundles retaining manifest.json and sensible component/type/date/time names.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.