Platform Monitor API · WorkFusion Documentation

GET /api/summary

General information on number of objects like: metrics, incidents, component, alerts

{
alerts: 0,
components: 1,
incidents: 0,
gauges: 5
}

GET /api/info

Information about status agent

{
company: "WorkFusion",
build: 
{
version: "1.0-SNAPSHOT",
timestamp: "20160530-1627"
}
}

GET /api/metrics

All metrics with non-text values

{
mem: 251627,
mem.free: 81758,
processors: 2,
instance.uptime: 1054878,
uptime: 1060121,
systemload.average: 0,
heap.committed: 187904,
heap.init: 126976,
heap.used: 106145,
heap: 273408,
postgres.query2.status: 0,
riak.stats.status: 0,
solr.stats.status: 0,
riakcs.tcp.time: 0,
s3cmd.ls.status: 0
}

GET /api/gauges

Gauge-type metrics

Parameter	Description
type	empty (just numbers) or "text" for text-only metrics. Default: "all"
prefix	metric prefix. Example: "vds", "vds.api". Required: false

All metrics are with Text values and starting with vds:

{
vds.duccadapter.info.http.json.version: "Empty",
vds.gateway.info.http.json.version: "Empty",
vds.scaling.info.http.json.version: "Empty",
vds.emulator.info.http.json.version: "Empty"
}

GET /api/gauges/all

All metrics, grouped by namespaces

{
    namespace1: {   
        gauge.response.api.processes.id:.+.screenshot: 1172,
        gauge.response.api.proxy: 6
    },

    namespace2: {
        rpa.ct.os.FreeVirtualMemory: 9847640,
        rpa.ct.disk.memtotal: 42579521536,
        rpa.ct.cpu.LoadPercentage: 0,
        rpa.ct.os.TotalVirtualMemorySize: 12582512,
        ....
    },
}

GET /api/gauges/ns/{namespace}

Metrics for specified {namespace}

GET /api/gauges/ns/{namespace}/{id}

Metric for specified {namespace} and {id}

GET /api/counters

Counter-type metrics

{
counter.status.200.star-star.favicon.ico: 9,
counter.status.304.star-star.favicon.ico: 1,
counter.status.200.incidents: 1,
counter.status.200.api.summary: 5,
counter.status.200.metrics.metricId:.+: 36,
counter.status.200.star-star: 171,
counter.status.200.alerts: 1,
counter.status.304.star-star: 184,
trend.memory.utilization.counter: 18,
counter.status.200.api.gauges: 6,
counter.status.200.dashboards: 2
}

GET /api/common/cleanup

Delete components, incidents and metrics from Status Page

GET /api/checks

Get latest check results

[{
metrics: {
    time2: "33",
    memory.utilization: 1900,
    time: "33"
},
problems: [ ],
successful: true,
error: null,
checkConfig: { id: "trend",
    type: "ANALYSIS",
    file: null,
    expression: "memory.utilization",
    schedule: "60",
    evaluate: [{id: "trend",
        metric: "",
        metricName: "memory.utilization",
        arg: "",
        type: "DOUBLE",
        register: true
    }
    ],
    credentials: null,
    source: "Mongo",
    description: null,
    parameters: {
        ts_from: "60",
        ts_aggregate: "5"
    },
    tag: "",
    templates: null,
    enabled: true
},
date: "2016-07-12 11:58:31",
tag: "",
checkId: "trend",
numberMetrics: {
    time2: "33",
    memory.utilization: "1900.0",
    time: "33"
}
}]

GET /api/config/checks

Get configuration for Checks

[{id: "trend",
type: "ANALYSIS",
file: null,
expression: "memory.utilization",
schedule: "60",
evaluate: [{
    id: "trend",
    metric: "",
    metricName: "memory.utilization",
    arg: "",
    type: "DOUBLE",
    register: true
}
],
credentials: null,
source: "Mongo",
description: null,
parameters: {
    ts_from: "60",
    ts_aggregate: "5"
},
tag: "",
templates: null,
enabled: true
}]

GET /api/config/components

Get configuration for Components

[{id: "wf",
name: "Workfusion",
group: "apps",
description: null,
link: null,
enabled: true,
alerts: ["memory.utilization"]
}]

GET /api/config/metrics

Get configuration for Metrics

GET /api/trend

Information about metric trends

{
trend.memory.utilization: 1700
}

GET /api/anomaly

Information about found anomalies

GET /api/forecast

Information about metric forecasts

GET /api/components

Components state

[{id: "ef1a2788-7265-4cc6-a743-26b847b21e09",
name: "Workfusion",
createdAt: 1468323558096,
updatedAt: 1468323798101,
description: null,
link: null,
status: 2,
order: null,
groupId: "2709acdd-f3bb-417c-a2c5-5b8f91b43d07",
deletedAt: null,
statusName: null
}]

GET /api/components/all

All components

GET /api/components/ns/{namespace}

Components for specfied {namespace}

GET /api/incidents

Local Incidents state

[{id: "6f980dc7-3ade-496c-9ad8-af4f3844e551",
name: "Issue found with Workfusion",
createdAt: 1468323798100,
updatedAt: null,
message: " > 14:43:18 Memory utilization increased for last hour. Metric: trend.memory.utilization. Trigger: gt 1000.0. Observed: 2700.0",
status: 1,
visible: null,
componentId: "ef1a2788-7265-4cc6-a743-26b847b21e09",
componentStatus: 2,
notify: false,
scheduledAt: null,
deletedAt: null,
humanStatus: null
}]

GET /api/incidents/all

All incidents

GET /api/incidents/ns/{namespace}

Incedents for specfied {namespace}

GET /api/alerts

Local alerts

[{date: "2016-07-12 12:05:18",
id: "memory.utilization",
size: 1,
issues: [{
    metric: "trend.memory.utilization",
    trigger: "gt 1000.0",
    observed: "1500.0",
    description: "Memory utilization increased for last hour",
    dependsOnFailed: false,
    status: "PERFORMANCE"
}],
dependsOnFailed: false
}]

GET /api/alerts/all

All alerts

GET /api/alerts/ns/{namespace}

Alerts for specified {namespace}

GET /api/proxy

Returns combined list of all agent's items, grouped by namespaces

{
    alerts: {...},
    components: {...},
    processes: {...},
    incidents: {...},
    groups: {...},
    metrics: {...},
    items: {...}
}

GET /api/processes/{id}/{action}

API for controling local processes

{id} - process id


{action}	start	stop	info	restart	restart/{delay}	switch	screenshot	command/{commandId}
description	start theprocess	stop the process	information about the process	restart the process	restart the process after {delay} seconds	Enable/disable autorestart	Take a screenshot of the system, where process is running	Invoke a command with {commandId} on a agent, which started the process

GET /api/processes/ns/{namespace}/{id}/{action}

API for controling processes within namespace

GET /api/items

Agent's items

GET /api/items/{id}

Agent's items with specified {id}