Requirements for using the RPC API
To access syslog-ng Store Box(SSB) using the RPC API, the following requirements must be met:
The appliance can be accessed using a RESTful protocol over authenticated HTTPS connections.
The user account used to access SSB via RPC must have Search privilege (which provides access to all logspaces), or must be a member of the groups listed in the Access Control option of the particular logspace. For details on managing user privileges, see Modifying group privileges.
RPC client requirements
The client application used to access syslog-ng Store Box(SSB) must meet the following criteria:
Support RESTful web APIs over HTTPS
Properly handle complex object types
Include a JSON decoder for interpreting the results of search operations
Documentation of the RPC API
The documentation of the syslog-ng Store Box(SSB) RPC API is available online from the following URL: https://<ip-address-of-SSB>/api/4/documentation. This documentation contains the detailed description of public calls, with examples. For a quickstart guide, see RPC API Quickstart Guide.
This section describes monitoring syslog-ng Store Box(SSB).
If you intend to monitor SSB, the general rules of monitoring an Ubuntu system apply.
Depending on your monitoring tool, check out the available SNMP templates related to your system, and use those to monitor the general parts of SSB.
Do not install any monitoring agent on the SSB appliance. Any alteration to the system is unsupported.
For details on receiving e-mail alerts or SNMP traps on health- and system-related issues, see Configuring system monitoring on SSB.
For details on SNMP communities, see View node ID and community.