Skip to content

Commit

Permalink
Merge pull request #258 from lucab/ups/docs-minor-fixes
Browse files Browse the repository at this point in the history
docs: minor fixes
  • Loading branch information
Luca Bruno authored Apr 3, 2020
2 parents 4f45d29 + 86eeb88 commit 022e085
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/release-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ Push access to the upstream repository is required in order to publish the new t
- [ ] get the PR reviewed, approved and merged

- publish the artifacts (tag and crate)
- [ ] `git push ${UPSTREAM_REMOTE} ${RELEASE_VER}`
- [ ] make sure the upstream tag matches the local tag: `git fetch --tags --verbose ${UPSTREAM_REMOTE} 2>&1 | grep ${RELEASE_VER}`
- [ ] `git checkout ${RELEASE_VER}`
- [ ] make sure the tag is what you intend to release; if so this will show an empty output: `git diff release-${RELEASE_VER}~1 ${RELEASE_VER}`
- [ ] `git push ${UPSTREAM_REMOTE} v${RELEASE_VER}`
- [ ] make sure the upstream tag matches the local tag: `git fetch --tags --verbose ${UPSTREAM_REMOTE} 2>&1 | grep v${RELEASE_VER}`
- [ ] `git checkout v${RELEASE_VER}`
- [ ] make sure the tag is what you intend to release; if so this will show an empty output: `git diff release-${RELEASE_VER}~1 v${RELEASE_VER}`
- [ ] `cargo publish`

- publish the release:
Expand Down
6 changes: 3 additions & 3 deletions docs/usage/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Zincati tracks and exposes some of its internal metrics, in order to ease monitoring tasks across a large fleet of nodes.

Metrics are collected and exported according to [Prometheus] [textual format](prom-text), over a local endpoint.
Metrics are collected and exported according to [Prometheus] [textual format][prom-text], over a local endpoint.

[Prometheus]: https://prometheus.io/
[prom-text]: https://prometheus.io/docs/instrumenting/exposition_formats/
Expand All @@ -11,7 +11,7 @@ Metrics are collected and exported according to [Prometheus] [textual format](pr

To gather metrics from a locally running Zincati instance, it is sufficient to connect and read from the Unix-domain socket located at `/run/zincati/public/metrics.promsock`.

For example, manual inspection can be performed via `ncat`:
For example, manual inspection can be performed via `socat`:

```
$ sudo socat - UNIX-CONNECT:/run/zincati/public/metrics.promsock
Expand All @@ -29,6 +29,6 @@ zincati_update_agent_updates_enabled 1
```

Additionally, the local Unix-domain socket can be proxied to HTTP and exposed to Prometheus.
For an example of such setup, check the [local\_exporter] repository.
For an example of such setup, check the [local\_exporter][local_exporter] repository.

[local_exporter]: https://github.com/lucab/local_exporter

0 comments on commit 022e085

Please sign in to comment.