restic / restic/rest-server

`/metrics` should also provide repository stats

Open
#176 3 comments 12 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
1.5k
Forks
178
Avg merge
15d 9h
Merged PRs (30d)
2

Description

Output of rest-server --version

$ /nix/store/ikr0wfhq239s7s8l65b1bl0q53y213nr-restic-rest-server-0.10.0/bin/rest-server --version
rest-server 0.10.0 compiled with go1.16.9 on linux/amd64

What should rest-server do differently?

Currently the metrics reported in the /metrics endpoint are the default metrics for go programs and actually more about the runtime and process behavior, which is totally fine and important data, still it is missing the interesting things like number of users, number of repositories, size of them, user quotas, snapshots (per user/repo), etc

What are you trying to do? What is your use case?

I want to collect meaningful metrics about the repository.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the existing /metrics endpoint and reviewing how repository information is represented by the REST server. Define which repository statistics are in scope, then determine how they should be exposed and validated; done means /metrics reports meaningful repository data in addition to the current Go runtime and process metrics.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend-api-design, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.