cordial

README

cordial - ITRS Geneos Utilities Written In Go

Cordial is a collection of utilities, integrations and support packages for ITRS Geneos.

Current Version: v1.6.4

Released 2023-06-22

See CHANGELOG.md for more details.

Utilities

• geneos - Manage Your Geneos environment

• dv2email - Send a Dataview as an EMail

• libemail - Enhanced Drop-In Replacement for libemail

Integrations

• 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.

• 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 original libemail 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.

• 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 usage dictates.

• commands

  Geneos Gateway REST API Commands including programmatic support for snapshots of Dataviews. When used with the xpath package (below) this package 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 and pkg/gwhub

  These two packages are the start of Go 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.

Documentation

Overview

Package cordial is a collection of tools, packages and integrations for Geneos written primarily in Go

Index

• Variables
• func LogInit(prefix string)

Variables

var VERSION string

VERSION is a semi-global string variable

Functions

func LogInit

func LogInit(prefix string)

LogInit is called to set-up zerolog the way we like it