The Lumino Manua (1.4)

Skip to end of metadata
Go to start of metadata

In This Section

Overview

This page contains instructions for installing the Lumino Agent standalone bundle, which is a tarball that includes:

  • A Robin instance; and
  • The Lumino Agent deployed to the embedded Robin instance.

Install the Lumino Agent bundle and add the agent to your Lumino Server instance to monitor Talon systems on your network.

Prerequisites

These instructions assume that:

  • Java 8 is installed on the target host, and the JAVA_HOME environment variable is properly configured.
  • InfluxDB 1.0+ is installed and running somewhere on the network reachable from the target host. We currently test against Influx 1.1.1. 
    • The installation documentation for InfluxDB is available from docs.influxdata.com. InfluxDB is not a Neeve product.
  • System Requirements:
    • The Lumino Agent requires 4GB of ram.
    • 5 Gb disk space.

It is not necessary to run the Lumino Agent and Lumino Server on the same host.

Installing or Upgrading Lumino Agent

The first step is to download the Lumino Agent distribution tarball on the target host (i.e. the host on which you wish to run Lumino Agent). Be sure to substitute a real username in place of service-user – we suggest creating a lumino user and running Lumino services as that user.

Next, unpack the agent distribution:

(Upgrade only) Stop any previous running instances of Lumino Agent:

Now create the "current" symlink to the release that we just unpacked:

Configuring the Lumino Agent

Optionally, the agent's properties can be configured in the current/nvx-lumino-agent/robin.conf. When the agent first starts up the robin.conf file is copied to data/robin/robin.conf so that in future upgrades the configuration is preserved. So if you have already attempted to start the agent or are doing an upgrade, then the values below should be edited in data/robin/robin.conf. 

 

PropertyProperty NameDefaultDescription
Lumino Agent Portlumino.agent.http.port7778

The port exposed by the agent to Lumino Server.

Changing this port is only recommended if you anticipate a port conflict.

(warning) Note that changing this value requires that the agent's connection information be updated in the Lumino Server's Lumino Agents UI once the server is started.

Example (solace discovery):
nv.server.admin.sma.bus.descriptor=solace://solaceaddress:55555&SESSION_VPN_NAME=default&use_default_queue_name=false&use_default_queue_name_as_default_client_id=true&topic_starts_with_channel=false&single_session=true

Lumino Discoverynv.discovery.descriptormcast://224.0.1.200:4090

Sets the discovery descriptor to be used to discover running XVMS.

  • Each Lumino agent should have a unique discovery address which isolates the set of XVMS that it manages.
  • The discovery address specified here overrides that in config.xml from applications this agent deploys unless those applications define server discovery addresses explicity.

Example: using solace discovery you may specify nv.discovery.descriptor=mcast://224.0.1.200:4099

Admin Transportsnv.server.admin.transportsdirect

The default behavior of a Lumino agent is to directly connect to discovered XVMs over direct tcp connections. If you'd prefer to use messaging as the monitoring transport this may be changed to 'sma' and the bus.descriptor must be specified (see below).

Example: nv.server.admin.transports=sma

SINCE 1.4

nv.server.admin.sma.bus.descriptor-

If configuring to use Admin over SMA, this property sets the bus connection descriptor that is used to monitor and control discovered XVMs.

Example (admin over solace):
nv.server.admin.sma.bus.descriptor=solace://solaceaddress:55555&SESSION_VPN_NAME=default&use_default_queue_name=false&use_default_queue_name_as_default_client_id=true&topic_starts_with_channel=false&single_session=true

SINCE 1.4

Influx Urllumino.agent.influx.urlhttp://localhost:8086

The connection url to influx. Statistic captured by the agent are written to influx which is the data source used for dashboards.

By default, this is set to the bundled influx instance. It should be changed if you change influx connection information below or plan to point the agent at a difference influx instance.

(warning) When changing the agent's datasource, the corresponding changes need to be made in the server's Data Source configuration UI once the server is started.

Influx Usernamelumino.agent.influx.usernamerootThe username used to connect to influx to write agent collected data.
Influx Passwordlumino.agent.influx.passwordrootThe password used to connect to influx to write agent collected data.

Launching the Lumino Agent

Finally, the Lumino Agent can be started:

The start.sh script can be run with the --reprovision flag to reconfigure the agent after making configuration changes to robin.conf or its config.xml. It is a good idea to specify the --reprovision flag after an upgrade as well.

Registering the Agent with a Lumino Server

Once the application is up and running, you can log in to the Lumino Server UI (i.e. port 8001 by default on the host running Lumino Server) and add the agent you just installed (e.g. http://<agent-host-or-ip>:7778) via the drop-down menu:

Once an agent has been configured, Lumino Server will infer the appropriate InfluxDB URL.

If you need to stop the Lumino Agent at any time, you can simply run the stop script:

  • No labels

10 Comments

  1. Girish Mutreja

    need more clarity on what "service-user" is

  2. Girish Mutreja

    Issues downloading the agent bundle 

    1. repository should be neeve-licensed-milestones, not snapshots
    2. version should be 0.1-M1
    3. classifier should be default-agent
    4. "mgm" user does not have access to this. maybe not needed right now but definitely in the next few weeks.

    1. Unknown User (tom)

      Right – thanks!

    2. Unknown User (tom)

      Girish Mutreja, link ought to refer to the neeve-licensed repo now – suggest we link to the latest release (vs a specific milestone) until we've shipped a "gold standard" release. Resolving this leaving version=LATEST alone, but let me know if you disagree.

  3. Girish Mutreja

    Issues with start

    [appadmin@vmaurora02d current]$ ./start.sh 

    ./start.sh: line 3: ./setenv.sh: No such file or directory

    ./start.sh: line 6: [: openjdk version "1.8.0_77": integer expression expected

    ./start.sh: line 14: /bin/rbn: No such file or directory

    ./start.sh: line 14: exec: /bin/rbn: cannot execute: No such file or directory

     

    1. Unknown User (tom)

      Something's pretty wrong if it can't find setenv.sh. Can you add "set -x" (without the quotes) above the line where we source setenv.sh and maybe shoot me the output in an email?

    2. Unknown User (tom)

      Also notice you're using the Agent Bundle which is pretty much untested compared to the standalone XAR and server (my understanding was you would be installing the XAR into an existing Robin install, so I spent my time there). Let me give the agent bundle a crack on perf2.

    3. Unknown User (tom)

      Looking at the default-agent tarball it is indeed missing setenv.sh. I can email it to you and/or cut a new milestone if you like. Sorry about that.

    4. Girish Mutreja

      BTW, yes, the plan sometime ago was to use the XAR. It changed when we decided to go with Lumino agent in a separate robin area (2.2) and change it to point to the existing (2.0) area. I can still do that - install robin 2.2, deploy and launch the XAR from there if you prefer.

       

    5. Unknown User (tom)

      I believe the agent bundle ought to be sorted now, but need to test it properly before we give this another shot. https://jira.neeveresearch.com/browse/LUM-48