Skip to content

Commit

Permalink
Merge pull request #48 from dongxuny/master
Browse files Browse the repository at this point in the history
Enrich README.md
  • Loading branch information
dongxuny authored Dec 28, 2021
2 parents 331102f + 3e20b20 commit 2f2b668
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Interceptor & bootstrapper designed for [gRPC](https://grpc.io/docs/languages/go

This belongs to [rk-boot](https://github.com/rookie-ninja/rk-boot) family. We suggest use this lib from [rk-boot](https://github.com/rookie-ninja/rk-boot).

![image](img/boot-arch.png)
![image](docs/img/boot-arch.png)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -64,7 +64,7 @@ This belongs to [rk-boot](https://github.com/rookie-ninja/rk-boot) family. We su
<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Architecture
![image](img/grpc-arch.png)
![image](docs/img/grpc-arch.png)

## Supported bootstrap
| Bootstrap | Description |
Expand Down Expand Up @@ -360,23 +360,21 @@ $ grpcurl -plaintext localhost:8080 rk.api.v1.RkCommonService.Healthy
#### 6.2 Swagger UI
Please refer [documentation](https://rkdev.info/docs/bootstrapper/user-guide/grpc-golang/basic/swagger-ui/) for details of configuration.

By default, we could access swagger UI at [/sw].
- http://localhost:8080/sw
By default, we could access swagger UI at [http://localhost:8080/sw](http://localhost:8080/sw)

![sw](docs/img/simple-sw.png)

#### 6.3 TV
Please refer [documentation](https://rkdev.info/docs/bootstrapper/user-guide/grpc-golang/basic/tv/) for details of configuration.

By default, we could access TV at [/tv].
By default, we could access TV at [http://localhost:8080/rk/v1/tv](http://localhost:8080/rk/v1/tv)

![tv](docs/img/simple-tv.png)

#### 6.4 Prometheus Metrics
Please refer [documentation](https://rkdev.info/docs/bootstrapper/user-guide/grpc-golang/basic/middleware-metrics/) for details of configuration.

By default, we could access prometheus client at [/metrics]
- http://localhost:8080/metrics
By default, we could access prometheus client at [http://localhost:8080/metrics](http://localhost:8080/metrics)

![prom](docs/img/simple-prom.png)

Expand Down Expand Up @@ -517,7 +515,7 @@ Prometheus client will automatically register into [grpc-gateway](https://github
Access [http://localhost:8080/metrics](http://localhost:8080/metrics)
![image](img/prom-inter.png)
![image](docs/img/prom-inter.png)
## YAML options
User can start multiple [gRPC](https://grpc.io/docs/languages/go/) and [grpc-gateway](https://github.com/grpc-ecosystem/grpc-gateway) instances at the same time. Please make sure use different port and name.
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit 2f2b668

Please sign in to comment.