TrackMe Ecosystem — Companion Add-ons¶
What this page is
An inventory of every TrackMe companion technology add-on (TA) and
the Splunk SOAR (Phantom) connector that extend TrackMe beyond the
main trackme Splunk app. For each one: purpose, data it
ingests / produces, Splunk surfaces (commands, REST handlers, alert
actions), the TrackMe use cases it unlocks, dependencies, and which
FLX templates pair with it (if any).
- Audience:
TrackMe administrators, architects, and operators scoping what else they can plug into TrackMe.
Three axes of extension¶
TrackMe alone monitors data that already lives in Splunk (indexes, scheduled searches, hosts, sourcetypes, fields, lookups via Splunk REST) and orchestrates alerts / AI within the Splunk surface. The companion add-ons extend TrackMe in three orthogonal directions:
External data sources made first-class TrackMe entities — Cribl Stream / Edge pipelines and fleet nodes (
TA-trackme-cribl), Google SecOps log feeds (TA-trackme-google-secops), and lookup files / KV-stores at filesystem-mtime precision (TA-trackme-lookupmonitor). All can be turned into FLX or hybrid-tracker entities that participate in priority, SLA, ML outliers, stateful alerting and the AI Assistant — exactly like native DSM entities.Bidirectional incident orchestration with external systems —
TA-trackme-xsoar(Cortex XSOAR active-command incident lifecycle with a resilient retry store) andtrackme-app-on-soar(Splunk SOAR playbook-driven ACKs, maintenance windows, ML retraining, logical-group management and priority / policy bulk-edits).Operational resilience and deployment flexibility —
TA-trackme-conf-managerfor transactional, retryable TrackMe REST orchestration (CI / IaC pipelines).
Without the companions you keep an in-Splunk monitoring tool. With them, TrackMe becomes a multi-vendor data-quality control plane that closes the loop into the SOC’s ticketing, automation, and configuration-management workflows.
Common architectural patterns¶
Two patterns appear repeatedly across the companion add-ons:
API-bridge pattern — A single custom command (
cribl/secops) plus a small persistent REST handler for account configuration. Used byTA-trackme-criblandTA-trackme-google-secops. From TrackMe’s perspective, the command makes external API data look like SPL events so any FLX or hybrid tracker can consume it.Resilient transaction store — A KV collection (per-account, replicate-false) records pending / failed REST transactions, plus a 15-minute scheduled saved-search replay loop. Used by
TA-trackme-conf-manager(against TrackMe’s own REST) andTA-trackme-xsoar(against the XSOAR REST). Guarantees that a transaction eventually lands even through network blips or destination outages.
External data sources¶
TA-trackme-cribl¶
Purpose |
Two-way Splunk-to-Cribl-API bridge for both Cribl Stream
(Logstream) and Cribl Edge, callable from SPL via |
Splunk surfaces |
Custom command |
TrackMe use cases unlocked |
FLX live-API tracking of Cribl Edge node health via
|
Dependencies |
Cribl Stream or Cribl Edge deployment with API access; Cribl client_id / secret. Independent of trackme-app at runtime; the FLX template above and the use-case docs are oriented around TrackMe. |
FLX templates that pair |
Hard requirement: |
See also |
TA-trackme-google-secops¶
Purpose |
Splunk SPL bridge to Google Security Operations (Chronicle) UDM search API. |
Splunk surfaces |
Custom command |
TrackMe use cases unlocked |
Hybrid trackers and FLX entities driven by Google SecOps log
feed ingestion — e.g. one entity per |
Dependencies |
Hard dependency on trackme-app — the README explicitly states:
“TrackMe must be installed and licensed on the search head(s)
where this application is deployed. The ``secops`` custom command
will fail with a licensing error” — the TA reuses TrackMe’s
licensing framework. GCP service account with
|
FLX templates that pair |
None ship — operators build SecOps trackers directly via the
|
TA-trackme-lookupmonitor¶
Purpose |
Generative SPL command that enumerates CSV-file and KV-store lookups visible to the running user with reliable filesystem mtimes and accurate row counts. |
Splunk surfaces |
Custom generating command |
TrackMe use cases unlocked |
This is the data source behind TrackMe’s “Lookups monitoring”
search mode in the Hybrid Trackers wizard — see
Lookup monitoring. It lets a tenant create
TrackMe entities, one per lookup, tracking last-modification
freshness and growth / shrinkage of row count — so you can build
alerts like “this critical KV-store collection hasn’t been
updated in 24 h” or “this CSV lookup just lost 90 % of its rows”.
Pair with |
Dependencies |
None external. Stand-alone usable; integrates with trackme-app only via the Hybrid Trackers wizard. |
FLX templates that pair |
None — lookups monitoring is implemented as a dedicated
hybrid-tracker search mode rather than via FLX templates. Note:
|
See also |
QUICK START - Design and automate through lookup knowledge, Lookup monitoring. |
Bidirectional incident orchestration¶
TA-trackme-xsoar¶
Purpose |
Cortex XSOAR (Palo Alto) REST-API integration with a built-in resilient retry store for incident-creation calls. |
Splunk surfaces |
Custom commands |
Storage |
Two KV collections (replicate-false): |
TrackMe use cases unlocked |
Bidirectional bridge between TrackMe stateful alerts and Cortex
XSOAR incidents — the README documents the exact wiring as
active commands in TrackMe stateful alerts:
|
Dependencies |
Cortex XSOAR API key + key ID; network reachability to XSOAR. No external trackme-app dependency at install time (FIPS- compatible, standalone or SHC), but is purpose-built for TrackMe stateful-alert integration. |
FLX templates that pair |
None. The |
See also |
trackme-app-on-soar (Splunk SOAR connector)¶
Purpose |
A Splunk SOAR (Phantom) app, not a Splunk TA — runs inside SOAR and exposes TrackMe REST endpoints as SOAR actions so playbooks can drive TrackMe entities. |
SOAR surfaces (actions) |
|
TrackMe use cases unlocked |
SOAR-driven, playbook-orchestrated TrackMe operations: auto-ACK an entity from a SOAR playbook when an upstream maintenance ticket opens; un-ACK when it closes; trigger Smart Status investigation from SOAR after correlating with another SIEM signal; bulk priority / lag policy / hours-ranges adjustments driven by an external CMDB; on-demand ML model retraining / model exclusion windows around known noisy periods (deployments, batch jobs); enable / disable global maintenance from a SOAR incident-response playbook before scheduled changes; logical-group membership management from SOAR (group entities by app / service when the inventory changes upstream). |
Dependencies |
Splunk SOAR (Phantom) 6.0.2+. Splunk bearer token with TrackMe RBAC. Network reachability to Splunkd HTTPS. Requires trackme-app on the Splunk side. |
FLX templates that pair |
None — this is a SOAR-side connector, not a Splunk add-on. The
|
See also |
Operational resilience¶
TA-trackme-conf-manager¶
Purpose |
Resilient transactional layer for replaying failed configuration changes against the TrackMe REST API — accepts a config transaction, persists it, and re-attempts on a schedule until it lands. |
Splunk surfaces |
Custom search command |
Storage |
KV collection |
TrackMe use cases unlocked |
Idempotent / retryable orchestration of TrackMe REST calls — useful for SOAR playbooks, infra-as-code (Ansible / Terraform- style) deployments, and CI pipelines that bulk-configure tenants, entities, policies, ACKs, maintenance windows, etc. Submit a transaction once, the TA keeps trying until it succeeds. |
Dependencies |
Requires trackme-app (it wraps TrackMe REST calls). No external system. |
FLX templates that pair |
None — pure orchestration, not a data source. |
At-a-glance dependency map¶
Quick reference: who needs whom.
Add-on |
Needs trackme-app? |
External system needed |
|---|---|---|
|
No (works standalone, but TrackMe use cases require it) |
Cribl Stream or Cribl Edge with API access |
|
Yes — hard licensing dependency |
GCP Chronicle SecOps with service account |
|
No (integrates via Hybrid Trackers wizard) |
None |
|
No (FIPS-compatible, standalone) |
Cortex XSOAR with API key |
|
Yes — wraps TrackMe REST |
None |
|
Yes — calls TrackMe REST |
Splunk SOAR (Phantom) 6.0.2+ |