Skip to content

docs: Prometheus metrics + generator #5179

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

Merged
merged 20 commits into from
Nov 30, 2022
Merged

docs: Prometheus metrics + generator #5179

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
477fef9
docs: Prometheus metrics
mtojek Nov 28, 2022
887ca4e
Fix
mtojek Nov 28, 2022
663d2e0
Typo
mtojek Nov 28, 2022
ce7a623
Typo
mtojek Nov 28, 2022
d93b2fd
Typo
mtojek Nov 28, 2022
08edfc5
Fix: link
mtojek Nov 28, 2022
a7b903f
Update docs/admin/prometheus.md
mtojek Nov 28, 2022
553c799
Update docs/admin/prometheus.md
mtojek Nov 28, 2022
483f9bc
Update docs/admin/prometheus.md
mtojek Nov 28, 2022
77d9fec
Update docs/admin/prometheus.md
mtojek Nov 28, 2022
2290856
Update docs/admin/prometheus.md
mtojek Nov 28, 2022
8d89937
Rephrase
mtojek Nov 28, 2022
69d97a6
notice
mtojek Nov 28, 2022
a29dfae
use ```shell
ghuntley Nov 29, 2022
15d58a3
Generator
mtojek Nov 29, 2022
30fd2d1
gosec
mtojek Nov 29, 2022
7ce111c
fix: lint
mtojek Nov 29, 2022
556b7c1
Merge branch 'main' into 3520-doc-prom-metrics
mtojek Nov 29, 2022
207711d
PR comments
mtojek Nov 29, 2022
e112fc4
not needed anymore
mtojek Nov 29, 2022
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
Prev Previous commit
Next Next commit
fix: lint
  • Loading branch information
@mtojek
mtojek committed Nov 29, 2022
commit 7ce111c0e2771ae05afd9415f6e087387a97dba6
6 changes: 2 additions & 4 deletions scripts/metricsdocgen/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,12 @@ var (
generatorSuffix = []byte("<!-- End generated by 'make docs/admin/prometheus.md'. -->")
)

func init() {
func main() {
flag.StringVar(&metricsFile, "metrics-file", "scripts/metricsdocgen/metrics", "Path to Prometheus metrics file")
flag.StringVar(&prometheusDocFile, "prometheus-doc-file", "docs/admin/prometheus.md", "Path to prometheus doc file")
flag.BoolVar(&dryRun, "dry-run", false, "Dry run")
flag.Parse()
}

func main() {
metrics, err := readMetrics()
if err != nil {
log.Fatal("can't read metrics: ", err)
Expand Down Expand Up @@ -61,7 +59,7 @@ func main() {
func readMetrics() ([]dto.MetricFamily, error) {
f, err := os.Open(metricsFile)
if err != nil {
log.Fatalf("can't open metrics file: %s", metricsFile)
return nil, xerrors.New("can't open metrics file")
}

var metrics []dto.MetricFamily
Expand Down