Skip to content

Commit b32bff1

Browse files
committed
[#noissue] update readme
1 parent 624890a commit b32bff1

File tree

1 file changed

+18
-88
lines changed

1 file changed

+18
-88
lines changed

README.md

Lines changed: 18 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,27 @@
55
[![Build Status](https://travis-ci.org/naver/pinpoint.svg?branch=master)](https://travis-ci.org/naver/pinpoint)
66
[![codecov](https://codecov.io/gh/naver/pinpoint/branch/master/graph/badge.svg)](https://codecov.io/gh/naver/pinpoint)
77

8-
**Visit [our official web site](http://naver.github.io/pinpoint/) for more information.**
8+
**Visit [our official web site](http://naver.github.io/pinpoint/) for more information and [Latest updates on Pinpoint](https://naver.github.io/pinpoint/news.html)**
9+
10+
The current stable version is [v1.7.1](https://github.com/naver/pinpoint/releases/latest).
911

1012
**Pinpoint** is an APM (Application Performance Management) tool for large-scale distributed systems written in Java. Inspired by [Dapper](http://research.google.com/pubs/pub36356.html "Google Dapper"), Pinpoint provides a solution to help analyze the overall structure of the system and how components within them are interconnected by tracing transactions across distributed applications.
1113

12-
* Install agents without changing a single line of code
13-
* Minimal impact on performance (approximately 3% increase in resource usage)
14+
You should definitely check **Pinpoint** out If you want to
1415

15-
## Latest Release (2018/01/04)
16-
We're happy to announce the release of Pinpoint v1.7.1.
17-
Please check the release note at (https://github.com/naver/pinpoint/releases/tag/1.7.1).
18-
19-
The current stable version is [**v1.7.1**](https://github.com/naver/pinpoint/releases/tag/1.7.1).
20-
21-
### Plugin Development Guide (2016/03/18)
22-
We now have a [plugin development guide](https://github.com/naver/pinpoint/wiki/Pinpoint-Plugin-Developer-Guide "Pinpoint Plugin Development Guide"). Yay!
16+
* understand your *[application topology](https://naver.github.io/pinpoint/overview.html#overview)* at a glance
17+
* monitor your application in *Real-Time*
18+
* gain *code-level visibility* to every transaction
19+
* install APM Agents *without changing a single line of code*
20+
* have minimal impact on the performance (approximately 3% increase in resource usage)
2321

22+
## Getting Started
23+
* [Quick-start guide](http://naver.github.io/pinpoint/quickstart.html) for simple test run of Pinpoint
24+
* [Installation guide](http://naver.github.io/pinpoint/installation.html) for further instructions.
25+
2426
## Overview
2527
Services nowadays often consist of many different components, communicating amongst themselves as well as making API calls to external services. How each and every transaction gets executed is often left as a blackbox. Pinpoint traces transaction flows between these components and provides a clear view to identify problem areas and potential bottlenecks.<br/>
26-
For a more intimate guide, please check out our *[Introduction to Pinpoint](https://github.com/naver/pinpoint/wiki#video-clips)* video clip.
28+
For a more intimate guide, please check out our *[Introduction to Pinpoint](http://naver.github.io/pinpoint/#want-a-quick-tour)* video clip.
2729

2830
* **ServerMap** - Understand the topology of any distributed systems by visualizing how their components are interconnected. Clicking on a node reveals details about the component, such as its current status, and transaction count.
2931
* **Realtime Active Thread Chart** - Monitor active threads inside applications in real-time.
@@ -39,9 +41,6 @@ For a more intimate guide, please check out our *[Introduction to Pinpoint](http
3941

4042
![Inspector](doc/img/ss_inspector.png)
4143

42-
## Architecture
43-
![Pinpoint Architecture](doc/img/pinpoint-architecture.png)
44-
4544
## Supported Modules
4645
* JDK 6+
4746
* Tomcat 6/7/8, [Jetty 8/9](https://github.com/naver/pinpoint/tree/master/plugins/jetty), [JBoss EAP 6](https://github.com/naver/pinpoint/tree/master/plugins/jboss), [Resin 4](https://github.com/naver/pinpoint/tree/master/plugins/resin), [Websphere 6/7/8](https://github.com/naver/pinpoint/tree/master/plugins/websphere), [Vertx 3.3/3.4/3.5](https://github.com/naver/pinpoint/tree/master/plugins/vertx)
@@ -55,33 +54,6 @@ For a more intimate guide, please check out our *[Introduction to Pinpoint](http
5554
* gson, Jackson, Json Lib
5655
* log4j, Logback
5756

58-
## Third Party Agents/Plugins
59-
There may be agents, and plugins that are being developed and managed by other individuals/organizations. Please take a look [here](https://github.com/naver/pinpoint/wiki#third-party-agentsplugins) for the list and see if you would like to help out in their development.
60-
61-
## Quick Start
62-
You may run a sample Pinpoint instance in your own machine by running four simple scripts for each components: Collector, Web, Sample TestApp, HBase.
63-
64-
Once the components are running, you should be able to visit http://localhost:28080 to view the Pinpoint Web UI, and http://localhost:28081 to generate transactions on the Sample TestApp.
65-
66-
For details, please refer to the [quick-start guide](quickstart/README.md).
67-
68-
## Installation
69-
To set up your very own Pinpoint instance, please **download the required binaries** from our [**latest release**](https://github.com/naver/pinpoint/releases/latest).
70-
Please take a look at our [installation guide](doc/installation.md) for further instructions.
71-
72-
**Building** (Optional)
73-
74-
You may also choose to build pinpoint from source for various reasons including plugin development. However, our master branch is also our development branch so stability is not always guaranteed, so we recommend downloading and running the binaries from our stable releases if you are simply looking to run pinpoint.
75-
76-
Regardless, if you would like to build pinpoint from source, you will need the following:
77-
78-
* JDK 6 installed ([jdk1.6.0_45](http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase6-419409.html#jdk-6u45-oth-JPR) recommended)
79-
* JDK 7 installed ([jdk1.7.0_80](http://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html#jdk-7u80-oth-JPR) recommended)
80-
* JDK 8 installed
81-
* JAVA_6_HOME environment variable set to JDK 6 home directory.
82-
* JAVA_7_HOME environment variable set to JDK 7 home directory.
83-
* JAVA_8_HOME environment variable set to JDK 8 home directory.
84-
8557
## Compatibility
8658

8759
Java version required to run Pinpoint:
@@ -104,59 +76,15 @@ Pinpoint Version | HBase 0.94.x | HBase 0.98.x | HBase 1.0.x | HBase 1.1.x | HBa
10476
1.6.x | no | not tested | not tested | not tested | yes
10577
1.7.x | no | not tested | not tested | not tested | yes
10678

107-
Agent compatibility table:
108-
109-
Agent Version | Collector 1.0.x | Collector 1.1.x | Collector 1.5.x | Collector 1.6.x | Collector 1.7.x
110-
------------- | --------------- | --------------- | --------------- | --------------- | ---------------
111-
1.0.x | yes | yes | yes | yes | yes
112-
1.1.x | not tested | yes | yes | yes | yes
113-
1.5.x | no | no | yes | yes | yes
114-
1.6.x | no | no | not tested | yes | yes
115-
1.7.x | no | no | no | no | yes
116-
117-
Pinpoint Web Supported Browsers:
118-
119-
* Chrome
120-
121-
## Issues
122-
For feature requests and bug reports, feel free to post them [here](https://github.com/naver/pinpoint/issues "Pinpoint Issues").
123-
Please take a look at [CONTRIBUTING.md#issues](CONTRIBUTING.md#issues) for some guidelines that'll help us understand your issues better.
124-
125-
12679
## User Group
127-
For Q/A and discussion [here](https://groups.google.com/forum/#!forum/pinpoint_user "Pinpoint Google Group").
128-
129-
130-
## Wiki
131-
We have a [wiki](https://github.com/naver/pinpoint/wiki) page for roadmap, user guide, and some documentation.
132-
We welcome any documentation contribution.
133-
134-
135-
## Contribution
136-
We welcome any and all suggestions.
137-
138-
For plugin development, take a look at our [plugin development guide](https://github.com/naver/pinpoint/wiki/Pinpoint-Plugin-Developer-Guide "Pinpoint Plugin Development Guide"), along with [plugin samples](https://github.com/naver/pinpoint-plugin-sample "Pinpoint Plugin Samples project") project to get an idea of how we do instrumentation. The samples will provide you with example codes to help you get started.
139-
**Please follow our [guideline](https://github.com/naver/pinpoint/wiki/Pinpoint-Plugin-Developer-Guide#iii-plugin-contribution-guideline "Plugin PR Guideline") when making pull-requests for new plugins.**
140-
141-
For all pull-requests, make sure you've read through [CONTRIBUTING.md#pull-requests](CONTRIBUTING.md#pull-requests) and note that you will have to complete a [CLA](https://docs.google.com/forms/d/1oDX26pwmVZSoDfL9MwvwLsM23dHqc5pvgoZCp7jM940/viewform?c=0&w=1 "Contributor License Agreement") for your first pull-request.
142-
143-
We would love to see additional tracing support for libraries such as [Storm](https://storm.apache.org "Apache Storm"), [HBase](http://hbase.apache.org "Apache HBase"), as well as profiler support for additional languages (.NET, C++).
144-
145-
## Google Analytics
146-
The web module has google analytics attached that tracks the number and the order of button clicks in the server map, transaction list, and the inspector view.
147-
148-
This data is used to better understand how users interact with the Web UI which gives us valuable information in improving Pinpoint Web's user experience.
149-
To disable this for any reason, set the following option to false in *pinpoint-web.properties* for your web instance.
150-
```
151-
config.sendUsage=false
152-
```
80+
For Q/A and discussion [here](https://groups.google.com/forum/#!forum/pinpoint_user).
15381

15482
## License
15583
Pinpoint is licensed under the Apache License, Version 2.0.
15684
See [LICENSE](LICENSE) for full license text.
15785

15886
```
159-
Copyright 2017 NAVER Corp.
87+
Copyright 2018 NAVER Corp.
16088
16189
Licensed under the Apache License, Version 2.0 (the "License");
16290
you may not use this file except in compliance with the License.
@@ -170,3 +98,5 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17098
See the License for the specific language governing permissions and
17199
limitations under the License.
172100
```
101+
102+

0 commit comments

Comments
 (0)