Skip to content

Add performance-data-setup.sh and usage doc #708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: vNext
Choose a base branch
from
Open

Add performance-data-setup.sh and usage doc #708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
- [Installing Liberty Features from local repository (19.0.0.8+)](#installing-liberty-features-from-local-repository-19008)
- [Locally hosting feature repository](#locally-hosting-feature-repository)
- [Using locally hosted feature repository in Dockerfile](#using-locally-hosted-feautre-repository-in-dockerfile)
- [Running Liberty MustGather](#running-liberty-mustgather)
- [Known Issues](#known-issues)
- [Issues and Contributions](#issues-and-contributions)
- [License](#license)
Expand Down Expand Up @@ -322,6 +323,19 @@ ARG VERBOSE=false
RUN configure.sh
```

## Running Liberty MustGather

The [Liberty MustGather script](https://www.ibm.com/support/pages/mustgather-performance-hang-or-high-cpu-issues-liberty-linux) can be run within your container to collect critical data for debugging issues relating to performance degradation, hang, no response, hung threads, CPU starvation, high CPU utilization, or deadlocks with Liberty on Linux.

Include the following snippet into your Dockerfile definition to install the required packages for running `linperf.sh` in the Liberty container.

```
# Temporarily provide root access to install required packages
USER 0
RUN performance-data-setup.sh
USER 1001
```

# Known Issues

For the list of known issues related to images, see the [Known Issues](https://github.com/OpenLiberty/ci.docker#known-issues) section for Open Liberty.
Expand Down
14 changes: 14 additions & 0 deletions ga/latest/kernel/helpers/build/performance-data-setup.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/bin/bash

. /opt/ibm/helpers/build/internal/logger.sh

set -Eeox pipefail

pkgcmd=yum
if ! command $pkgcmd
then
pkgcmd=microdnf
fi

$pkgcmd update -y
$pkgcmd install -y procps-ng net-tools ncurses hostname