MyoaEngineering
/
pinpoint-docker-fork
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme

This commit is contained in:
ga-ram 2023-04-17 18:42:22 +09:00
parent 60da18daac
commit c2e3c3ed00
3 changed files with 34 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
Readme.md
View File

@ -12,6 +12,7 @@ Installing Pinpoint with these docker files will take approximately 10min. to ch
It supports and helps you understand your application in a glance and allow you to build world-class, high-quality software. It supports and helps you understand your application in a glance and allow you to build world-class, high-quality software.
## Supported Tags ## Supported Tags
- 2.5.1-metric (for web and collector)
- 2.5.1 - 2.5.1
- 2.5.0 - 2.5.0
- 2.4.2 - 2.4.2
@ -56,33 +57,50 @@ git clone https://github.com/pinpoint-apm/pinpoint-docker.git
cd pinpoint-docker cd pinpoint-docker
docker-compose pull && docker-compose up -d docker-compose pull && docker-compose up -d
``` ```
If you'd like to bring up a previous release. Try with docker-compose file from other tags.
Since [Pinpoint v2.5.0](https://github.com/pinpoint-apm/pinpoint/releases/tag/v2.5.0), URI Metric and Infrastructure Metric are added.
These need Apache Pinot cluster to work and [docker-compose-metric.yml](https://github.com/pinpoint-apm/pinpoint-docker/blob/master/docker-compose-metric.yml) has been added to provide them.
To use URI Metric and Infrastructure Metric, include `docker-compose-metric.yml` to bring up Pinpoint containers as decribed below.
```
git clone https://github.com/pinpoint-apm/pinpoint-docker.git
cd pinpoint-docker
docker-compose pull
docker-compose -f docker-compose.yml -f docker-compose-metric.yml up -d
```
Docker images for Pinpoint web and Pinpoint collector is provided since **v2.5.1**, so above wouldn't work with v2.5.0 images.
To use Pinpoint v2.5.0 metric modules, you need to checkout v2.5.0 and then build the images ahead with below command.
``` ```
git clone https://github.com/pinpoint-apm/pinpoint-docker.git git clone https://github.com/pinpoint-apm/pinpoint-docker.git
cd pinpoint-docker cd pinpoint-docker
git checkout {tag} git checkout {tag}
docker-compose pull && docker-compose up -d docker-compose -f docker-compose.yml -f docker-compose-metric.yml build
``` ```
You can also build the image with `docker-compose up -d` command without pulling the image. But you can reduce the time to 1/3 by just downloading them. If you are not interested in metric modules, simply remove `-f docker-compose-metric.yml` in docker-compose commands.
This will install and run all services required to run all features in Pinpoint in docker containers joined with same network. Below are the list of images provided by this project:
- Pinpoint-Web Server - [Pinpoint-Web Server](https://hub.docker.com/r/pinpointdocker/pinpoint-web)
- Pinpoint-Collector - [Pinpoint-Collector](https://hub.docker.com/repository/docker/pinpointdocker/pinpoint-collector/)
- Pinpoint-Agent - [Pinpoint-Agent](https://hub.docker.com/r/pinpointdocker/pinpoint-agent)
- Pinpoint-Flink(to support certain feature) - [Pinpoint-Flink](https://hub.docker.com/r/pinpointdocker/pinpoint-flink)
- Pinpoint-Zookeeper - [Pinpoint-Hbase](https://hub.docker.com/r/pinpointdocker/pinpoint-hbase)
- Pinpoint-Hbase - [Pinpoint-QuickStart](https://hub.docker.com/r/pinpointdocker/pinpoint-quickstart): a sample application, v1.8.1+
- Pinpoint-QuickStart(a sample application, 1.8.1+) - [Pinpoint-Mysql](https://hub.docker.com/r/pinpointdocker/pinpoint-mysql)
- Pinpoint-Mysql(to support certain feature) - [Pinpoint-Batch](https://hub.docker.com/r/pinpointdocker/pinpoint-batch): v2.4.0+
- Pinpoint-Batch
This may take several minutes to download all necessary images.
You can replace `QuickStart` application part with your application to start monitoring. You can replace `QuickStart` application part with your application to start monitoring.
- check [`Testing QuickStart application`](#testing-quickstart-application) for a quick demo of pinpoint - check [`Testing QuickStart application`](#testing-quickstart-application) for a quick demo of pinpoint
- check [`Monitoring YOUR Application`](#monitoring-your-application) part for further details - check [`Monitoring YOUR Application`](#monitoring-your-application) part for further details
Below are the list of images required for this project:
- [Apache Zookeeper v3.4.13](https://hub.docker.com/_/zookeeper/tags?page=1&name=3.4.13): For Hbase and Pinpoint cluster
- [Apache Zookeeper v3.8.0](https://hub.docker.com/_/zookeeper/tags?page=1&name=3.8.0): For Pinot cluster
- [Apache Pinot](https://hub.docker.com/r/apachepinot/pinot): Tested with v0.11.0 ~ v0.13.0. Please refer to `pinot-init` in `docker-compose-metric.yml` to further see tables and schema information for Pinpoint.
- [Kafka](https://hub.docker.com/r/ubuntu/kafka): Currently using 3.1-22.04_beta. Please refer to `pinpoint-kafka-init` in `docker-compose-metric.yml` to further see topics needed for Pinpoint.
### Mysql (optional, 1.8.1+) ### Mysql (optional, 1.8.1+)
The Pinpoint-Mysql is necessary to use 'Alarm' feature. It's server is running on port 13306 and contains the data structure used to register users, groups, and alerts to be sent. The Pinpoint-Mysql is necessary to use 'Alarm' feature. It's server is running on port 13306 and contains the data structure used to register users, groups, and alerts to be sent.

1
pinpoint-collector/Readme.md
View File

@ -5,6 +5,7 @@ This Docker image contains the Pinpoint Collector component of the Pinpoint appl
## Supported Tags ## Supported Tags
- 2.5.1 - 2.5.1
- 2.5.1-metric
- 2.5.0 - 2.5.0
- 2.4.2 - 2.4.2
- 2.4.1 - 2.4.1

1
pinpoint-web/Readme.md
View File

@ -5,6 +5,7 @@ This Docker image contains the Pinpoint Web component of the Pinpoint applicatio
## Supported Tags ## Supported Tags
- 2.5.1 - 2.5.1
- 2.5.1-metric
- 2.5.0 - 2.5.0
- 2.4.2 - 2.4.2
- 2.4.1 - 2.4.1