Add OpenTelemetry metrics instrumentation (#290)
## Motivation and Context - It is important to have basic observability in place so that availability issues can be figured out easily ## How Has This Been Tested? - Registration of metrics is tested - Prometheus endpoint `/metrics` is included in test cases to test the metrics exposed - Test locally to understand any regression. ## Breaking Changes - No ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [x] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [x] My code follows the repository's style guidelines - [x] New and existing tests pass locally - [x] I have added appropriate error handling - [ ] I have added or updated documentation as needed ## Additional context - Telemetry implementation is currently done by keeping metrics in mind as of now, other types of telemetry can be added on top of it later. - Instrumentation takes care of these problems already: - Cardinality control by limiting latency buckets and not including labels that grows with throughput. - Latency buckets are added as per SLA guidelines - Each metric prefixed with `mcp` to easily identify. - Pulling mechanism is used since the idea is to scrape metrics via an agent like vmagent, prometheus agent or otel-collector. - Metrics follow standard approach of defining counters, histogram and gauges as per opentelemetry guidelines.
This commit is contained in:
parent
12ab632d32
commit
d237fc90f8
1 changed files with 538 additions and 21 deletions
|
|
@ -3,16 +3,18 @@ package router
|
|||
|
||||
import (
|
||||
"github.com/danielgtaylor/huma/v2"
|
||||
|
||||
v0 "github.com/modelcontextprotocol/registry/internal/api/handlers/v0"
|
||||
v0auth "github.com/modelcontextprotocol/registry/internal/api/handlers/v0/auth"
|
||||
"github.com/modelcontextprotocol/registry/internal/config"
|
||||
"github.com/modelcontextprotocol/registry/internal/service"
|
||||
"github.com/modelcontextprotocol/registry/internal/telemetry"
|
||||
)
|
||||
|
||||
func RegisterV0Routes(
|
||||
api huma.API, cfg *config.Config, registry service.RegistryService,
|
||||
api huma.API, cfg *config.Config, registry service.RegistryService, metrics *telemetry.Metrics,
|
||||
) {
|
||||
v0.RegisterHealthEndpoint(api, cfg)
|
||||
v0.RegisterHealthEndpoint(api, cfg, metrics)
|
||||
v0.RegisterPingEndpoint(api)
|
||||
v0.RegisterServersEndpoints(api, registry)
|
||||
v0auth.RegisterAuthEndpoints(api, cfg)
|
||||
|
|
|
|||
Loading…
Reference in a new issue