com.webos.service.sdkagent

Note
This API has been available since API level 22.

API Summary

The sdkagent service controls Telegraf in webOS and communicates with SDK tools.

Operations:

Start, stop, and restart the Telegraf service.
Gets the status of the Telegraf service.
Sets auto start on boot of Telegraf service.
Sets and retrieves configuration of the Telegraf service.
Gets monitoring data that is collected by the Telegraf service.

Note: Telegraf is open source resource monitoring tool.

Overview of the API

Methods

collector/getConfig

ACG: sdkagent.collector

Added: API level 22

Description

Gets configurations of the Telegraf service.

Parameters

None

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Operation is successful. false: Operation has failed. Check the 'errorCode' and 'errorText' fields.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.
config	Optional	Object	Telegraf configurations, converted to a JSON object. Similar to telegraf.conf, available @ https://docs.influxdata.com/telegraf/v1.21/administration/configuration/. Note: Besides the configs that are configured using setConfig method, this method also returns some read-only configurations.

Example

Example scenario

# luna-send -f -n 1 luna://com.webos.service.sdkagent/collector/getConfig '{}'

Response:

{
"returnValue": true,
"config": {
"inputs.processes": {
},
"inputs.kernel": {
},
"inputs.cpu": {
"collect_cpu_time": false,
"totalcpu": true,
"percpu": true,
"report_active": false
},
"inputs.socket_listener": {
"service_address": "unixgram:///tmp/telegraf.sock"
},
"agent": {
"omit_hostname": false,
"flush_jitter": "0s",
"round_interval": true,
"metric_buffer_limit": 10000,
"flush_interval": "10s",
"interval": "10s",
"collection_jitter": "0s",
"metric_batch_size": 1000,
"precision": "",
"hostname": ""
},
"inputs.diskio": {
},
"inputs.system": {
},
"inputs.disk": {
"ignore_fs": [
"tmpfs",
"devtmpfs",
"devfs",
"iso9660",
"overlay",
"aufs",
"squashfs"
]
},
"outputs.influxdb": {
"database": "telegraf",
"urls": [
"http://127.0.0.1:8086"
]
},
"global_tags": {
},
"inputs.mem": {
},
"inputs.swap": {
},
"webOS.webProcessSize": {
"enabled": true
},
"webOS.processMonitoring":{
"enabled":true,
"process_name":["com.webos.app.home"]
}
}
}

collector/getData

ACG: sdkagent.collector

Added: API level 22

Description

Gets data from the Telegraf service.

Parameters

Name	Required	Type	Description
inputs	Optional	String array	Indicates the inputs to get data from service. The inputs can be obtained from the "Input." of the collector/getConfig* API. For example, the inputs can be as follows: {"processes", "kernel", "cpu", "system", "diskio", "disk", "mem", "swap"} If argument is empty, return all collected data Note: The inputs can be different depending on the target device.

Name

Required

Type

Description

inputs

Optional

String array

Indicates the inputs to get data from service.

The inputs can be obtained from the "Input.*" of the collector/getConfig API.

For example, the inputs can be as follows: {"processes", "kernel", "cpu", "system", "diskio", "disk", "mem", "swap"}

If argument is empty, return all collected data

Note: The inputs can be different depending on the target device.

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Operation is successful. false: Operation has failed. Check the 'errorCode' and 'errorText' fields.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.
dataArray	Optional	Object array	JSON object with data about the specified input.

Example

Example scenario

# luna-send -f -n 1 luna://com.webos.service.sdkagent/collector/getData '{"inputs": ["processes", "kernel"]}'

Response:

{
"returnValue": true,
"dataArray": [
{
"kernel": {
"data": {
"boot_time": "1667892733i",
"context_switches": "11538598i",
"entropy_avail": "256i",
"interrupts": "94685940i",
"processes_forked": "19231i"
},
"time": "166797999600000000",
"host": "qemux86-64"
}
},
{
"processes": {
"data": {
"total": "143i",
"unknown": "0i",
"dead": "0i",
"blocked": "0i",
"stopped": "0i",
"paging": "0i",
"zombies": "0i",
"sleeping": "97i",
"running": "0i",
"total_threads": "313i",
"idle": "46i"
},
"time": "166797999600000000",
"host": "qemux86-64"
}
}
]
}

collector/getStatus

ACG: sdkagent.collector

Added: API level 22

Description

Gets status of the Telegraf service.

Parameters

None

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Operation is successful. false: Operation has failed. Check the 'errorCode' and 'errorText' fields.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.
status	Optional	String	Indicates the status of the Telegraf service. Possible values are: active: Service is running. inactive: Service is not running.
startOnBoot	Optional	Boolean	Indicates whether the service is configured to start on booting up of device. Possible values are: true: Configured to start on boot. false: Not configured to start on boot.

Example

Example scenario

# luna-send -n 1 -f luna://com.webos.service.sdkagent/collector/getStatus '{}'

Response:

{
"returnValue": true,
"status": "active",
"startOnBoot": false
}

collector/restart

ACG: sdkagent.collector

Added: API level 22

Description

Restarts the Telegraf service.

Parameters

None

Call Returns

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of the operation.

Possible values are:

true: Operation is successful.
false: Operation has failed. Check the 'errorCode' and 'errorText' fields.

errorCode

Optional

Number

The error code for the failed operation.

errorText

Optional

String

The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

Example

Example scenario

# luna-send -n 1 -f luna://com.webos.service.sdkagent/collector/restart '{}'

Response:

{
"returnValue": true
}

collector/setConfig

ACG: sdkagent.collector

Added: API level 22

Description

Sets configurations of the Telegraf service.

Parameters

Name	Required	Type	Description
agent	Optional	Object: agent	Config data for telegraf agent. Note: At least one of the parameters must be provided. The data object may be changed for each target platform, and wrong data values are not guaranteed by API. APIs only check the JSON form of data object.
outputs.influxdb	Optional	Object: outputs.influxdb	Config data for influxdb on host. Note: At least one of the parameters must be provided. The data object may be changed for each target platform, and wrong data values are not guaranteed by API. APIs only check the JSON form of data object.
webOS.webProcessSize	Optional	Object: webOS.webProcessSize	Config data for webProcessSize. Note: At least one of the parameters must be provided. The data object may be changed for each target platform, and wrong data values are not guaranteed by API. APIs only check the JSON form of data object.
webOS.processMonitoring	Optional	Object: webOS.processMonitoring	Config data for processMonitoring. Note: At least one of the parameters must be provided. The data object may be changed for each target platform, and wrong data values are not guaranteed by API. APIs only check the JSON form of data object.

Call Returns

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of the operation.

Possible values are:

true: Operation is successful.
false: Operation has failed. Check the 'errorCode' and 'errorText' fields.

errorCode

Optional

Number

The error code for the failed operation.

errorText

Optional

String

The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

Example

Example scenario

# luna-send -f -n 1 luna://com.webos.service.sdkagent/collector/setConfig '{
"agent":{"flush_interval":"5s","interval":"5s"},
"outputs.influxdb":{"database":"telegraf","urls":["http://192.168.0.6:8086"]},
"webOS.webProcessSize":{"enabled":true},
"webOS.processMonitoring":{"enabled":true,"process_name":["com.webos.app.home","com.webos.service.sdkagent"]}
}'

Response:

{
"returnValue": true
}

collector/start

ACG: sdkagent.collector

Added: API level 22

Description

Starts the Telegraf service.

Parameters

None

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of the operation. Possible values are: true: Operation is successful. false: Operation has failed. Check the 'errorText' fields.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of the operation.

Possible values are:

true: Operation is successful.
false: Operation has failed. Check the 'errorText' fields.

errorCode

Optional

Number

The error code for the failed operation.

errorText

Optional

String

The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

Example

Example scenario

# luna-send -n 1 -f luna://com.webos.service.sdkagent/collector/start '{}'

Response:

{
"returnValue": true
}

collector/startOnBoot

ACG: sdkagent.collector

Added: API level 22

Description

Automatically starts the Telegraf service on device boot-up and starts monitoring.

Parameters

Name	Required	Type	Description
enable	Required	Boolean	Indicates if auto-start is enabled. Possible values are: true: Auto-start is enabled. false: Not enabled.

Name

Required

Type

Description

enable

Required

Boolean

Indicates if auto-start is enabled.

Possible values are:

true: Auto-start is enabled.
false: Not enabled.

Call Returns

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of the operation.

Possible values are:

true: Operation is successful.
false: Operation has failed. Check the 'errorCode' and 'errorText' fields.

errorCode

Optional

Number

The error code for the failed operation.

errorText

Optional

String

The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

Example

Example scenario

# luna-send -n 1 -f luna://com.webos.service.sdkagent/collector/startOnBoot '{"enable":true}'

Response:

{
"returnValue": true
}

collector/stop

ACG: sdkagent.collector

Added: API level 22

Description

Stops the Telegraf service.

Parameters

None

Call Returns

Name

Required

Type

Description

returnValue

Required

Boolean

Indicates the status of the operation.

Possible values are:

true: Operation is successful.
false: Operation has failed. Check the 'errorCode' and 'errorText' fields.

errorCode

Optional

Number

The error code for the failed operation.

errorText

Optional

String

The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

Example

Example scenario

# luna-send -n 1 -f luna://com.webos.service.sdkagent/collector/stop '{}'

Response:

{
"returnValue": true
}

Objects

agent

Config data for telegraf agent.

Name	Required	Type	Description
interval	Optional	String	Indicates the interval time.
flush_interval	Optional	String	Indicates the flush interval time.

outputs.influxdb

Config data for influxdb on host.

Name	Required	Type	Description
database	Optional	String	Indicates the database name.
urls	Optional	String array	Indicates the influxdb host urls.

webOS.processMonitoring

Config data for processMonitoring.

Name	Required	Type	Description
enabled	Optional	Boolean	Enables process monitoring data.
process_name	Optional	String array	Process names for monitoring.

webOS.webProcessSize

Config data for webProcessSize.

Name	Required	Type	Description
enabled	Optional	Boolean	Enables webProcessSize data.

API Error Codes Reference

Error Code	Error Text	Error Description
1	Unknown error.	Unknown error.
2	Invalid parameters.	Occurs when parameters are incorrect.
3	Malformed json.	Occurs when parameter has malformed JSON.
4	Invalid configurations.	Occurs when Telegraf has invalid configurations.
5	Collector is active (running).	Occurs when Telegraf is running.