dontpanic

command module
v0.0.0-...-1475f2a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 6, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

README

DONTPANIC!!

dontpanic is a tool for debugging issues with Garden containers and their host environment. It collects and tars all necessary data to help Garden engineers investigate bugs. This data includes Garden logs and general system information. It should not contain any sensitive information, but you are free to review before sending to us. The Garden team is comprised of engineers from multiple companies and all bugs are investigated together. Your report will not be shared outside the team. A full list of what is collected can be found below.

From GRR v1.17.1 dontpanic comes installed on all VMs running the Garden job.

It should be run as root and the resulting tar sent to the Garden team: /var/vcap/packages/dontpanic/bin/dontpanic.

Those running GRR < v1.17.1 can download the latest dontpanic release and execute it on the host VM as root:

eg: wget https://github.com/cloudfoundry/dontpanic/releases/download/v1.1/dontpanic && chmod +x ./dontpanic && ./dontpanic.

What is in my report?

  • The current date
  • The machine's uptime and current load
  • The deployed gdn version
  • The machine hostname
  • Free memory
  • Operating system and kernel information
  • Monit summary
  • Monit logs
  • The number of running garden containers
  • The number of open files
  • The max number of open files permitted on the machine
  • The current disk usage
  • A list of all open files
  • Process table
  • Process tree
  • Kernel logs
  • System logs
  • Garden logs
  • Network interfaces
  • IP tables
  • The mount table
  • A list of the contents of Garden's depot (container metadata store) dir
  • XFS filesystem information
  • Memory structure information
  • General VM statistics (IO, Memory etc etc)
  • General process information

You can inspect which commands are being run to gather the above by looking at the code

How can I use the data in the report?

Sysstat

In the sysstat folder you can find multiple files containing system statistics (CPU, Memory, I/O, ...) over time.

In order to make use of this information, you need to do the following:

export LC_ALL=C
for file in $(ls sysstat/sa[0-9]*) ; do sar -A -f "$file"  >> sa.data.txt; done

and then use ksar to turn the result into pdf graphs.

There are 2 types of files in sysstat: sa* and sar*. The sas are binaries updated every 10 mins or so. The sars are text files generated once per day. Therefore you probably want to parse the sa files as they will be more current.

Note: ksar seems to dislike some lines in that file and will complain. What you can do is keep removing the zero lines until it is happy.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
collectors
grootfs/grootfsfakes
Code generated by counterfeiter.
Code generated by counterfeiter.
osreporterfakes
Code generated by counterfeiter.
Code generated by counterfeiter.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL