Skip to content

Commit

Permalink
docs: Update README with service annotation
Browse files Browse the repository at this point in the history
kprofefe not supports `profefe.com/service` to set the service name
override the default one: the pod name.

Signed-off-by: Gianluca Arbezzano <gianarb92@gmail.com>
  • Loading branch information
Gianluca Arbezzano committed Jan 7, 2020
1 parent 1d7dc6f commit f225c4f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ The annotations are:
profiles from that pod.
* `profefe.com/port=8085` tells kube-profefe where to look for a pprof http
server. By default it is 6060.
* `profefe.com/service=frontend` tells kube-profefe the name of the service
usable to lookup the profile. If the annotation is not specified it uses the
pod name. My suggestion is to set this annotation because pods are ephemeral
and lookup by pod name may be hard to do.
* `profefe.com/path=/debug/pprof` tells kube-profefe where to look for a pprof http
server. By default it is `/debug/pprof`.

Expand Down

0 comments on commit f225c4f

Please sign in to comment.