ITRS-Group / cordial

Cordial comprises a set of interrelated programs, integrations, libraries and packages for Geneos, principally written in Go.

Other

7 stars 0 forks source link

geneos itrs

readme

`cordial` - Geneos Utilities, Tools, Integrations and Packages

[!NOTE]

This is Version v1.18.2 - Released 2024-10-29 - See CHANGELOG.md for more details.

Tools and Utilities

Name	Description
`gdna`	Geneos Dynamic Netprobe Analysis
`geneos`	Manage Your Geneos environment
`dv2email`	Send a Dataview as an EMail
`files2dv`	Scan directories and files for information (not an FKM substitute!)
`gateway-reporter`	Generate monitoring coverage reports from setup files
`libemail`	Drop-In Updated Replacement for `libemail`
`san-config`	Dynamic SAN configuration file server (not yet fully integrated)

Integrations

Name	Description
servicenow	Send Geneos Alerts to ServiceNow
pagerduty	Send Geneos to PagerDuty

Packages

These packages provide Go interfaces to ITRS Geneos as well as utilities to help build useful tools for working with ITRS Geneos.

Package	Description
`config`	Configuration support, based on the excellent `viper` package, with local extensions to add expansion of embedded references including AES encrypted values, interpolation of environment variables and other configuration parameters as well as reading local files and from URLs. A one-stop-shop to load and save configurations makes initialising programs easier and simpler. The implementation is slowly maturing but is not complete and is subject to API changes as we find better ways to do things. The options on those functions that have been extended allow fine grained control of how interpolation is performed including restricting which methods are supported and adding custom functions for interpolation/expansion.
`email`	Functions extracted from the `libemail` sources to be more generally available, initially for the `dv2email` program but also for additional tools in the future. `libemail` has not been changed so that it remains fully backward compatible.
`geneos`	Automate Geneos XML configuration file generation using Go programs. The Geneos schema is not, and cannot be, fully implemented at this stage as the mappings have been hand-rolled rather than any attempt as machine translation. Automate Geneos XML configuration file generation using Go programs. The Geneos schema is not, and cannot be, fully implemented at this stage as the mappings have been hand-rolled rather than any attempt as machine translation.
`geneos/api`	An updated API package for sending data into Geneos. This is work in progress and is not ready for real-world use. This package will provide a unified API for both XML-RPC and REST APIs, within the constraints of the features of both.
`host`	Remote host integration extracted from `geneos` internal packages and turned into an extensible interface that supports local OS and remote SSH/SFTP operations. The API is still in flux and could do with more review and structure.
`plugins` `samplers` `streams` `xmlrpc`	These four packages provide support for the Geneos XML-RPC API Plugin.
`process`	Process management functions. There is a `Daemon()` function to background a process and the beginnings of program and batch managers. While the `Daemon()` function is relatively stable the other methods in this package are new and liable to change as their use matures.
`commands`	Geneos Gateway REST API Commands including programmatic support for `snapshots` of Dataviews. When used with the `xpath` package below it provides a simple way of executing REST commands on Geneos Gateways.
`xpath`	Geneos XPath handling functions and methods. This is a developing API and is not complete. Basic functionality exists to parse and manipulate simple XPaths.
`pkg/icp` `pkg/gwhub`	These two packages are the start of APIs to ITRS Capacity Planner and Gateway Hub respectively. They are work in progress and should not be used for anything other than testing for the moment.