From 35d0b8ecd350341e56941ad9d0747a355478bd50 Mon Sep 17 00:00:00 2001 From: Roy Kim Date: Thu, 20 Dec 2018 16:50:16 +0900 Subject: [PATCH] [#noissue] update readme on pinpoint-mysql --- Readme.md | 12 +++++++----- pinpoint-mysql/Readme.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 5 deletions(-) create mode 100644 pinpoint-mysql/Readme.md diff --git a/Readme.md b/Readme.md index bb1f9e1..c867a4a 100644 --- a/Readme.md +++ b/Readme.md @@ -38,12 +38,12 @@ You can also just build the image with `docker-compose up -d` command without pu This will install and run all services required to run all features in Pinpoint in docker containers joined with same network. - Pinpoint-Web Server - Pinpoint-Collector - - Pinpoint-Agent(ready to be used) - - Pinpoint-Flink + - Pinpoint-Agent + - Pinpoint-Flink(just for certain feature) - Pinpoint-Zookeeper - Pinpoint-Hbase - Pinpoint-QuickStart(a sample application) - - Pinpoint-Mysql + - Pinpoint-Mysql(just for certain feature) This may take several minutes to download all necessary images. You can replace `QuickStart` application part with your application to start monitoring. @@ -52,14 +52,16 @@ You can replace `QuickStart` application part with your application to start mon ### Mysql (optional) -The Pinpoint-Mysql 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. To send email alerts, you must make BATCH_ENABLE=true and change the other mail-related environment variables (MAIL_HOST, MAIL_PORT, MAIL_USERNAME, MAIL_PASSWORD, MAIL_PROPERTIES_MAIL_SMTP_FROM, ...) to the Pinpoint-Web server in *.env* file. -For more information see [Setting Alarm](http://naver.github.io/pinpoint/alarm.html) in Pinpoint documentation. +For more information checkout [Setting Alarm](http://naver.github.io/pinpoint/alarm.html) in Pinpoint documentation. ### Flink configuration (optional) +The Pinpoint-Flink is necessary to use ['Application Inspector'](http://naver.github.io/pinpoint/applicationinspector.html) feature. + After all containers are started and ready to go. There is one more thing to do to use all existing features in Pinpoint. It's not mandatory, but to use all the features and since it's a simple task, let's take care of it. diff --git a/pinpoint-mysql/Readme.md b/pinpoint-mysql/Readme.md new file mode 100644 index 0000000..91168c2 --- /dev/null +++ b/pinpoint-mysql/Readme.md @@ -0,0 +1,38 @@ + +## Pinpoint Mysql + +This Docker image contains the Pinpoint Mysql component of the Pinpoint application monitoring system. + +## Supported Tags + + - 1.8.0 + - 1.7.3 + - 1.7.2 + +Please see [Pinpoint-Docker GitHub repository](https://github.com/naver/pinpoint-docker) for further information on how to run, configure and build this image. + +## Any Issues or Suggestions? + +Feel free to share any problems and suggestions via [Pinpoint GitHub Issue page](https://github.com/naver/pinpoint/issues). +Contributions on the pinpoint-docker image is also always welcome. + +## License + +Pinpoint is licensed under the Apache License, Version 2.0. +See [LICENSE](https://github.com/naver/pinpoint/blob/master/LICENSE) for full license text. + +``` +Copyright 2018 NAVER Corp. + +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 + +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. +``` \ No newline at end of file