• Menu

    Getting Started

    Yupiik Batch provides metrics relay to help components like batch or script to store metrics that will be polled periodically like Prometheus. For now the metrics are stored in memory, so it's better to use the dropOnPull to true to avoid too much memory usage.

    Stack

    The metrics relay is based on Yupiik Fusion .

    Usage

    The metrics relay provide an endpoint with 2 methods:

    • POST: /relay?id=test to store metrics in OpenMetric format.

    curl -X POST http://localhost:8080/relay?dropOnPull=true -H 'Content-Type: text/plain' -d '
# TYPE foo1 gauge
# HELP foo1 doc
foo1 1234
# TYPE foo2 gauge
# HELP foo2 doc
foo2 1235'

    The response is a http code 201 with body OK.

    You can set the query param dropOnPull to true (default is false) to remove the metric after a polling (GET):

    curl -X POST http://localhost:8080/relay?id=test&dropOnPull=true -H 'Content-Type: text/plain' -d '
# TYPE foo1 gauge
# HELP foo1 doc
foo1 1234
# TYPE foo2 gauge
# HELP foo2 doc
foo2 1235'

    • GET: /relay?id=test to fetch the latest metrics of the matching id test:

    curl http://localhost:8080/relay?id=test

    If you want to collect all the ids, you can remove the id query parameter.

    You can set the query param ignoreDrop to true (default is false) to disable the drop policy define on the entry:

    curl http://localhost:8080/relay?ignoreDrop=true

    Navigation