chef / chef/chef-server

Expand gather-logs command to better match Automate data

Open
#2,644 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Status: Adopted Status: Good First Issue Type: Enhancement
Dominant language
Erlang
Stars
303
Forks
211
Avg merge
1d 8h
Merged PRs (30d)
5

Description

Both Infra Server and Automate include a gather-logs command. We need are missing a lot of data that's included in the Automate gather logs. We should do our best to gather the same data so that we can process the data in a single pipeline more easily in the future.

Missing data (dir of file: what it is):

  • df_k.txt: output of df -k
  • dig-fqdn.txt: output of dig SYSTEMS_FQDN (replaced content in name-resolution.txt)
  • uname_a.txt: output of uname -a
  • ping_-c_2_fqdn.txt: output of ping -c 2 SYSTEMS_FQDN (replaced content in name-resolution.txt)
  • ping_-c_2_hostname.txt: output of ping -c 2 SYSTEMS_HOSTNAME (replaced content in name-resolution.txt)
  • /etc/hosts (replaced content in name-resolution.txt)
  • /etc/os-release
  • /etc/resolv.conf (replaced content in name-resolution.txt)
  • /etc/system-release
  • /proc/version
  • /proc/sys/crypto/fips_enabled

Rename:

  • free-m.txt -> free_m.txt
  • cpuinfo -> /proc/cpuinfo
  • meminfo -> /proc/meminfo

Add new data from Elasticsearch:

  • elasticsearch_cat_health.txt: http://localhost:10144/_cat/health?v
  • elasticsearch_cluster_health.txt: http://localhost:10144/_cluster/health?human&pretty
  • elasticsearch_cluster_pending_tasks.txt: http://localhost:10144/_cluster/pending_tasks?human&pretty
  • elasticsearch_cluster_settings.txt: http://localhost:10144/_cluster/settings?human&pretty
  • elasticsearch_cluster_state.txt: http://localhost:10144/_cluster/state?human&pretty
  • elasticsearch_cluster_stats.txt: http://localhost:10144/_cluster/stats?human&pretty
  • elasticsearch_nodes.txt: http://localhost:10144/_nodes?human&pretty
  • elasticsearch_nodes_all.txt: http://localhost:10144/_nodes/_all?human&pretty
  • elasticsearch_nodes_health.txt: http://localhost:10144/_nodes/health?human&pretty
  • elasticsearch_nodes_stats.txt: http://localhost:10144/_nodes/stats?human&pretty

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

Locate the Infra Server gather-logs command and compare its collected output with the Automate gather-logs data described in the issue. Check how the listed system files, renamed outputs, and Elasticsearch endpoints are gathered; done means the Infra Server archive includes the requested names and data for a shared processing pipeline.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch, erlang
Domain
cli, devops, observability
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.