JSON RPC

Module description

Metrics - subsystem to support metrics

Operations

Update configuration exporter

Request data

{
    "context": {
        "op": "exporter_update"
    },
    "data": {
        "name": "<name>",
        "port": "<port>",
        "metrics_path": "<metrics_path>",
        "nodes": "<nodes>",
        "retention_period": "<retention_period>",
        "filters": "<filters>",
        "cron": "<cron>"
    }
}

Description

name [ str required ] - Exporter name.

port [ int ] - Port to listen on for web interface and telemetry.

metrics_path [ str ] - The path to take metrics.

nodes [ str * ] - Selecting nodes that should collect metrics

retention_period [ int ] - Retention period in seconds

filters [ jsonstr ] - Filtering metrics name and labels

cron [ str ] - Cron expression to run exporter.

Add configuration exporter

Request data

{
    "context": {
        "op": "exporter_add"
    },
    "data": {
        "name": "<name>",
        "port": "<port>",
        "metrics_path": "<metrics_path>",
        "nodes": "<nodes>",
        "retention_period": "<retention_period>",
        "filters": "<filters>",
        "cron": "<cron>"
    }
}

Description

name [ str required ] - Exporter name.

port [ int required ] - Port to listen on for web interface and telemetry.

metrics_path [ str ] - The path to take metrics. (default: /metrics)

nodes [ str * ] - Selecting nodes that should collect metrics.

retention_period [ int ] - Retention period in seconds. (default: 600)

filters [ jsonstr ] - Filtering metrics name and labels

cron [ str ] - Cron expression to run exporter.

Delete configuration exporter

Request data

{
    "context": {
        "op": "exporter_del"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ str required ] - Exporter name.

Show configuration exporter

Request data

{
    "context": {
        "op": "exporter_show"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ str required ] - Exporter name.

List configuration exporter

Request data

{
    "context": {
        "op": "exporter_list"
    }
}

Metric data fetch from database

Request data

{
    "context": {
        "op": "data_fetch"
    },
    "data": {
        "name": "<name>",
        "sc_node": "<sc_node>",
        "filters": "<filters>",
        "current": "<current>"
    }
}

Description

name [ str required ] - Exporter name.

sc_node [ str required ] - UUID node

filters [ jsonstr ] - Filtering metrics name and labels

current [ str ] - Current metric or all available metrics. ['yes', 'no']

Add a template

Request data

{
    "context": {
        "op": "template_add"
    },
    "data": {
        "name": "<name>",
        "data": "<data>"
    }
}

Description

name [ str required ] - Template name.

data [ jsonstr ] - Template data.

Delete a template

Request data

{
    "context": {
        "op": "template_del"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ str required ] - Template name.

Show template

Request data

{
    "context": {
        "op": "template_show"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ str required ] - Template name.

List templates

Request data

{
    "context": {
        "op": "template_list"
    }
}

Execute template

Request data

{
    "context": {
        "op": "template_execute"
    },
    "data": {
        "name": "<name>"
    }
}

Description

name [ str required ] - Template name.

Update configuration exporter

Request data

{
    "context": {
        "op": "template_update"
    },
    "data": {
        "name": "<name>",
        "data": "<data>"
    }
}

Description

name [ str required ] - Template name.

data [ jsonstr ] - Template data.