wiotp/oshi

Overview

Device code for sending system utilization data to IBM Watson IoT Platform, powered by https://github.com/oshi/oshi

OSHI is a free JNA-based (native) Operating System and Hardware Information library for Java. It does not require the installation of any additional native libraries and aims to provide a cross-platform implementation to retrieve system information, such as OS version, processes, memory & CPU usage, disks & partitions, devices, sensors, etc.

The following data points are collected:

• CPU utilization (%)
• Memory utilization (%)

Event Format

• cpu obtained from oshi.hardware.CentralProcessor
• memory obtained from oshi.hardware.GlobalMemory

Usage

The easiest way to test out the sample is via the wiotp/oshi Docker image provided and the --quickstart command line option.

The resource requirements for this container are tiny, if you use the accompanying helm chart it is by default confiugured with a request of 2m CPU + 18Mi memory, and limits set to 4m cpu + 24Mi memory.

$ docker run -d --name psutil wiotp/oshi --quickstart
oshi
$ docker logs -tf oshi
Welcome to IBM Watson IoT Platform Quickstart, view a vizualization of live data from this device at the URL below:
https://quickstart.internetofthings.ibmcloud.com/#/device/3202968a743d/sensor/

To connect as a registered device in your organization you must set the following environment variables in the container's environment. These variables correspond to the device parameters for your registered device:

• WIOTP_IDENTITY_ORGID
• WIOTP_IDENTITY_TYPEID
• WIOTP_IDENTITY_DEVICEID
• WIOTP_AUTH_TOKEN

The following example shows how to set the environment variables:

$ export WIOTP_IDENTITY_ORGID=myorgid
$ export WIOTP_IDENTITY_TYPEID=mytypeid
$ export WIOTP_IDENTITY_DEVICEID=mydeviceid
$ export WIOTP_AUTH_TOKEN=myauthtoken
$ docker run -d -e WIOTP_IDENTITY_ORGID -e WIOTP_IDENTITY_TYPEID -e WIOTP_IDENTITY_DEVICEID -e WIOTP_AUTH_TOKEN --name oshi wiotp/oshi
oshi