cordial

package module

v1.28.1 Latest Latest Go to latest Published: Jul 14, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/itrs-group/cordial

Links

Open Source Insights

README ¶

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

[!NOTE]

This is Version v1.28.1 - Released 2026-07-14 - 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
servicenow2	Send Geneos Alerts to ServiceNow - Version 2
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.

Documentation ¶

Overview ¶

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

Index ¶

Variables
func ExecutableName(version ...string) (execname string)
func LogInit(prefix string, options ...LogOption) *slog.Logger
func RenderHelpAsMD(command *cobra.Command)
type LogOption

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	LogLevel   slog.LevelVar
	Logger     *slog.Logger = slog.Default()
	LogHandler slog.Handler
)

View Source

var VERSION string

VERSION is a semi-global string variable

Functions ¶

func ExecutableName ¶ added in v1.11.0

func ExecutableName(version ...string) (execname string)

ExecutableName returns a processed executable name. Symlinks are resolved and the basename of the resulting file has, at most, one extension removed and then if there is a '-' followed by the matching cordial version string. Note this final version string must match first version argument or the cordial one compiled into the binary.

For example:

`geneos.exe` -> `geneos`
`dv2email-v1.10.0` -> `dv2email`

func LogInit ¶

func LogInit(prefix string, options ...LogOption) *slog.Logger

LogInit is called to set-up logging with our chosen defaults. The default is to log to STDERR.

If logfile is passed and the first element is not empty, then use that as the log file unless it is either "-" (which means use STDOUT (not STDERR) or equal to the os.DevNull value, in which case is io.Discard.

The environment variable `CORDIAL_LOG_OUTPUT` can be used to override the logfile option. If `CORDIAL_LOG_OUTPUT` is set, then the cordial.SetLogfile option is ignored.

The environment variable `CORDIAL_LOG_FORMAT` can be used to set the log format. If `CORDIAL_LOG_FORMAT` is set to "json", then the log format is JSON, otherwise the format is a human readable format, with colouring enabled if the output is a termial according to `term.IsTerminal()`.

func RenderHelpAsMD ¶ added in v1.7.0

func RenderHelpAsMD(command *cobra.Command)

RenderHelpAsMD sets the help template of the given cobra.Command to render the long description and short description as Markdown, using the src.elv.sh/pkg/md package.

Types ¶

type LogOption ¶ added in v1.27.0

type LogOption func(*logOpts)

func Format ¶ added in v1.28.0

func Format(format string) LogOption

func LumberjackOptions ¶ added in v1.14.0

func LumberjackOptions(lj *lumberjack.Logger) LogOption

LumberJackOptions set the log writer to the configured lumberjack settings but only if the lj.Filename field is not empty, otherwise it is ignored.

func RotateOnStart ¶ added in v1.14.0

func RotateOnStart(rotate bool) LogOption

func SetLogLevel ¶ added in v1.28.0

func SetLogLevel(level slog.Level) LogOption

SetLogLevel takes a slog debug level to use as a default

func SetLogfile ¶ added in v1.14.0

func SetLogfile(logfile string) LogOption

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
examples
api command
api/cpu
api/generic
api/memory
api/process
api2 command
api2/cpu
cliauth command
cliauth/cmd
dockerlogs command
dockerlogs/cmd
gdna
cmd
integrations
pagerduty command Standalone pagerduty integration executable	Standalone pagerduty integration executable
pagerduty/cmd
servicenow command
servicenow/cmd
servicenow/snow
servicenow2 command
servicenow2/cmd
servicenow2/cmd/client
servicenow2/cmd/proxy
servicenow2/internal/snow
libraries
libalert command
libemail command
pkg
certs The certs package provides functions for handling TLS certificates and keys.	The certs package provides functions for handling TLS certificates and keys.
config Package config adds local extensions to viper as well as supporting Geneos encryption key files and basic encryption and decryption.	Package config adds local extensions to viper as well as supporting Geneos encryption key files and basic encryption and decryption.
email The email package provides Geneos specific email processing to support libemail and other email senders using Geneos formatted parameters.	The email package provides Geneos specific email processing to support libemail and other email senders using Geneos formatted parameters.
geneos
geneos/api
geneos/commands Package commands wraps the Geneos Gateway REST Command API in Go	Package commands wraps the Geneos Gateway REST Command API in Go
geneos/netprobe
geneos/plugins
geneos/samplers
geneos/streams
geneos/xmlrpc
geneos/xpath Package to handle Geneos Gateway specific XPaths	Package to handle Geneos Gateway specific XPaths
gwhub
host Provides remote file and command functions	Provides remote file and command functions
icp Package icp provides binding the the ITRS Capacity Planner data model	Package icp provides binding the the ITRS Capacity Planner data model
ims package ims provides basic support for Incident Management System (IMS) integration, such as ServiceDesk Plus, ServiceNow, etc.	package ims provides basic support for Incident Management System (IMS) integration, such as ServiceDesk Plus, ServiceNow, etc.
logger
process
reporter The reporter package provides a simple interface to generating Geneos dataviews, with headlines and a data table, either though the XML-RPC API, as Toolkit compatible CSV, XLSX workbooks or a number of other formats.	The reporter package provides a simple interface to generating Geneos dataviews, with headlines and a data table, either though the XML-RPC API, as Toolkit compatible CSV, XLSX workbooks or a number of other formats.
rest
tools
dv2email command
dv2email/cmd
files2dv command
files2dv/cmd
gateway-reporter command
gateway-reporter/cmd
geneos command
geneos/cmd Package cmd contains all the main commands for the `geneos` program	Package cmd contains all the main commands for the `geneos` program
geneos/cmd/aescmd Package aescmd groups related AES256 keyfile and crypto commands	Package aescmd groups related AES256 keyfile and crypto commands
geneos/cmd/cfgcmd Package cfgcmd groups config commands in their own package	Package cfgcmd groups config commands in their own package
geneos/cmd/hostcmd Package hostcmd contains all the host subsystem commands	Package hostcmd contains all the host subsystem commands
geneos/cmd/imscmd
geneos/cmd/initcmd Package initcmd contains all the init subsystem commands	Package initcmd contains all the init subsystem commands
geneos/cmd/pkgcmd Package pkgcmd contains all the package subsystem commands	Package pkgcmd contains all the package subsystem commands
geneos/cmd/pscmd
geneos/cmd/tlscmd Package tlscmd contains all the TLS subsystem commands	Package tlscmd contains all the TLS subsystem commands
geneos/internal/component/ac2 Package ac2 supports installation and control of the Active Console	Package ac2 supports installation and control of the Active Console
geneos/internal/component/ca3
geneos/internal/component/fa2
geneos/internal/component/fileagent
geneos/internal/component/floating
geneos/internal/component/gateway
geneos/internal/component/licd
geneos/internal/component/minimal
geneos/internal/component/netprobe
geneos/internal/component/san
geneos/internal/component/ssoagent
geneos/internal/component/webserver
geneos/internal/geneos Package geneos provides internal features to manage a typical `Best Practice` installation layout and the conventions that have formed around that structure over many years.	Package geneos provides internal features to manage a typical `Best Practice` installation layout and the conventions that have formed around that structure over many years.
geneos/internal/instance
geneos/internal/profiles
geneos/internal/responses
geneos/internal/restore
geneos/internal/values
geneos/utils/docs command The docs utility builds markdown documentation from the geneos program sources and writes to the `docs` directory.	The docs utility builds markdown documentation from the geneos program sources and writes to the `docs` directory.
ims-gateway command
ims-gateway/cmd
ims-gateway/internal/sdp
ims-gateway/internal/snow package snow provides the ServiceNow integration for the IMS Gateway.	package snow provides the ServiceNow integration for the IMS Gateway.
san-config command
san-config/cmd
sso-diag command
sso-diag/cmd
utils
docs command docs creates documentation from the tools and integrations in the repo (except `geneos` which has it's own copy of this with custom mods)	docs creates documentation from the tools and integrations in the repo (except `geneos` which has it's own copy of this with custom mods)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL