diff --git a/README.md b/README.md index 3c13dadde..398c6f92c 100644 --- a/README.md +++ b/README.md @@ -6,26 +6,26 @@ * Minimal impact on performance (approximately 3% increase in resource usage) ## Overview -Services nowadays often consists 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. +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. * **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. * **Request/Response Scatter Chart** - Visualize request count and response patterns over time to identify potential problems. Transactions can be selected for additional detail by dragging over the chart. - [Image] + ![Server Map](doc/img/ss_server-map.png) * **CallStack** - Gain code-level visibility to every transaction in a distributed environment, identifying bottlenecks and points of failure in a single view. - [Image] + ![Call Stack](doc/img/ss_call-stack.png) * **Inspector** - View additional details on the application such as CPU usage, Memory/Garbage Collection, and JVM arguments. - [Image] + ![Inspector](doc/img/ss_inspector.png) ## Architecture To be included. ## Quick Start -You may run a sample Pinpoint instance in your own machine by running four simple scripts for each components : Collector, Web, Sample TestApp, HBase. +You may run a sample Pinpoint instance in your own machine by running four simple scripts for each components: Collector, Web, Sample TestApp, HBase. 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. @@ -38,4 +38,6 @@ To be included. To be included. ## License -Pinpoint is licensed under the Apache License, Version 2.0. See LICENSE for full license text. +Pinpoint is licensed under the Apache License, Version 2.0. + +See [LICENSE](LICENSE) for full license text. diff --git a/doc/img/ss_call-stack.png b/doc/img/ss_call-stack.png new file mode 100644 index 000000000..099d20a77 Binary files /dev/null and b/doc/img/ss_call-stack.png differ diff --git a/doc/img/ss_inspector.png b/doc/img/ss_inspector.png new file mode 100644 index 000000000..8b1d8a609 Binary files /dev/null and b/doc/img/ss_inspector.png differ diff --git a/doc/img/ss_quickstart-collector-log.png b/doc/img/ss_quickstart-collector-log.png new file mode 100644 index 000000000..490ef643d Binary files /dev/null and b/doc/img/ss_quickstart-collector-log.png differ diff --git a/doc/img/ss_quickstart-testapp-log.png b/doc/img/ss_quickstart-testapp-log.png new file mode 100644 index 000000000..f87b5bd85 Binary files /dev/null and b/doc/img/ss_quickstart-testapp-log.png differ diff --git a/doc/img/ss_quickstart-web-log.png b/doc/img/ss_quickstart-web-log.png new file mode 100644 index 000000000..aeb9d6f01 Binary files /dev/null and b/doc/img/ss_quickstart-web-log.png differ diff --git a/doc/img/ss_server-map.png b/doc/img/ss_server-map.png new file mode 100644 index 000000000..d1968c413 Binary files /dev/null and b/doc/img/ss_server-map.png differ diff --git a/quickstart/README.md b/quickstart/README.md index 3bbfcaa65..21b944e9b 100644 --- a/quickstart/README.md +++ b/quickstart/README.md @@ -10,9 +10,9 @@ In order to build Pinpoint and run QuickStart, the following requirements must b * Maven installed * JAVA_7_HOME environment variable set to JDK 7 installation directory. -JDK 7+ and JAVA_7_HOME environment variable are required to build profiler-optional. If you choose to build each modules separately, you may do so with JDK 6. +JDK 7+ and JAVA_7_HOME environment variable are required to build profiler-optional. If you choose to build each module separately, you may do so with JDK 6. -QuickStart currently only supports Linux, and OSX. +QuickStart supports Linux, and OSX. ## Starting @@ -35,6 +35,14 @@ The following script downloads HBase standalone from [Apache download site](http **TestApp** - Run ```quickstart/bin/start-testapp.sh``` +Once the startup scripts are completed, the last 10 lines of the Tomcat log are tailed to the console: + +**Collector** ![Collector quick start successful](../doc/img/ss_quickstart-collector-log.png) + +**Web UI** ![Web quick start successful](../doc/img/ss_quickstart-web-log.png) + +**TestApp** ![TestApp quick start successful](../doc/img/ss_quickstart-testapp-log.png) + ### Check Status Once HBase and the 3 daemons are running, you may visit the following addresses to test out your very own Pinpoint instance.