https://github.com/centic9/file-leak-postprocess

A small tool to post-process output from running an application with file-leak-detector
https://github.com/centic9/file-leak-postprocess

leak leaks

Last synced: about 1 month ago
JSON representation

A small tool to post-process output from running an application with file-leak-detector

• Host: GitHub
• URL: https://github.com/centic9/file-leak-postprocess
• Owner: centic9
• License: apache-2.0
• Created: 2022-03-12T13:24:09.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-26T05:27:29.000Z (about 2 months ago)
• Last Synced: 2024-10-04T13:07:26.952Z (about 2 months ago)
• Topics: leak, leaks
• Language: Java
• Homepage:
• Size: 227 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![Build Status](https://github.com/centic9/file-leak-postprocess/actions/workflows/gradle-build.yml/badge.svg)](https://github.com/centic9/file-leak-postprocess/actions)

[![Gradle Status](https://gradleupdate.appspot.com/centic9/file-leak-postprocess/status.svg?branch=master)](https://gradleupdate.appspot.com/centic9/file-leak-postprocess/status)

This is a small tool to post-process output from [file-leak-detector](https://github.com/jenkinsci/lib-file-leak-detector) when it is executed with `dumpatshutdown`.

file-leak-detector will simply print out all found stacktraces where file-handles were not closed. 

This has a few shortcomings when running on large-scale projects:

* Multiple equal stacktrace are printed, requiring to skim through many similar results

* Many lines in the stacktraces are unimportant for analyzing the file-handle leaks, 

  e.g. stack-trace lines from thread-pools, JUnit, ...

In order to make analyzing and fixing file-handle leaks easier, this tool parses one or more input 

text-files and extracts stacktraces that were produced by file-leak-detector and shortens and 

de-duplicate them into a smaller list of actual interesting code-locations.

The found stack-traces are printed to stdout. Summary/error information is printed to stderr.

So a typical invocation will redirect stdout to a file via `> file-handle-leaks.txt`

#### Getting started

##### Grab it

    git clone https://github.com/centic9/file-leak-postprocess.git

    cd file-leak-postprocess

##### Build it

    ./gradlew check installDist

#### Run it

    build/install/file-leak-postprocess/bin/file-leak-postprocess  > file-handle-leaks.txt

There is also a script `run.sh` which performs the necessary steps and thus allows to

run in one step

    ./run.sh /tmp/output.txt

### How it works

The actual code is quite small, it parses the text-files and parses all found stacktraces.

Then it shortens the stacks and de-duplicates them for output so each stacktrace is only

printed once.

### Support this project

If you find this tool useful and would like to support it, you can [Sponsor the author](https://github.com/sponsors/centic9)

### Licensing

   Copyright 2022-2024 Dominik Stadler

   Licensed under the Apache License, Version 2.0 (the "License");

   you may not use this file except in compliance with the License.

   You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)

   Unless required by applicable law or agreed to in writing, software

   distributed under the License is distributed on an "AS IS" BASIS,

   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   See the License for the specific language governing permissions and

   limitations under the License.