gateway: separate metrics for Signed IPNS from DNSLink

Đang mở
#409 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
go
Lĩnh vực
observability

Hướng nghiên cứu

Bắt đầu với gateway/metrics.go trong tham chiếu Boxo được liên kết và so sánh các metric gateway hiện có của nó với bifrost-gateway/metrics.go. Giải quyết các câu hỏi còn bỏ ngỏ về label, việc ghi nhận thành công/lỗi và phép đo thời lượng, sau đó xác định cách các metric sẽ được cung cấp trong quá trình kiểm thử Thunderdome. Hoàn thành khi các request IPNS và DNSLink đã ký có dữ liệu riêng biệt có thể quan sát được về request, kết quả và thời lượng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

dif/expert effort/hours kind/enhancement P2 topic/gateway

Extracted from https://github.com/ipfs/kubo/issues/9927#issuecomment-1623791077

Currently, we have basic request counts and durations for gateway=ipfs and gateway=ipns namespaces in the form of boxo/gateway/metrics.go metrics:

# HELP ipfs_http_gw_get_duration_seconds The time to GET a successful response to a request (all content types).
# TYPE ipfs_http_gw_get_duration_seconds histogram
ipfs_http_gw_get_duration_seconds_bucket{gateway="ipfs",le="0.05"} 8
[..]
ipfs_http_gw_get_duration_seconds_bucket{gateway="ipfs",le="1920"} 11
ipfs_http_gw_get_duration_seconds_bucket{gateway="ipfs",le="+Inf"} 11
ipfs_http_gw_get_duration_seconds_sum{gateway="ipfs"} 1.185360469
Problem
  • /ipns supports both DNSLink and Signed IPNS records – we have no visibility what is the % of each
  • we measure success only, have no visibility into % of IPNS record failures vs DNSLink failures
Solution
Requirements

TBD, initial requirements

  • we need dedicated metric for each type of /ipns/ request
    • signed_ipns
    • dnslink
  • we need to be able to tell:
    • how many requests were sent by clients
    • how many requests were successful vs errored
    • how long success / error takes? (could be precomputed P50/P95)
    • we need to make sure this is visible in Thunderdome testing so we can catch regressions here during release phase
Open questions
  • do we have a separate metrics for success/failure, or do we have single one with success/error attribute?
  • do we do histogram with predefined duration buckets and implicit counter (like ipfs_http_gw_get_duration_seconds)?
  • or maybe, instead of picking arbitrary duration buckets (like we have in legacy metrics) we should have P50, P75, P95, P99 Objectives, like we do here?
Ngôn ngữ chính
Go
Star
326
Fork
165
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ipfs/boxo

Tất cả issue của ipfs/boxo

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.