Siebel Exporter for Prometheus

A Prometheus exporter for Oracle Siebel CRM that collects metrics via the Siebel Server Manager (srvrmgr) command-line interface.

This project was inspired by barkadron/siebel_exporter and builds upon its ideas with additional features, improved error handling, and memory optimizations.

Features

• Collection of Siebel server status metrics
• Component groups, components, and tasks monitoring
• Server statistics and state values
• Flexible metric configuration via TOML files
• Automatic reconnection with exponential backoff
• Memory-efficient processing of large datasets
• Extensive logging and diagnostics
• Web UI for visualizing configuration and runtime statistics
• In-memory logs with UI for troubleshooting

Requirements

• Go 1.20 or higher
• Access to a Siebel environment with the srvrmgr utility
• Prometheus server for metrics collection

Installation

Using pre-built binaries

Download the latest release from the Releases page.

Building from source

# Clone the repository
git clone https://github.com/razims/siebel_prometheus_exporter.git
cd siebel_prometheus_exporter

# Build for current platform
go build -o siebel_exporter ./cli

# Build for all supported platforms (requires make)
make release

Cross-platform builds

The project includes a Makefile for building releases for multiple platforms:

# Build for Linux and Windows
make build

# Create full release including checksums
make release

# Build for specific platforms
make build-linux
make build-windows

Built binaries will be placed in the dist/ directory.

Usage

./siebel_exporter \
  --siebel.gateway=gateway.example.com \
  --siebel.enterprise=SBA_83 \
  --siebel.server=SIEBSRVR_01 \
  --siebel.user=SADMIN \
  --siebel.password=password \
  --web.listen-address=0.0.0.0:9963 \
  --log.level=info

Command-line Options

Option	Default	Description
--web.listen-address	0.0.0.0:9963	Address to listen on for web interface and telemetry
--web.telemetry-path	/metrics	Path under which to expose metrics
--web.disable-exporter-metrics	false	Exclude metrics about the exporter itself
--web.disable-logs	false	Disable in-memory log storage and /logs endpoint
--runtime.gomaxprocs	0	Set GOMAXPROCS, 0 means use default
--siebel.gateway		Siebel Gateway server address
--siebel.enterprise		Siebel Enterprise name
--siebel.server		Siebel Application server name
--siebel.user		Siebel user name
--siebel.password		Siebel user password
--siebel.srvrmgr-path	srvrmgr	Path to srvrmgr executable
--siebel.metrics-file	metrics.toml	Metrics configuration file
--siebel.date-format	2006-01-02 15:04:05	Date format for timestamp conversion
--siebel.disable-empty-metrics-override	false	Disable override of empty metrics in results with value of 0
--siebel.disable-extended-metrics	false	Disable any metric defined as 'Extended' in metrics file
--siebel.auto-reconnect	true	Enable automatic reconnection if connection is lost
--siebel.reconnect-delay	10s	Delay between reconnection attempts
--siebel.reconnect-after-scrape	false	Reconnect to server after each scrape
--log.level	info	Log level (debug, info, warn, error)

Web Interface

The exporter provides a web interface with several useful endpoints:

• / - Home page with configuration details and runtime statistics
• /metrics - Prometheus metrics endpoint
• /logs - View and filter log messages (unless disabled with --web.disable-logs)

Prometheus Configuration

Add the following to your prometheus.yml:

scrape_configs:
  - job_name: siebel
    static_configs:
      - targets: ['localhost:9963']

Metrics Configuration

Metrics are defined in a TOML file. The default is metrics.toml in the current directory.

[[Metric]]
Command = "list server show SBLSRVR_STATE, START_TIME, END_TIME"
Subsystem = "list_server"
[Metric.Help]
SBLSRVR_STATE = "State of the Siebel Application Server."
START_TIME = "Time the Siebel Application Server was started."
END_TIME = "Time the Siebel Application Server was stopped."
[Metric.ValueMap.SBLSRVR_STATE]
"Running" = "2"
"Shutting Down" = "3"
# ... additional states

Metric Definition Structure

Field	Description
Command	The srvrmgr command to execute
Subsystem	The Prometheus subsystem name
Help	Help text for each metric
ValueMap	Maps string values to numeric values for Prometheus
Labels	List of columns to use as labels
FieldToAppend	Field to append to the metric name
IgnoreZeroResult	Don't error if no metrics found
Extended	Mark as extended metric (can be disabled)

Troubleshooting

Logging

Use --log.level=debug for verbose logging during troubleshooting.

The exporter keeps the last 1000 log messages in memory, which can be viewed through the /logs web interface (unless disabled with --web.disable-logs).

Connection Issues

• Verify srvrmgr works directly when run manually
• Check network connectivity to the Siebel Gateway
• Ensure the credentials have sufficient permissions
• Try --siebel.reconnect-after-scrape if connections appear to become stale

Memory Usage

For large Siebel environments with many components:

• Monitor memory usage on the dashboard
• Consider using --siebel.disable-extended-metrics to reduce the amount of data collected
• Use --web.disable-logs to avoid storing logs in memory if not needed for troubleshooting

Development

Building

Linux/macOS (using Make)

# Build for Linux and Windows
make build

# Create full release including checksums
make release

# Build for specific platforms
make build-linux
make build-windows

Windows (using PowerShell)

# Build for both platforms
.\build.ps1

# Create full release including checksums
.\build.ps1 -Release

# Build for specific platforms
.\build.ps1 -BuildLinux
.\build.ps1 -BuildWindows

# Clean, test, then build release
.\build.ps1 -Clean -Test -Release

Built binaries and release artifacts will be placed in the dist/ directory.

Note: Linux builds on Windows require 7-Zip to be installed for .tar.gz creation. If 7-Zip is not available, compressed archives for Linux builds will be skipped.

Testing

go test ./...

License

MIT

Acknowledgments

• Prometheus
• Uber zap for structured logging
• barkadron/siebel_exporter for the initial shell implementation and inspiration