Skip to content

Commit

Permalink
Minor update in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
XD-DENG committed Oct 15, 2020
1 parent 659e6c7 commit bc87fdb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Start a REST-like API service for your Redis database, without writing a single
- Allows you to specify which logical DB(s) to expose, and what key patterns to expose
- Expose results of [Redis `INFO` command](https://redis.io/commands/info) in a nice format, so **you can use `Rediseen` as a connector between your Redis DB and monitoring dashboard** as well.
- Endpoint `/info` provides JSON format.
- Endpoint `/metrics` provides Prometheus-compatible format.
- Endpoint `/metrics` provides [Prometheus-compatible format](docs/documentation.md#use-rediseen-as-redis-info-exporter-for-prometheus).
- Supports API Key authentication

(Inspired by [sandman2](https://github.com/jeffknupp/sandman2); Built on shoulder of [go-redis/redis
Expand All @@ -39,7 +39,7 @@ Start a REST-like API service for your Redis database, without writing a single
- [API Authentication](docs/documentation.md#api-authentication)
- [Run Rediseen on Kubernetes](docs/documentation.md#run-rediseen-on-kubernetes)
- [Handle Special Character in Keys](docs/documentation.md#handle-special-character-in-keys)
- [Use Rediseen as Redis INFO exporter for Prometheus](docs/documentation.md#use-rediseen-as-redis-info-exporter-for-prometheus)
- [Use Rediseen as Redis INFO Exporter for Prometheus](docs/documentation.md#use-rediseen-as-redis-info-exporter-for-prometheus)
- [License](#license)
- [Reference](#reference)

Expand Down Expand Up @@ -222,7 +222,7 @@ and you can expect output below
- [API Authentication](docs/documentation.md#api-authentication)
- [Run Rediseen on Kubernetes](docs/documentation.md#run-rediseen-on-kubernetes)
- [Handle Special Character in Keys](docs/documentation.md#handle-special-character-in-keys)
- [Use Rediseen as Redis INFO exporter for Prometheus](docs/documentation.md#use-rediseen-as-redis-info-exporter-for-prometheus)
- [Use Rediseen as Redis INFO Exporter for Prometheus](docs/documentation.md#use-rediseen-as-redis-info-exporter-for-prometheus)

## License

Expand All @@ -232,3 +232,4 @@ and you can expect output below
## Reference

[1] https://swagger.io/docs/specification/authentication/api-keys/
[2] Prometheus Exposition Formats, https://prometheus.io/docs/instrumenting/exposition_formats/
4 changes: 2 additions & 2 deletions docs/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- [API Authentication](#api-authentication)
- [Run Rediseen on Kubernetes](#run-rediseen-on-kubernetes)
- [Handle Special Character in Keys](#handle-special-character-in-keys)
- [Use Rediseen as Redis INFO exporter for Prometheus](#use-rediseen-as-redis-info-exporter-for-prometheus)
- [Use Rediseen as Redis INFO Exporter for Prometheus](#use-rediseen-as-redis-info-exporter-for-prometheus)

## Installation

Expand Down Expand Up @@ -245,7 +245,7 @@ If you have special character in your keys, like "`key/3`", `Rediseen` will not
So the request should be `` http://localhost:8000/0/`key/3` ``.


## Use Rediseen as Redis INFO exporter for Prometheus
## Use Rediseen as Redis INFO Exporter for Prometheus

Rediseen parses the output from Redis `INFO` command, and provide the result in Prometheus-compatible format at endpoint `/metrics`.

Expand Down

0 comments on commit bc87fdb

Please sign in to comment.