Skip to content

Commit

Permalink
Fix README typos
Browse files Browse the repository at this point in the history
Signed-off-by: Raul Sevilla <[email protected]>
  • Loading branch information
rsevilla87 committed Oct 25, 2020
1 parent cdbd2c2 commit 8ea410b
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 22 deletions.
14 changes: 8 additions & 6 deletions .github/workflows/go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,17 @@ jobs:
- name: Cache prometheus
uses: actions/cache@v2
with:
path: ~/prometheus-2.22.0.linux-amd64
path: /prometheus-2.22.0.linux-amd64
key: prometheus

- name: Download prometheus binary
run: curl -L https://github.com/prometheus/prometheus/releases/download/v2.22.0/prometheus-2.22.0.linux-amd64.tar.gz | tar xz
- name: Download prometheus
run: |
[[ ! -f prometheus-2.22.0.linux-amd64/prometheus ]] && curl -sSL https://github.com/prometheus/prometheus/releases/download/v2.22.0/prometheus-2.22.0.linux-amd64.tar.gz | tar xz
- name: Start prometheus server
working-directory: ~/prometheus-2.22.0.linux-amd64
run: ./prometheus --storage.tsdb.path=/tmp/promdata 2>/dev/null &
- name: Run prometheus
run: |
pushd prometheus-2.22.0.linux-amd64
./prometheus --storage.tsdb.path=/tmp/promdata 2>/dev/null &
- name: Build
run: make build
Expand Down
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ spec:
type: ClusterIP
```

It's worth to say that you can also more advanced [golang template semantics](https://golang.org/pkg/text/template/) on your objectTemplate files.
It's worth to say that you can also use [golang template semantics](https://golang.org/pkg/text/template/) in your *objectTemplate* files.

```yaml
kind: ImageStream
Expand Down Expand Up @@ -396,21 +396,21 @@ An example of how to configure this measurement to collect pprof HEAP and CPU pr

```yaml
measurements:
- name: pprof
pprofInterval: 5m
pprofDirectory: pprof-data
pprofTargets:
- name: kube-apiserver-heap
namespace: "openshift-kube-apiserver"
labelSelector: {app: openshift-kube-apiserver}
bearerToken: thisIsNotAValidToken
url: https://localhost:6443/debug/pprof/heap
- name: kube-apiserver-cpu
namespace: "openshift-kube-apiserver"
labelSelector: {app: openshift-kube-apiserver}
bearerToken: thisIsNotAValidToken
url: https://localhost:6443/debug/pprof/profile?timeout=30
- name: pprof
pprofInterval: 5m
pprofDirectory: pprof-data
pprofTargets:
- name: kube-apiserver-heap
namespace: "openshift-kube-apiserver"
labelSelector: {app: openshift-kube-apiserver}
bearerToken: thisIsNotAValidToken
url: https://localhost:6443/debug/pprof/heap
- name: kube-apiserver-cpu
namespace: "openshift-kube-apiserver"
labelSelector: {app: openshift-kube-apiserver}
bearerToken: thisIsNotAValidToken
url: https://localhost:6443/debug/pprof/profile?timeout=30
```

**Note**: As mentioned before, this measurement requires cURL to be installed in the target pods.
Expand Down
1 change: 1 addition & 0 deletions test/kind.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
nodes:
- role: control-plane
- role: worker
1 change: 1 addition & 0 deletions test/metrics-profile.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
metrics:
- query: process_resident_memory_bytes{job="prometheus"}
metricName: prometheusRSS

0 comments on commit 8ea410b

Please sign in to comment.