summaryrefslogtreecommitdiff
path: root/daemon/algod/api/server/common/metrics.go
blob: 18e6b802744dc8d55b7720c22ac2f36877bd4e3d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
// Copyright (C) 2019-2023 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.

package common

import (
	"net/http"
	"strings"

	"github.com/labstack/echo/v4"

	"github.com/algorand/go-algorand/daemon/algod/api/server/lib"
	"github.com/algorand/go-algorand/util/metrics"
)

// Metrics returns data collected by util/metrics
func Metrics(ctx lib.ReqContext, context echo.Context) {
	// swagger:operation GET /metrics Metrics
	//---
	//     Summary: Return metrics about algod functioning.
	//     Produces:
	//     - text/plain
	//     Schemes:
	//     - http
	//     Responses:
	//       200:
	//         description: text with \#-comments and key:value lines
	//       404:
	//         description: metrics were compiled out
	w := context.Response().Writer
	w.Header().Set("Content-Type", "text/plain")
	w.WriteHeader(http.StatusOK)

	var buf strings.Builder
	metrics.DefaultRegistry().WriteMetrics(&buf, "")
	w.Write([]byte(buf.String()))
}

func init() {
	Routes = append(Routes,
		lib.Route{
			Name:        "metrics",
			Method:      "GET",
			Path:        "/metrics",
			HandlerFunc: Metrics,
		},
	)
}