Skip to content
This repository has been archived by the owner on Mar 8, 2024. It is now read-only.

Metrics endpoint output format #554

Open
elmurci opened this issue Jun 24, 2020 · 3 comments
Open

Metrics endpoint output format #554

elmurci opened this issue Jun 24, 2020 · 3 comments
Labels
Enhancement New feature or request

Comments

@elmurci
Copy link
Collaborator

elmurci commented Jun 24, 2020

Detailed Description

As of now, the format returned by the metrics endpoint (GET /metrics) seems to be tight to Prometheus:

# HELP payid_lookup_request count of requests to lookup a PayID
# TYPE payid_lookup_request counter
payid_lookup_request{paymentNetwork="XRPL",environment="TESTNET",org="payid.es",result="found"} 68
...
# HELP payid_count count of total PayIDs
# TYPE payid_count gauge
payid_count{paymentNetwork="BTC",environment="MAINNET",org="payid.app"} 1
payid_count{paymentNetwork="ETH",environment="TESTNET",org="payid.app"} 1
payid_count{paymentNetwork="XRPL",environment="MAINNET",org="payid.app"} 6
payid_count{paymentNetwork="XRPL",environment="TESTNET",org="payid.app"} 3

Request to abstract from the destination tool (Prometheus or whatever reporting tool is chosen) and adopt JSON as format so it is easier to read and transform.

Context

Easier processing by middlewares and reporting tools.

@0xCLARITY 0xCLARITY added the Enhancement New feature or request label Jun 24, 2020
@0xCLARITY
Copy link
Collaborator

Just to clarify, this is about changing the format of metrics when you hit the GET /metrics endpoint to JSON, correct?

@elmurci
Copy link
Collaborator Author

elmurci commented Jun 24, 2020

Sorry, yes. Will clarify in the description.

@elmurci elmurci changed the title Metrics report output format Metrics endpoint output format Jun 24, 2020
@MarkusTeufelberger
Copy link

JSON isn't a specific format for metrics, at most it could make sense to expose them in https://openmetrics.io/ format.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants