Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update monitoring readme #166

Merged
merged 1 commit into from
Dec 9, 2024
Merged

docs: update monitoring readme #166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 27 additions & 20 deletions monitoring/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,26 @@

### Server

```
```go
package main

import (
"context"
"context"
"time"

"github.com/cloudwego/monitor-prometheus"
"github.com/cloudwego/hertz/pkg/app"
"github.com/cloudwego/hertz/pkg/app/server"
prometheus "github.com/hertz-contrib/monitor-prometheus"
)

func main() {
...
h := server.Default(server.WithHostPorts("127.0.0.1:8080"), server.WithTracer(prometheus.NewServerTracer(":9091", "/hertz")))
//...
h := server.Default(
server.WithHostPorts("127.0.0.1:8080"),
server.WithTracer(
prometheus.NewServerTracer(":9091", "/hertz"),
),
)

h.GET("/metricGet", func(c context.Context, ctx *app.RequestContext) {
ctx.String(200, "hello get")
Expand All @@ -28,31 +35,31 @@ func main() {
})

h.Spin()
}
```

## HOW-TO-RUN

1. install docker and start docker
2. change $inetIP to local ip in line 30 of prometheus.yml
3. run Prometheus and Grafana
`docker-compose up`
4. run Hertz server
`go run main.go`
5. run Hertz client
`go run client/main.go`
3. run Prometheus and Grafana `docker-compose up` or `docker compose up`
4. run Hertz server `go run main.go`
5. run Hertz client `go run client/main.go`
6. visit `http://localhost:3000`, the account password is `admin` by default
7. configure Prometheus data sources
1. `Configuration`
2. `Data Source`
3. `Add data source`
4. Select `Prometheus` and fill the URL with `http://prometheus:9090`
5. click `Save & Test` after configuration to test if it works
8. add dashboard `Create` -> `dashboard`, add monitoring metrics such as throughput and pct99 according to your needs, for example:
1. `Connections`
2. `Data sources`
3. `Add new data source`
4. Select `Prometheus` and fill the URL with `http://prometheus:9090`
5. click `Save & test` after configuration to test if it works
8. add dashboard `Dashboards` -> `New` -> `New dashboard`, add monitoring metrics such as throughput and pct99 according to your needs, for example:

- server throughput of succeed requests

`sum(rate(hertz_server_throughput{statusCode="200"}[1m])) by (method)`

- server latency pct99 of succeed requests

`histogram_quantile(0.9,sum(rate(hertz_server_latency_us_bucket{statusCode="200"}[1m]))by(le))`

For more information about hertz monitoring, please click [monitoring](https://www.cloudwego.io/zh/docs/hertz/tutorials/framework-exten/monitor/)
For more information about hertz monitoring, please click [monitoring](https://www.cloudwego.io/zh/docs/hertz/tutorials/framework-exten/monitor/)
Loading