Skip to content

victorops: use Splunk On-Call branding - #5402

Open
gnanirahulnutakki wants to merge 2 commits into
prometheus:mainfrom
gnanirahulnutakki:gnanirahulnutakki/issue-3539-splunk-on-call
Open

victorops: use Splunk On-Call branding#5402
gnanirahulnutakki wants to merge 2 commits into
prometheus:mainfrom
gnanirahulnutakki:gnanirahulnutakki/issue-3539-splunk-on-call

Conversation

@gnanirahulnutakki

@gnanirahulnutakki gnanirahulnutakki commented Jul 24, 2026

Copy link
Copy Markdown

Summary

  • update user-facing VictorOps branding to the current Splunk On-Call name
  • replace retired VictorOps documentation links with current official Splunk references
  • preserve all existing victorops_* configuration fields, notifier identifiers, metric labels, templates, package paths, and endpoint defaults

Validation

Validated commit 7c54cbc43cc980e6e1d37ac5cc9412e7e654cc33 on top of upstream main at 5082b06771da0d272e74b9222db61ddfe28d15f3:

  • make build with native Go 1.26.0 on darwin/arm64
  • make style check_license yamllint in quay.io/prometheus/golang-builder:1.27-base (linux/amd64)
  • golangci-lint v2.13.1 run --timeout=15m ./... in the same builder: 0 issues
  • go test -race ./config ./notify/victorops -count=1 with native Go 1.26.0 and in the Go 1.27 builder
  • all replacement links to official Splunk documentation returned HTTP 200

An additional local go test -race ./... -count=1 run passed the changed packages but hit timing-sensitive failures in untouched dispatch and acceptance-test code. A detached clean-upstream negative control reproduced dispatch/TestAggrGroup with the same assertion 3/20 times (branch: 1/20); hosted CI remains the authoritative full-suite result.

Rebase review note: the automated old-head-to-new-head walkthrough attributes intervening upstream configuration refactors to this pull request. GitHub's current main...head comparison is one commit ahead, zero behind, and limited to the eight files above (28 additions, 21 deletions); the current Go diff adds or removes no exported declarations.

Pull Request Checklist

Please check all the applicable boxes.

  • Please list all open issue(s) discussed with maintainers related to this change
  • Is this a new Receiver integration?
  • Is this a bugfix?
    • I have added tests that can reproduce the bug which pass with this bugfix applied
  • Is this a new feature?
    • I have added tests that test the new feature's functionality
  • Does this change affect performance?
    • I have provided benchmarks comparison that shows performance is improved or is not degraded
      • You can use benchstat to compare benchmarks
    • I have added new benchmarks if required or requested by maintainers
  • Is this a breaking change?
    • My changes do not break the existing cluster messages
    • My changes do not break the existing api
  • I have added/updated the required documentation
  • I have signed-off my commits
  • I will follow best practices for contributing to this project

Which user-facing changes does this PR introduce?

[ENHANCEMENT] victorops: Use Splunk On-Call branding in user-facing documentation and errors while preserving existing configuration names.

@gnanirahulnutakki
gnanirahulnutakki requested a review from a team as a code owner July 24, 2026 02:49
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: d5be7139-2deb-4bc8-88e9-5547fff36a0b

📥 Commits

Reviewing files that changed from the base of the PR and between 7c54cbc and 8a859d7.

📒 Files selected for processing (2)
  • config/notifiers.go
  • docs/configuration.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/configuration.md
  • config/notifiers.go

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The change updates VictorOps-facing documentation and notifier comments to Splunk On-Call terminology. It retains existing VictorOps configuration names and identifiers, restores VictorOps validation error wording, and updates external API links.

Changes

Splunk On-Call terminology and compatibility

Layer / File(s) Summary
Configuration compatibility and validation
config/notifiers.go
Configuration comments now identify Splunk On-Call. VictorOpsConfig remains documented as a legacy compatibility name. Validation conditions are unchanged, and error messages use VictorOps wording.
Splunk On-Call documentation and notifier comments
docs/configuration.md, docs/integrations.md, notify/victorops/victorops.go
Documentation, API links, and notifier comments use Splunk On-Call terminology. Existing victorops_* names and identifiers remain documented for compatibility.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 8a859

This PR updates VictorOps user-facing branding and documentation links while preserving existing configuration names and behavior; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The documentation and comments update VictorOps branding to Splunk On-Call and preserve compatibility identifiers, which addresses issue #3539. However, the missing-routing-key and reserved custom-fie… Update the remaining user-facing validation error messages to Splunk On-Call wording, or document and justify their intentional retention as compatibility-sensitive behavior. Align the PR description and release notes with the final behavio…
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the VictorOps area and the primary change to Splunk On-Call branding.
Description check ✅ Passed The description includes the change summary, linked issue, validation details, checklist status, compatibility notes, and release notes. It is sufficiently complete for review.
Out of Scope Changes check ✅ Passed The changes are limited to notifier comments, configuration documentation, integration documentation, endpoint references, and compatibility-preserving terminology updates. No unrelated changes are ev…
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (1 skipped: 1 …
Full details: Linked Issues check

Explanation

The documentation and comments update VictorOps branding to Splunk On-Call and preserve compatibility identifiers, which addresses issue #3539. However, the missing-routing-key and reserved custom-field validation errors still use VictorOps wording, so the notifier is not fully updated to the new product name.

Resolution

Update the remaining user-facing validation error messages to Splunk On-Call wording, or document and justify their intentional retention as compatibility-sensitive behavior. Align the PR description and release notes with the final behavior. [#3539]

Full details: Out of Scope Changes check

Explanation

The changes are limited to notifier comments, configuration documentation, integration documentation, endpoint references, and compatibility-preserving terminology updates. No unrelated changes are evident.

Full details: Docstring Coverage

Explanation

Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Update user-facing documentation, source comments, and validation errors to use the current product name while preserving the existing VictorOps configuration and telemetry surface.

Signed-off-by: Gnani Rahul Nutakki <gnani.nutakki@gmail.com>
@gnanirahulnutakki
gnanirahulnutakki force-pushed the gnanirahulnutakki/issue-3539-splunk-on-call branch from ecd5483 to 7c54cbc Compare August 24, 2026 17:42
Comment thread config/config.go
Comment thread config/config_test.go
Comment thread docs/configuration.md
Comment thread docs/integrations.md
| [Slack](https://slack.com/) | [slack_config](configuration.md#slack_config) | [Incoming Webhooks](https://api.slack.com/messaging/webhooks) / [Bot Tokens](https://api.slack.com/authentication/token-types) | [Slack API](https://api.slack.com/methods/chat.postMessage) |
| [Telegram](https://telegram.org/) | [telegram_config](configuration.md#telegram_config) | [Telegram Bots](https://core.telegram.org/bots) | [Telegram Bot API](https://core.telegram.org/bots/api) |
| [VictorOps](https://victorops.com/) | [victorops_config](configuration.md#victorops_config) | [REST Endpoint Integration Guide](https://help.victorops.com/knowledge-base/rest-endpoint-integration-guide/) | [VictorOps REST API](https://help.victorops.com/knowledge-base/rest-endpoint-integration-guide/) |
| [Splunk On-Call](https://help.splunk.com/en/splunk-enterprise/alert-and-respond/splunk-on-call/introduction-to-splunk-on-call/getting-started-guide-for-splunk-on-call-admins) (formerly VictorOps) | [victorops_config](configuration.md#victorops_config) | [REST Endpoint Integration Guide](https://help.splunk.com/en/splunk-enterprise/alert-and-respond/splunk-on-call/integrations-with-splunk-on-call/rest-endpoint-integration-for-splunk-on-call) | [REST Endpoint Reference](https://help.splunk.com/en/splunk-enterprise/alert-and-respond/splunk-on-call/integrations-with-splunk-on-call/rest-endpoint-integration-for-splunk-on-call) |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where are these links coming from, is that really that best resource?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are the current official help.splunk.com pages for the Splunk On-Call getting-started guide and REST endpoint integration. I also rechecked both links directly today; each returns HTTP 200. The integration guide is the closest current official replacement for the retired VictorOps guide.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, but the links are identical, aren't they? I don't really think it makes sense to list the same link under the same header.

Also, the victorops.com site forwards to a different website, and not the help article. What was the rational behind that change?

If you want to change the urls, you have to read the content and compare them, not just the status code.

Comment thread CHANGELOG.md Outdated
Signed-off-by: Gnani Rahul Nutakki <gnani.nutakki@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename VictorOps to Splunk OnCall

3 participants