{"id":19453303,"url":"https://github.com/pinpoint-apm/pinpoint-docker","last_synced_at":"2025-05-15T08:11:35.180Z","repository":{"id":39612622,"uuid":"132071938","full_name":"pinpoint-apm/pinpoint-docker","owner":"pinpoint-apm","description":"Official Dockerized components of the Pinpoint","archived":false,"fork":false,"pushed_at":"2025-03-26T11:03:48.000Z","size":250150,"stargazers_count":473,"open_issues_count":52,"forks_count":229,"subscribers_count":31,"default_branch":"master","last_synced_at":"2025-04-11T19:55:21.542Z","etag":null,"topics":["apm","docker","naver","pinpoint","pinpoint-docker"],"latest_commit_sha":null,"homepage":"http://pinpoint-apm.github.io/pinpoint/","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pinpoint-apm.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":"License","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-05-04T01:57:29.000Z","updated_at":"2025-04-05T08:16:51.000Z","dependencies_parsed_at":"2025-04-11T16:29:59.265Z","dependency_job_id":null,"html_url":"https://github.com/pinpoint-apm/pinpoint-docker","commit_stats":{"total_commits":114,"total_committers":14,"mean_commits":8.142857142857142,"dds":0.5350877192982456,"last_synced_commit":"32583196496d7ca7c0509e897e5c657e26d4961a"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinpoint-apm%2Fpinpoint-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinpoint-apm%2Fpinpoint-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinpoint-apm%2Fpinpoint-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pinpoint-apm%2Fpinpoint-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pinpoint-apm","download_url":"https://codeload.github.com/pinpoint-apm/pinpoint-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254301613,"owners_count":22047905,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apm","docker","naver","pinpoint","pinpoint-docker"],"created_at":"2024-11-10T17:03:43.039Z","updated_at":"2025-05-15T08:11:30.172Z","avatar_url":"https://github.com/pinpoint-apm.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n![Pinpoint](https://github.com/pinpoint-apm/pinpoint-docker/blob/master/docs/logo.png)\n\n# Pinpoint-Docker for Pinpoint\n\nOfficial git repository of Dockerized components of the [Pinpoint Application Monitoring](https://github.com/pinpoint-apm/pinpoint).  \nInstalling Pinpoint with these docker files will take approximately 10min. to check out the features of pinpoint.\n\n## What is Pinpoint\n\n[Pinpoint](https://github.com/pinpoint-apm/pinpoint), is the world's leading open-source application monitoring solution - trusted by millions of users around the globe.\nIt supports and helps you understand your application in a glance and allow you to build world-class, high-quality software.\n\n## Requirements\n\n- [docker 18.02.0+](https://docs.docker.com/compose/compose-file/)\n\n## How to install Pinpoint?\n\nYou can easily bring up an entire Dockerized Pinpoint(latest release) environment by using [Docker Compose](https://docs.docker.com/compose/) with any of the provided `docker-compose.yml` files  as below.  \nWith `docker-compose.yml` under *Pinpoint-Docker* folder brings up all the environment attached with Pinpoint-QuickStart(sample app).\nTo monitor your agent see [configuration part](#configurations) for further details.  \n\n```\ngit clone https://github.com/pinpoint-apm/pinpoint-docker.git\ncd pinpoint-docker\ndocker-compose pull \u0026\u0026 docker-compose up -d\n```\n\nSince [Pinpoint v2.5.0](https://github.com/pinpoint-apm/pinpoint/releases/tag/v2.5.0), URI Metric and Infrastructure Metric are added.\nThese 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.\nTo use URI Metric and Infrastructure Metric, include `docker-compose-metric.yml` to bring up Pinpoint containers as decribed below.\n\n```\ngit clone https://github.com/pinpoint-apm/pinpoint-docker.git\ncd pinpoint-docker\ndocker-compose pull\ndocker-compose -f docker-compose.yml -f docker-compose-metric.yml up -d\n```\n\nDocker images for Pinpoint web and Pinpoint collector is provided since **v2.5.1**, so above wouldn't work with v2.5.0 images.\nTo use Pinpoint v2.5.0 metric modules, you need to checkout v2.5.0 and then build the images ahead with below command.\n\n```\ngit clone https://github.com/pinpoint-apm/pinpoint-docker.git\ncd pinpoint-docker\ngit checkout {tag}\ndocker-compose -f docker-compose.yml -f docker-compose-metric.yml build\n```\n\nIf you are not interested in metric modules, simply remove `-f docker-compose-metric.yml` in docker-compose commands.\n\nBelow are the list of images provided by this project:\n - [Pinpoint-Web Server](https://hub.docker.com/r/pinpointdocker/pinpoint-web)\n - [Pinpoint-Collector](https://hub.docker.com/repository/docker/pinpointdocker/pinpoint-collector/)\n - [Pinpoint-Agent](https://hub.docker.com/r/pinpointdocker/pinpoint-agent)\n - [Pinpoint-Flink](https://hub.docker.com/r/pinpointdocker/pinpoint-flink)\n - [Pinpoint-Hbase](https://hub.docker.com/r/pinpointdocker/pinpoint-hbase)\n - [Pinpoint-QuickStart](https://hub.docker.com/r/pinpointdocker/pinpoint-quickstart): a sample application, v1.8.1+\n - [Pinpoint-Mysql](https://hub.docker.com/r/pinpointdocker/pinpoint-mysql)\n - [Pinpoint-Batch](https://hub.docker.com/r/pinpointdocker/pinpoint-batch): v2.4.0+\n\nYou can replace `QuickStart` application part with your application to start monitoring.  \n - check [`Testing QuickStart application`](#testing-quickstart-application) for a quick demo of pinpoint\n - check [`Monitoring YOUR Application`](#monitoring-your-application) part for further details\n\nBelow are the list of images required for this project:\n - [Apache Zookeeper v3.4.13](https://hub.docker.com/_/zookeeper/tags?page=1\u0026name=3.4.13): For Hbase and Pinpoint cluster\n - [Apache Zookeeper v3.8.0](https://hub.docker.com/_/zookeeper/tags?page=1\u0026name=3.8.0): For Pinot cluster \n - [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.\n - [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.\n\n### Mysql (optional, 1.8.1+)\n\nThe 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.\n\nTo 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.\n\nFor more information checkout [Setting Alarm](http://pinpoint-apm.github.io/pinpoint/alarm.html) in Pinpoint documentation.\n\n### Flink configuration (optional)\n\nThe Pinpoint-Flink is necessary to use ['Application Inspector'](https://pinpoint-apm.github.io/pinpoint/applicationinspector.html) feature. \n\nAfter all containers are started and ready to go. Pinpoint-Flink server is running on [port 8081](http://localhost:8081/). \n\n### Alarm configuration (optional)\n\nYou can check the [alarm guide document at the homepage](https://pinpoint-apm.github.io/pinpoint/alarm.html) for full understanding.\nBut for the docker image, All is set. fillout variables under *#mail server information required* in `.env` file before starting the container \n \n### Testing QuickStart application\n \nNow you are ready to monitor the sample application(Pinpoint-QuickStart [port 8085](http://localhost:8085)) provided.\nIf you can't find any connected application from Pinpoint-Web's first page([port 8080](http://localhost:8080) as default), don't panic and wait for a while.\nIt will take some time for Pinpoint to retrieve the application's information when running for the first time.\n\n## Monitoring YOUR Application\n\nPinpoint-Agent only prepares required libraries for triggering Pinpoint-Agent.\nRunning and configuring agents is manual action done by the user, but don't worry it's very simple.\n\nIf you are not familiar with Pinpoint concept, please read: [Overview](https://pinpoint-apm.github.io/pinpoint/overview.html#architecture),\n[Agents Installation](https://pinpoint-apm.github.io/pinpoint/installation.html#5-pinpoint-agent)\n\n**You will need to attach *Pinpoint-Agent* to your application.**\n\nRunning Pinpoint-Agent docker-compose separately, Examples are [here](https://github.com/pinpoint-apm/pinpoint-docker/tree/master/pinpoint-agent-attach-example).  \nOtherwise, you can check how [Pinpoint-Quickstart](https://github.com/pinpoint-apm/pinpoint-docker/blob/master/docker-compose.yml) is attached to Pinpoint-Agent with docker-compose.\n\nWe'll try to create more examples along the way.\nIf anyone who can share their dockerfile, it's always welcome.\n\n## Distributed System\n\nUntil now, every components are in one docker, single-node approach, which is excellent for test and development.\nIt provides an easy way to prototype new ideas and use cases, as well as try out new functionality and the latest Pinpoint releases.\nIt’s not intended nor supported for production use.\n\nYou can use `docker-compose` and `.env` files under each folder to install the modules separately into several servers.\nIf containers are separated, ip configurations in `.env` must be changed within. \n\nFor example, if you want your application running from a docker and rest of Pinpoint in another.\nYou can remove *pinpoint-agent* and *pinpoint-quickstart* from docker-compose.yml and run to establish all necessary component of pinpoint.\nAnd create another docker-compose.yml just like one under pinpoint-quickstart folder to run your application.\nFinally, since agent needs to acknowledge the collector ip. collector ip needs to be changed in .env.\n\n## Configurations\n\nConfiguration relies on supplying `docker-compose` with environment variables defined in `.env` file. So it's recommended to change variables only from `.env` file.\nWith `docker-compose` in this repository. You can create stand-alone containers that are needed to run most of the features in Pinpoint.\n\n**Ports** can be also configured in .env file.\n(Default ports are Pinpoint-Web:8080, Pinpoint-Batch:8079, Quickstart:8085 and Flink:8081 as configured in .env file)\n\nPinpoint-Zookeeper is just an example of using zookeeper image. You can modify docker-compose files to suit your needs.\n\nFor more specific details on what the values represents in *.env* file. Please check [Pinpoint Github Repository](https://github.com/pinpoint-apm/pinpoint) or\n[Pinpoint Web properties](https://github.com/pinpoint-apm/pinpoint/blob/master/web/src/main/resources/pinpoint-web-root.properties), [Pinpoint Collector properties](httpshttps://github.com/pinpoint-apm/pinpoint/blob/master/collector/src/main/resources/pinpoint-collector-root.properties), [Pinpoint Agent configuration](https://github.com/pinpoint-apm/pinpoint/blob/master/agent/src/main/resources/pinpoint-root.config).  \nPlease note that only essential configuration options are adopted to pinpoint-docker(docker-compose). \n \n## logs \n \nYou can check logs produced by these services\n ```\n docker logs \u003ccontainerId\u003e\n ```\n \nYou can also easily change the log level from *.env* file. \n \n## Any Issues or Suggestions?\n\nFeel free to share any problems and suggestions via [Pinpoint GitHub Issue page](https://github.com/pinpoint-apm/pinpoint-docker/issues).\nContributions on the pinpoint-docker image is also always welcome.\n\n## License\nPinpoint is licensed under the Apache License, Version 2.0.\nSee [LICENSE](https://github.com/pinpoint-apm/pinpoint/blob/master/LICENSE) for full license text.\n\n```\nCopyright 2018 NAVER Corp.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinpoint-apm%2Fpinpoint-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpinpoint-apm%2Fpinpoint-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinpoint-apm%2Fpinpoint-docker/lists"}