Skip to content
Permalink
Browse files

update docs

  • Loading branch information
narqo committed Mar 1, 2020
1 parent 6dd6816 commit a39cf45ac3ec80d98ae800914756ef22517c0ea3
Showing with 6 additions and 5 deletions.
  1. +3 −4 DESIGN.md
  2. +3 −1 README.md
@@ -15,10 +15,9 @@ i.e. `pb.gz`, or [Go runtime traces](https://golang.org/pkg/runtime/trace/)).
Collector persists the data in a plugable storage.
It also provides an API for querying and retrieving stored profiles.

The only storage implemented currently uses [Badger](https://github.com/dgraph-io/badger).

*Note: it's tempting to split collector into two separate applications (collector and querier).
That might inctease service's scalability. But is the subject of future research.*
Currently implemented storages:
- `storage/badger`, keeps data in [Badger DB](https://github.com/dgraph-io/badger);
- `storage/s3`, stores data in s3-compatible object storage service.

### Agent

@@ -28,11 +28,13 @@ To build and start profefe collector, run:

```
> make
> ./BUILD/profefe -addr :10100 -log.level debug -badger.dir /tmp/profefe
> ./BUILD/profefe -addr :10100 -log.level debug -badger.dir /tmp/profefe-data
2019-06-06T00:07:58.499+0200 info profefe/main.go:86 server is running {"addr": ":10100"}
```

`./BUILD/profefe -help` will print the list of available options.

---

You can build a docker image with the collector running the command:

0 comments on commit a39cf45

Please sign in to comment.
You can’t perform that action at this time.