Skip to content
signalfxPublic

About

Observability Studio

Resources

Contributing

Stars

58 stars

Watchers

0 watching

Forks

Latest commit

 

History

202 Commits

Folders and files

Repository files navigation

Splunk Observability Studio

Splunk Observability Studio is a local OpenTelemetry workspace for developers. It receives traces, metrics, and logs; provides a browser UI, REST API, and MCP server; and ships agent skills for auditing, instrumenting, verifying, and operationalizing telemetry.

Quick start

For an editor-integrated Splunk Observability Studio, install the extension and follow the extension guide. To use the CLI instead, download and extract the archive for your platform from Releases, then run:

cd obstudio_<version>_<os>_<arch>
./obstudio install --target=codex

Restart Codex after installation. If Splunk Observability Studio is not already running, its MCP configuration starts it; otherwise setup reuses the detected instance. See the user guide for other agents, shared setup, and configuration options. To build from source instead, run make run; see CONTRIBUTING.md for prerequisites, UI development, testing, and release workflows.

Using the skills

Choose the skill that matches your task. Each skill links to its documentation:

Goal Start with
Review a service and identify telemetry gaps $otel-audit
Implement selected telemetry improvements $otel-instrument
Recheck existing instrumentation $otel-verify
Generate detectors and dashboards $splunk-configure
Generate dashboards only $splunk-dashboard
Publish confirmed detector or dashboard gaps $splunk-detector-publish or $splunk-dashboard-publish
Connect an existing Splunk organization $connect-splunk-observability-cloud
Request a Free Edition organization $create-splunk-free-account

See the user guide for the complete workflow and example prompts for common tasks.

Splunk Observability Studio

Send OTLP data to 127.0.0.1:4317 or http://127.0.0.1:4318, then open http://127.0.0.1:3000. Splunk Observability Studio provides focused views for services, traces, metrics, logs, semantic-convention validation, dashboard previews, and optional Splunk Observability Cloud export. See the Splunk Observability Studio guide for runtime configuration, APIs, routing, retention, and troubleshooting.

Token telemetry supports Codex and Claude Code only and is configured through the standalone obstudio CLI. See the token-usage guide for setup, routing, repository correlation, and troubleshooting.

Repository map

Path Contents
observer/ Go collector, OTLP receivers, REST and MCP APIs, and React UI.
extension/ VS Code-compatible extension and marketplace documentation.
skills/ Canonical agent skill sources.
.agents/skills/ Repo-local Codex discovery links.
evals/ Fixture services and skill eval cases.
pytest-codex-evals/ Reusable pytest plugin for the eval harness.
eval-reports/ Latest summarized eval results.
docs/ User, design, and workflow documentation.

See evals/README.md for skill evaluation.

Security and privacy

See the plugin security and privacy documentation for details about data handling and external connections.

License

Apache License 2.0. See LICENSE.

About

Observability Studio

Resources

Contributing

Stars

58 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages