Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/psi-probe/psi-probe

Advanced manager and monitor for Apache Tomcat, forked from Lambda Probe
https://github.com/psi-probe/psi-probe

java psi-probe tomcat

Last synced: 30 days ago
JSON representation

Advanced manager and monitor for Apache Tomcat, forked from Lambda Probe

Awesome Lists containing this project

README

        

# PSI Probe

[![Java CI](https://github.com/psi-probe/psi-probe/workflows/Java%20CI/badge.svg)](https://github.com/psi-probe/psi-probe/actions?query=workflow%3A%22Java+CI%22)
[![Coverity](https://scan.coverity.com/projects/28366/badge.svg)](https://scan.coverity.com/projects/28366)
[![Coveralls](https://coveralls.io/repos/github/psi-probe/psi-probe/badge.svg?branch=master)](https://coveralls.io/github/psi-probe/psi-probe?branch=master)
[![Known Vulnerabilities](https://snyk.io/test/github/psi-probe/psi-probe/badge.svg)](https://snyk.io/test/github/psi-probe/psi-probe)
[![Maven Central](https://img.shields.io/maven-central/v/com.github.psi-probe/psi-probe-web)](https://maven-badges.herokuapp.com/maven-central/com.github.psi-probe/psi-probe-web)
[![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/https/oss.sonatype.org/com.github.psi-probe/psi-probe-web.svg)](https://oss.sonatype.org/content/repositories/snapshots/org/psi-probe/psi-probe-web/)
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
[![Releases](https://img.shields.io/github/downloads/psi-probe/psi-probe/psi-probe-4.1.1/total)](https://github.com/psi-probe/psi-probe/releases/download/psi-probe-4.1.1/probe.war)
[![GPLv2 License](https://img.shields.io/badge/license-GPLv2-green.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
[![Project Stats](https://www.openhub.net/p/psi-probe/widgets/project_thin_badge.gif)](https://www.openhub.net/p/psi-probe)
[![Github All Releases](https://img.shields.io/github/downloads/psi-probe/psi-probe/total.svg)]()

![psi-probe](src/site/resources/images/psi-probe-banner.jpg)

## Sites ##

* [site](https://psi-probe.github.io/psi-probe/)
* [sonarqube](https://sonarcloud.io/project/overview?id=psi-probe_psi-probe)

## Contributing ##

See [CONTRIBUTING.md](CONTRIBUTING.md) for info on working on PSI Probe and sending patches.

## Latest Release via Github Releases ##

Please download latest probe.war from [here](https://github.com/psi-probe/psi-probe/releases/download/psi-probe-4.1.1/probe.war)

## Latest Release via Maven Central ##

Please download latest psi-probe-web.war release from [here](https://oss.sonatype.org/content/repositories/releases/com/github/psi-probe/psi-probe-web/)

You can rename 'psi-probe-web.war' to the traditional 'probe.war' or other name as you see fit.

## Latest Snapshot via Maven Central ##

Please download latest psi-probe-web.war snapshots from [here](https://oss.sonatype.org/content/repositories/snapshots/com/github/psi-probe/psi-probe-web/)

You can rename 'psi-probe-web.war' to the traditional 'probe.war' or other name as you see fit.

## Building from Source ##

1. **Clone PSI Probe's git repository.**

*Note: If you plan to contribute to PSI Probe, you should create your own fork on GitHub first and clone that. Otherwise, follow these steps to build the latest version of PSI Probe for yourself.*

Execute the following command:

git clone https://github.com/psi-probe/psi-probe

This will create directory called `psi-probe`. Subsequent steps will refer to this as "your PSI Probe base directory."

2. Minimum JDK version required to build is JDK 11 and run is JDK 8.

3. **Download and install Maven 3.9.6 or better

You may download it from the [Apache Maven website](https://maven.apache.org/download.cgi).

4. **Run Maven.**

Execute the following command from your PSI Probe base directory:

mvn package

This will create a deployable file at `web/target/probe.war`.

## Supported Tomcat Versions

Generally supported versions for third party tomcat providers align with their support but earlier versions may still work. It is advisable in every case to use only supported tomcat releases per specific vendor. Our support will only be against non CVE releases.

* Tomcat 8.5 Series (Notice: We will drop support for tomcat 8.5 after tomcat officially archives it shortly after 3/31/2024 and we will complete a final release before that is done)

- Tomcat 8.5.86 to 8.5.97 (Stated end of life will be 3/31/2024, considering using tomcat 9 or better)
- TomEE 7.1 Discontinued, suggest to use TomEE 8.0 or better. TomEE no longer supports tomcat 8.5
- NonStop(tm) Servlets For JavaServer Pages(tm) v8.5 (Based on Tomcat 8.5.78)
- Pivotal tc 4.1.29 release with addon only (Based on Tomcat 8.5.97)

* Tomcat 9.0 Series

- Tomcat 9.0.72 to 9.0.85
- TomEE 8.0.16 (Based on Tomcat 9.0.82). TomEE is ending support on December 31st 2023
- NonStop(tm) never supported 9.0 as they changed direction but seem to have come back now for 10.1
- Pivotal tc 4.1.29 release (Based on Tomcat 9.0.84)
- Vmware tc 5.0.8 release (Based on Tomcat 9.0.84)

* Tomcat 10.0 Series (discontinued by tomcat / not released by psi probe yet)

- TomEE 9.1.2 (Based on Tomcat 10.0.27)

* Tomcat 10.1 Series (not released by psi probe yet - issues with hop from tomcat 10.0.27 to 10.1.x)

- Tomcat 10.1.6 to 10.1.18
- TomEE - no support yet for 10.1
- NonStop(tm) Servlets For JavaServer Pages(tm) v10.1 (Based on Tomcat 10.1.7)
- Vmware tc 5.0.8 release (Based on Tomcat 10.1.17)

* Tomcat 11.0 Series (pending)

- Tomcat 11.0.0.M3 to 11.0.0.M16

## Precondition

PSI Probe uses deep reflection to access data. Take care your tomcat configuration considers this.
You can do this by extending the JDK_JAVA_OPTIONS variable:

...
--add-opens=java.base/java.lang=ALL-UNNAMED \
--add-opens=java.base/java.io=ALL-UNNAMED \
--add-opens=java.base/java.util=ALL-UNNAMED \
--add-opens=java.base/java.util.concurrent=ALL-UNNAMED \
--add-opens=java.rmi/sun.rmi.transport=ALL-UNNAMED \
...

## User Groups

* [Announcements](https://groups.google.com/forum/#!forum/psi-probe)
* [Discussions](https://groups.google.com/forum/#!forum/psi-probe-discuss)
* [Slack](https://psi-probe.slack.com/)

## FAQ

* [Adding Additional Loggers](https://github.com/psi-probe/psi-probe/wiki/Adding-Additional-Loggers)
* [Forcing tomcat version](https://github.com/psi-probe/psi-probe/wiki/Troubleshooting#error-on-first-request)