Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
f3974fc
initial stonebranch integration version
Len0608 Dec 15, 2025
2c40f13
update readme
Len0608 Dec 15, 2025
f627cde
update CODEOWNERS for stonebranch integration
Len0608 Dec 15, 2025
8b885d6
synced CI
Len0608 Dec 15, 2025
134d854
update example conf
Len0608 Dec 15, 2025
a8d979f
fix: remove period from "TBD" in README
Len0608 Dec 15, 2025
6dd4bbd
using ddev lint on stonebranch files
Len0608 Dec 16, 2025
8739571
ran ddev test --lint stonebranch to fix linting issues
Len0608 Jan 12, 2026
176a7c7
added metadata.csv, including the metrics that will be scraped from t…
Len0608 Jan 20, 2026
95c5301
ddev test --fmt stonebranch update files.
Len0608 Jan 20, 2026
6744cce
updated datadog check base dependency
Len0608 Jan 20, 2026
bf8fcdf
fixed unit test issues.
Len0608 Jan 20, 2026
fe98b36
fixed import order in unit test
Len0608 Jan 20, 2026
89f2bcb
Updated, metadata.csv removing the set interval, changed check.py str…
Len0608 Jan 26, 2026
4a60c0c
updated metadata, so that ddev validate metadata stonebranch passes
Len0608 Jan 26, 2026
efa65a1
fixed missing value in manifest.json
Len0608 Jan 26, 2026
0c0c778
ran ddev validate models stonebranch -s to sync data model files
Len0608 Jan 26, 2026
cdb98c4
removed manifest.json
Len0608 Jan 26, 2026
966cf38
ddev validate to fix CI config
Len0608 Jan 28, 2026
32a8413
fixed typo
Len0608 Jan 28, 2026
8b7a981
Fixed metrics now being applied in check from the metrics.py table
Len0608 Jan 29, 2026
81aa78e
ddev ci validation
Len0608 Jan 30, 2026
d4db5c1
Updated metadata csv to be in line with the metrics given, fixed wron…
Len0608 Feb 19, 2026
08b2354
Update stonebranch/README.md
Len0608 Feb 10, 2026
86ead46
Update stonebranch/README.md
Len0608 Feb 10, 2026
21ee611
Update stonebranch/README.md
Len0608 Feb 10, 2026
cf272f2
Update stonebranch/README.md
Len0608 Feb 10, 2026
c4253b5
Update stonebranch/README.md
Len0608 Feb 10, 2026
2c8987e
Fix for uc history metrics now showing
Len0608 Mar 5, 2026
3a0ceb7
Add service check, expand metric groups, add tests
Len0608 Jul 30, 2026
f7ae781
Sync config models with ddev 17.0.1
Len0608 Jul 30, 2026
941cff8
Sync conf.yaml.example with ddev 17.0.1
Len0608 Jul 30, 2026
1dab2e3
Merge branch 'master' into stonebranch
Len0608 Jul 30, 2026
98b938d
Update metric queries and metadata for consistency and accuracy
Len0608 Aug 4, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .ddev/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ storm = "Storm"
[overrides.metrics-prefix]
aerospike_enterprise = "aerospike."
snmpwalk = "snmpwalk."
stonebranch = "stonebranch."
warpstream = "warpstream."
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,7 @@ code-coverage.datadog.yml @DataDog/agent-integr
/statsig/ @marcos-statsig support@statsig.com @DataDog/ecosystems-review
/statsig_rum/ @crstatsig support@statig.com
/steadybit/ @bripkens support@steadybit.com @DataDog/ecosystems-review
/stonebranch/ @len06080 len-maurice.seemann@stonebranch.com
/storm/ @platinummonkey
/stormforge/ @bradbeam @tperol support@stormforge.io @DataDog/ecosystems-review
/superwise/ @oryan-omer support@superwise.ai @DataDog/ecosystems-review
Expand Down
19 changes: 19 additions & 0 deletions .github/workflows/test-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1393,6 +1393,25 @@ jobs:
test-py3: ${{ inputs.test-py3 }}
setup-env-vars: "${{ inputs.setup-env-vars }}"
secrets: inherit
j712c9df:
uses: DataDog/integrations-core/.github/workflows/test-target.yml@5f6b58dfb609ea0afb37762612dbb6e2c37d2933
with:
job-name: stonebranch
target: stonebranch
platform: linux
runner: '["ubuntu-22.04"]'
repo: "${{ inputs.repo }}"
context: ${{ inputs.context }}
python-version: "${{ inputs.python-version }}"
latest: ${{ inputs.latest }}
agent-image: "${{ inputs.agent-image }}"
agent-image-py2: "${{ inputs.agent-image-py2 }}"
agent-image-windows: "${{ inputs.agent-image-windows }}"
agent-image-windows-py2: "${{ inputs.agent-image-windows-py2 }}"
test-py2: ${{ inputs.test-py2 }}
test-py3: ${{ inputs.test-py3 }}
setup-env-vars: "${{ inputs.setup-env-vars }}"
secrets: inherit
j5870f9b:
uses: DataDog/integrations-core/.github/workflows/test-target.yml@5f6b58dfb609ea0afb37762612dbb6e2c37d2933
with:
Expand Down
6 changes: 6 additions & 0 deletions stonebranch/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# CHANGELOG - Stonebranch

## 1.0.0 / 2025-12-15

***Added:***
* Initial Release
148 changes: 148 additions & 0 deletions stonebranch/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
# Agent Check: Stonebranch

## Overview

Stonebranch Universal Automation Center (UAC) is an enterprise workload automation platform used to orchestrate, schedule, and monitor complex workflows across distributed systems, applications, and infrastructure.

The Stonebranch integration provides visibility into UAC by scraping metrics exposed by the Universal Controller Prometheus endpoint and surfacing them in Datadog. This enables operations, SRE, and platform teams to monitor automation health, execution activity, and system capacity from a single observability platform.

The integration automatically collects a curated set of core UC metrics and supports optional metric groups for deeper JVM, process, and license-level insights. Metrics are enriched with labels emitted by the UC, enabling Datadog users to build workflow-, agent-, and controller-centric views and dashboards.

The integration collects the following Datadog telemetry types:
- **Metrics**: Task executions, workflow outcomes, agent and OMS status, controller health, database pools, and license usage.

With this integration, teams can proactively detect automation failures, capacity constraints, and infrastructure issues impacting workload execution.


## Setup

The Stonebranch check is not included in the [Datadog Agent][1] package and must be installed separately.

### Installation

Install the Stonebranch integration using the Datadog Agent integration command.

1. Run the following command to install the integration:
```shell
datadog-agent integration install -t datadog-stonebranch==<VERSION>
```

### Configuration

1. Edit the `stonebranch.d/conf.yaml` file in the `conf.d/` directory of your Datadog Agent configuration.

The Universal Controller exposes metrics via its Prometheus endpoint and the Agent must be able to authenticate to it.

Minimal configuration example:
```yaml
instances:
- openmetrics_endpoint: https://stonebranch.controller/uc/resources/metrics

auth_type: basic
username: <USERNAME>
password: <PASSWORD>

metric_groups:
- jvm
- process

tags:
- env:prod
- service:stonebranch
```

* Default metrics are always collected.
* Optional metric groups can be enabled using `metric_groups`.
* Individual metrics can be excluded using `exclude_metric_names`.

See the sample `stonebranch.d/conf.yaml.example` file for the full list of available configuration options and check the [Stonebranch documentation][2] for the complete list of available metrics.

2. Restart the Datadog Agent.


### Validation

Run the Agent status command and verify that `stonebranch` appears under the **Checks** section:
```shell
datadog-agent status
```


## Metric Groups (Opt-in)

The Stonebranch integration always collects a curated set of core Universal Automation Center (UAC) metrics by default. These metrics provide visibility into task execution, workflows, controller health, agents, OMS connectivity, and overall system status.

Additional metrics are organized into **opt-in metric groups**. These groups allow you to selectively enable deeper visibility without collecting unnecessary metrics by default.

Metric groups are enabled using the `metric_groups` option in the instance configuration.

### Available Metric Groups

The following metric groups are supported:

* **jvm**
Collects JVM-level metrics for the Universal Controller, including thread counts and memory usage.

* **process**
Collects operating system process metrics such as CPU usage, resident memory, and open file descriptors for controller processes.

* **license_details**
Collects detailed license consumption metrics, including agent counts, cluster nodes, task definitions, and monthly execution usage.

### Enabling Metric Groups

To enable one or more metric groups, add the `metric_groups` option to your instance configuration:
```yaml
instances:
- openmetrics_endpoint: https://stonebranch.controller/uc/resources/metrics

auth_type: basic
username: <USERNAME>
password: <PASSWORD>

metric_groups:
- jvm
- process
```

Metric groups are additive. When enabled, the metrics in the selected groups are collected in addition to the default Stonebranch metrics.

### Excluding Individual Metrics

If you want to exclude specific metrics after defaults and metric groups have been expanded, use the `exclude_metric_names` option:
```yaml
exclude_metric_names:
- uc_build_info
```

This option removes metrics by exact Prometheus metric name and is applied after all default and group-based metrics have been selected.

### Notes

* Default Stonebranch metrics are collected unless explicitly excluded using `exclude_metric_names`.
* Metric groups are optional and disabled unless explicitly configured.
* Advanced OpenMetrics filtering options (such as regex-based exclusions and label-based filtering) are available through standard OpenMetrics configuration options. See the sample configuration file for details.


## Data Collected

### Metrics

The integration collects a curated set of Stonebranch metrics by default, including task execution counts, workflow status, agent and OMS health, and controller-level statistics.

Optional metric groups provide additional coverage:

* JVM metrics
* Process-level resource metrics
* License consumption and capacity metrics

See `metadata.csv` for the complete list of metrics exposed by this integration.

## Support

Need help? Contact [Stonebranch support][3].


[1]: https://github.com/DataDog/integrations-extras
[2]: https://stonebranchdocs.atlassian.net/wiki/spaces/UC79/pages/1614446871/Universal+Controller+-+Provided+Metrics
[3]: https://www.stonebranch.com/contact
38 changes: 38 additions & 0 deletions stonebranch/assets/configuration/spec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Stonebranch
files:
- name: stonebranch.yaml
options:
- template: init_config
options:
- template: init_config/openmetrics

- template: instances
options:
- template: instances/openmetrics

- name: metric_groups
description: |
Opt-in metric groups to scrape in addition to the default Stonebranch metrics.
Allowed values: `jvm`, `process`, `license_details`.
value:
type: array
items:
type: string
example:
- jvm
- process
compact_example: true
enabled: true

- name: exclude_metric_names
description: |
Metrics to exclude by exact Prometheus metric name.
(This is applied after defaults and metric groups are expanded.)
value:
type: array
items:
type: string
example:
- uc_build_info
compact_example: true
enabled: true
Loading
Loading