Skip to content
This repository has been archived by the owner on Jan 13, 2020. It is now read-only.

Commit

Permalink
[doc] add note for convert tool
Browse files Browse the repository at this point in the history
  • Loading branch information
iori-yja committed Dec 21, 2018
1 parent 9b4ed18 commit cb352ad
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ To grasp looks & usage, see our wiki page: [About Avalanche view](https://github

![eye catch](asset/top.png)

## Getting started

```
% # see http://github.com/jvm-profiling-tools/perf-map-agent and build it at first
% go get -d -u -v github.com/WorksApplications/Avalanche/...
% cd $GOPATH/src/github.com/WorksApplications/Avalanche
% make cli
% bin/convert -image ${_your app_}=-perfMapAgentPath=path/to/perf-map-agent.tar.gz\
-saveAs=${_your_app_}-perf-monitor:something
```

Well done! You have your own "perf-logging" image. Deploy it to log your app's performance. To analyze the "perf-log", deploy analyzer service by seeing the document below.

## TOC

- [Concept](#concept)
Expand All @@ -26,13 +39,13 @@ To grasp looks & usage, see our wiki page: [About Avalanche view](https://github
1. Take log snapshot on-demand (eg. on incident response).
1. Explore the performance snapshots and find bottlenecks.

![system concept image](asset/avalanche-scheme.png)
![system concept image](asset/avalanche-scheme.svg)

## How it works

### Brief summary

1. Transform your application's container image to "perf-enabled" image and "extractor" image with `provide` tool in this repository
1. Transform your application's container image to "perf-enabled" image and "extractor" image with `convert` tool in this repository
1. Deploy "perf-enabled" image on your environment
1. Write configurations regarding your target environment, log server and search engine.
1. Run
Expand Down
Binary file removed asset/avalanche-scheme.png
Binary file not shown.
2 changes: 1 addition & 1 deletion asset/avalanche-scheme.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cb352ad

Please sign in to comment.