Skip to content
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.

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

Metrics API: Common Metrics #101

Open
AlvaroVega opened this issue Dec 5, 2016 · 1 comment
Open

Metrics API: Common Metrics #101

AlvaroVega opened this issue Dec 5, 2016 · 1 comment

Comments

@AlvaroVega
Copy link
Member

This issue is about implementing the basic API metrics operations, along with the first batch of counters (the common ones for all the IoTP components).

Operations to implement:

GET <host:port>/admin/metrics
DELETE <host:port>/admin/metrics
GET <host:port>/admin/metrics?reset=true (maybe, yet under discussion)

Syntax:

{
    "service": {
        "service1": {
            "subservs": {
                "subserv1": {},
                "subserv2": {},
                "subserv3": {}
            },
            "sum": {}
        },
        "service2": {
            "subservs": {
                "subserv1": {},
                "subserv2": {},
                "subserv3": {}
            },
            "sum": {}
        },
        "service3": {
            "subservs": {
                "subserv1": {},
                "subserv2": {},
                "subserv3": {}
            },
            "sum": {}
        }
    },
    "sum": {
        "subservs": {
            "subserv1": {},
            "subserv2": {},
            "subserv3": {}
        },
        "sum": {}
    }
}

Metrics to implement:

  • incomingTransactions: number of requests consumed by the component.
  • incomingTransactionRequestSize: total size (bytes) in requests associated to incoming transactions (“in” from the point of view of the component).
  • incomingTransactionResponseSize: total size (bytes) in responses associated to incoming transactions (“out” from the point of view of the component).
  • incomingTransacionError: number of incoming transactions resulting in error.
  • serviceTime: average time to serve a transaction.
  • outgoingTransactions: number of requests sent by the component.
  • outgoingTransactionRequestSize: total size (bytes) in requests associated to outgoing transactions (“out” from the point of view of the component).
  • outgoingTransactionResponseSize: total size (bytes) in responses associated to outgoing transactions (“in” from the point of view of the component).
  • outgoingTransacionError: number of outgoing transactions resulting in error.

Note: all incoming/outgoing channels count for the above metrics.

@AlvaroVega
Copy link
Member Author

No Outgoing and No Subservice applies on Keypass

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant