Custom Sensors for JTI and gRPC

 

Overview

AppFormix includes several built-in JTI and gRPC sensors. To enable these sensors, you can add the sensor information to the network device configuration file or from GUI. See the topic Network Devices.

AppFormix also allows you to add new JTI or gRPC sensors into the system. You need to supply a configuration file, set the variables in Ansible group_vars, and then re-run the playbook. The AppFormix Ansible playbook will deploy the new sensor configurations and start parsing data for the new sensor.

Sensor Configuration File

The sensor configuration file you provide for AppFormix needs to have certain fields.

For example: sample_jti_grpc_config.py

This sample configuration file indicates and describes all the required fields for a JTI or gRPC configuration file. AppFormix Agent uses the parse_data function supplied in the configuration file to parse out the data received from the data. Then AppFormix pushes the output of the parser function to both event_stream and AppFormix DataManager.

Note that the series_list user return in the parse_data function is the series shown in the left of chart page, which indicates the ownership of the data (lines) in the charts. Metric names shown in the chart and alarm page is constructed by SENSOR_NAME and METRIC_LIST in the sensor configuration file.

Enable Sensors Through AppFormix Ansible Playbook

After completing the configuration file, you need to add the sensor from the AppFormix Ansible playbook.

Copy your sensor configuration file to the AppFormix Ansible directory and add the following variables in group_vars/all:

config_file.py should be the name of the sensor configuration file and type_of_sensor should be either “GRPC” if it is a gRPC sensor or “JTI” if it is a JTI sensor.

Then re-run the AppFormix Ansible playbook to add the new sensors to AppFormix. AppFormix copies your configuration file to all the Agents and then updates certified_plugins/grpc_config_all_sensors.json and certified_plugins/jti_config_all_sensors.json.

Related Documentation