Skip to content

A project to share custom built monitors for the SolGeneos product that supports monitoring of Solace Event Brokers in the ITRS Geneos monitoring tool

License

Notifications You must be signed in to change notification settings

itsJamilAhmed/solace-custom-monitor-solgeneos

 
 

Repository files navigation

SolGeneos Custom Monitors

Overview

The Solace Geneos Agent (a.k.a SolGeneos) allows for the monitoring of Solace Event Brokers in the Geneos monitoring tool by ITRS.
While coming with a large number of dataviews to monitor various product aspects such as pending messages on queues, health of the underlying hardware, and connectivity status to other event-brokers, SolGeneos is an extendable framework that allows customers to build additional monitors for dataviews containing metrics specific to their own requirements.

This repository contains further examples of custom monitors that can support monitor development efforts by customers.

⚠️ Important Notice ⚠️
Customer developed monitors and example code, such as those in this project, are not supported by Solace as part of the SolGeneos product support. Check out CONTRIBUTING.md to raise issues/bugs, submit fixes, request features, submit features, submit ideas, or to ask questions. Responses will be 'best effort' from contributors.

👇 Click to jump ahead to usage instructions

Table of contents

Custom Monitors Index

No. Name Function
1 Users Monitor List currently configured CLI and FTP users. Serves as a development sample.
2 QueuesEx Monitor Extended version of Queues monitor with several enhancements
3 TopicEndpointsEx Monitor Extended version of TopicEndpoints monitor with several enhancements
4 MessageRates Monitor New monitor to display message and byte rate activity as well as identify top-talkers and track high water marks (HWMs)
5 MessageVPNLimits Monitor New monitor to clearly display 'current usage vs. max limit' of various capacity-related resources at a message-vpn level
6 BrokerLimits Monitor New monitor to clearly display 'current allocated vs. broker hard limit' of various capacity related resources
7 ClientProfileLimits Monitor New monitor to clearly display 'current usage vs. max limit' of various capacity-related resources at a client profile level
8 ClientsTopPublishers Monitor New monitor to show the top 10 connected clients by publisher activity
9 ClientsTopSubscribers Monitor New monitor to show the top 10 connected clients by publisher activity
10 ClientsSlowSubscribers Monitor New monitor to show all clients the broker has determined to be slow subscribers
11 MessagingTester Monitor New monitor for 'synthetic monitoring', periodically performing message send and receive to validate the infrastructure more holistically
12 SoftwareSystemHealth Monitor New monitor specifically for Software Broker deployments. Providing health metrics for the environment the broker is deployed in
13 MessageVPNBridgeRates Monitor New monitor to show the configured message VPN bridges, the message and byte rate activity of them, as well as health of the underlying TCP connections.
14 ConfigSyncStatus Monitor New monitor to show the status of entries in the Config-Sync database.

(1) Users Monitor

This monitor builds significantly on the sample of the same name provided provided with the SolGeneos product. Enhancements over the original version include:

  • The addition of more headline fields on the dataview containing information such as the total counts of each user type. (Headlines are useful places to provide summary or aggregated information of the main dataview contents. These can then be referenced by dashboard elements too.)
  • The use of Java8 Stream API to further process the SEMP response to apply filters and create subsets of the response.
  • The use of a property file to control the behaviour of the monitor code and how data is presented
  • The ability to dynamically generate multiple dataviews from the same monitor, especially if the overall data needs to be segmented for different sets of Geneos users.
  • The introduction of a new "Multi Record SEMP Parser" that can be used in a generic fashion across different SEMP responses to extract the records of interest.

The aim of this particular monitor is to continue acting as a development sample, it's operational usefulness in a true monitoring enviromment is limited.

(2) QueuesEx Monitor