Running cygnus-ngsi as a process

Cygnus implements its own startup script, cygnus-flume-ng which replaces the standard flume-ng one, which in the end runs a custom com.telefonica.iot.cygnus.nodes.CygnusApplication instead of a standard org.apache.flume.node.Application.

In foreground (with logging):

$ APACHE_FLUME_HOME/bin/cygnus-flume-ng agent --conf APACHE_FLUME_HOME/conf -f APACHE_FLUME_HOME/conf/agent_<id>.conf -n <agent_name> -Dflume.root.logger=INFO,console -Duser.timezone=UTC [-p <mgmt-if-port>] [-g <web-app-port>] [-t <polling-interval>]

In background:

$ nohup APACHE_FLUME_HOME/bin/cygnus-flume-ng agent --conf APACHE_FLUME_HOME/conf -f APACHE_FLUME_HOME/conf/agent_<id>.conf -n <agent_name> -Dflume.root.logger=INFO,LOGFILE -Duser.timezone=UTC -Dfile.encoding=UTF-8 [-p <mgmt-if-port>] [-g <web-app-port>] [-t <polling-interval>] [--no-yafs] &

The parameters used in these commands are:

  • agent. This is the type of application to be run by the cygnus-flume-ng script.
  • --conf. Points to the Apache Flume configuration folder.
  • -f (or --conf-file). This is the agent configuration (agent_<id>.conf) file. Please observe when running in this mode no cygnus_instance_<id>.conf file is required.
  • -n (or --name). The name of the Cygnus agent to be run.
  • -Dflume.root.logger. Changes the logging level and the logging appender for log4j.
  • -Duser.timezone=UTC. Changes the timezone in order all the timestamps (logs, data reception times, etc) are UTC.
  • -Dfile.encoding=UTF-8. Sets the JVM encoding to UTF-8.
  • -p (or --mgmt-if-port). Configures the listening port for the Management Interface. If not configured, the default value is used, 5080.
  • -g (or --web-app-port). Configures the port where the web application for Cygnus runs. If not configured, the default value is used, 5050.
  • -t (or --polling-interval). Configures the polling interval (seconds) when the configuration is periodically reloaded. If not configured, the default value is used, 30.
  • --no-yafs. Disables Cygnus' YAFS (Yet Another Flume Supervisor), a supervisor in charge of starting an ordered stop of Cygnus when some thread is found dead.