Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
56 changes: 56 additions & 0 deletions docs/protoapi_metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# protoapi metrics

## Usage

Import middleware and use in echo.

example:
```go
package main

import (
"github.com/labstack/echo"
"github.com/yoozoo/protoapi/protoapigo/metrics"
"code/generated/by/protoapi/demo"
)

type Service struct{}

var _ demo.DemoService = &Service{}

func main() {
e := echo.New()

service := &Service{}
calsvr.RegisterCalcService(e, c)

// use metrics middleware
m := metrics.MetricsFunc()
e.Use(m)

e.Logger.Fatal(e.Start(":8080"))
}
```

## Metrics endpoint

By default, echo server exports metrics under the `/metrics` path on its client port.

The metrics can be fetched with `curl`:

```sh
$ curl -L http://localhost:8080/metrics
```
## More Options
Function `metrics.MetricsFunc()` can have `Option` parameters.
```go
package metrics

func Registry(r prometheus.Registerer) Option {}

func MetricsPath(v string) Option {}

func Namespace(v string) Option {}

func Subsystem(v string) Option {}
```
Loading