Pinpoint

Pinpoint的Pinpoint-Docker

Pinpoint应用监控组件的官方Docker化仓库。使用这些Docker文件安装Pinpoint大约需要10分钟来查看Pinpoint的功能。

Pinpoint是什么

Pinpoint是世界领先的开源应用监控解决方案 - 受到全球数百万用户的信赖。它支持并帮助您快速了解您的应用程序，让您能够构建世界级、高质量的软件。

要求

docker 18.02.0+

如何安装Pinpoint？

您可以使用Docker Compose和提供的任何docker-compose.yml文件轻松搭建完整的Docker化Pinpoint（最新版本）环境，如下所示。使用Pinpoint-Docker文件夹下的docker-compose.yml可以搭建包含Pinpoint-QuickStart（示例应用）的完整环境。要监控您的代理，请参阅配置部分以获取更多详细信息。

git clone https://github.com/pinpoint-apm/pinpoint-docker.git
cd pinpoint-docker
docker-compose pull && docker-compose up -d

从Pinpoint v2.5.0开始，添加了URI指标和基础设施指标。这些需要Apache Pinot集群才能工作，并且添加了docker-compose-metric.yml来提供它们。要使用URI指标和基础设施指标，请包含docker-compose-metric.yml来启动Pinpoint容器，如下所述。

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

自v2.5.1起提供了Pinpoint Web和Pinpoint Collector的Docker镜像，因此上述方法不适用于v2.5.0镜像。要使用Pinpoint v2.5.0指标模块，您需要先检出v2.5.0，然后使用以下命令预先构建镜像。

git clone https://github.com/pinpoint-apm/pinpoint-docker.git
cd pinpoint-docker
git checkout {tag}
docker-compose -f docker-compose.yml -f docker-compose-metric.yml build

如果您对指标模块不感兴趣，只需在docker-compose命令中删除-f docker-compose-metric.yml即可。

以下是本项目提供的镜像列表：

您可以用自己的应用程序替换QuickStart应用程序部分来开始监控。

查看测试QuickStart应用程序以快速演示pinpoint
查看监控您的应用程序部分以获取更多详细信息

以下是本项目所需的镜像列表：

Apache Zookeeper v3.4.13：用于Hbase和Pinpoint集群
Apache Zookeeper v3.8.0：用于Pinot集群
Apache Pinot：已测试v0.11.0 ~ v0.13.0。请参阅docker-compose-metric.yml中的pinot-init以进一步查看Pinpoint的表和架构信息。
Kafka：目前使用3.1-22.04_beta。请参阅docker-compose-metric.yml中的pinpoint-kafka-init以进一步查看Pinpoint所需的主题。

Mysql（可选，1.8.1+）

使用"警报"功能需要Pinpoint-Mysql。其服务器在端口13306上运行，包含用于注册用户、组和要发送的警报的数据结构。

要发送电子邮件警报，您必须将BATCH_ENABLE设置为true，并在*.env*文件中更改Pinpoint-Web服务器的其他邮件相关环境变量（MAIL_HOST、MAIL_PORT、MAIL_USERNAME、MAIL_PASSWORD、MAIL_PROPERTIES_MAIL_SMTP_FROM等）。

有关更多信息，请查看Pinpoint文档中的设置警报。

Flink配置（可选）

使用"应用程序检查器"功能需要Pinpoint-Flink。

在所有容器启动并准备就绪后，Pinpoint-Flink服务器在端口8081上运行。

警报配置（可选）

您可以查阅首页上的告警指南文档以全面了解。但对于 Docker 镜像来说，一切都已设置好。在启动容器之前，请填写 .env 文件中 #mail server information required 下的变量。

测试 QuickStart 应用程序

现在您已经准备好监控所提供的示例应用程序（Pinpoint-QuickStart 端口 8085）。如果您在 Pinpoint-Web 的首页（默认端口 8080）上找不到任何已连接的应用程序，请不要惊慌，稍等片刻。首次运行时，Pinpoint 需要一些时间来检索应用程序的信息。

监控您的应用程序

Pinpoint-Agent 仅准备了触发 Pinpoint-Agent 所需的库。运行和配置代理是由用户手动完成的操作，但不用担心，这非常简单。

如果您不熟悉 Pinpoint 的概念，请阅读：概述，代理安装

您需要将 Pinpoint-Agent 附加到您的应用程序。

单独运行 Pinpoint-Agent docker-compose，示例在这里。或者，您可以查看 Pinpoint-Quickstart 如何通过 docker-compose 附加到 Pinpoint-Agent。

我们将努力创建更多示例。如果有人能分享他们的 Dockerfile，我们随时欢迎。

分布式系统

到目前为止，所有组件都在一个 Docker 中，采用单节点方法，这非常适合测试和开发。它提供了一种简单的方法来原型化新想法和用例，以及尝试新功能和最新的 Pinpoint 版本。它并不适合也不支持生产环境使用。

您可以使用每个文件夹下的 docker-compose 和 .env 文件将模块分别安装到多个服务器上。如果容器是分开的，必须更改 .env 中的 IP 配置。

例如，如果您希望您的应用程序在一个 Docker 中运行，而 Pinpoint 的其余部分在另一个中运行。您可以从 docker-compose.yml 中移除 pinpoint-agent 和 pinpoint-quickstart，然后运行以建立 Pinpoint 的所有必要组件。然后创建另一个 docker-compose.yml，就像 pinpoint-quickstart 文件夹下的那样，来运行您的应用程序。最后，由于代理需要知道收集器的 IP，因此需要在 .env 中更改收集器 IP。

配置

配置依赖于为 docker-compose 提供在 .env 文件中定义的环境变量。因此建议只从 .env 文件中更改变量。使用本仓库中的 docker-compose，您可以创建运行 Pinpoint 大多数功能所需的独立容器。

端口也可以在 .env 文件中配置。（默认端口在 .env 文件中配置为 Pinpoint-Web:8080, Pinpoint-Batch:8079, Quickstart:8085 和 Flink:8081）

Pinpoint-Zookeeper 只是使用 Zookeeper 镜像的一个例子。您可以修改 docker-compose 文件以满足您的需求。

关于 .env 文件中值的更具体细节，请查看 Pinpoint Github 仓库或 Pinpoint Web 属性、Pinpoint Collector 属性、Pinpoint Agent 配置。请注意，pinpoint-docker(docker-compose) 仅采用了基本的配置选项。

日志

您可以查看这些服务产生的日志

docker logs <containerId>

您还可以轻松地从 .env 文件中更改日志级别。

有任何问题或建议？

欢迎通过 Pinpoint GitHub Issue 页面分享任何问题和建议。我们也一直欢迎对 pinpoint-docker 镜像的贡献。

许可证

Pinpoint 根据 Apache License, Version 2.0 授权。查看 LICENSE 获取完整的许可文本。

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.