-
Notifications
You must be signed in to change notification settings - Fork 301
Integrated ServicePulse documentation #8073
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
5784217
Document integrated ServicePulse
mikeminutillo c18e1f6
Fix link
mikeminutillo 6c5dfda
Fix link again
mikeminutillo 0cb2d8e
Fix more links
mikeminutillo 5a732ed
Apply suggestions from code review
mikeminutillo 54ab98c
Note config that is ignored by integrated ServicePulse
mikeminutillo a46c4e7
Fix version number references
mikeminutillo b3f7a0d
Update servicecontrol/security/configuration/cors.md
mikeminutillo 0537bea
Update servicecontrol/servicecontrol-instances/integrated-servicepuls…
mikeminutillo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
47 changes: 47 additions & 0 deletions
47
servicecontrol/servicecontrol-instances/integrated-servicepulse.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| title: Integrated ServicePulse | ||
| summary: A guide to hosting ServicePulse and ServiceControl within the same host process. | ||
| reviewed: 2026-02-16 | ||
| component: ServiceControl | ||
| --- | ||
|
|
||
| Version 6.13 of ServiceControl and above include integrated ServicePulse. Integrated ServicePulse is hosted in the same host process as the ServiceControl Error instance, and is automatically configured to use it. | ||
|
|
||
| Benefits: | ||
| - No need for a standalone ServicePulse installation. Install and manage ServiceControl and ServicePulse in one place. | ||
| - No need to configure ServicePulse with the ServiceControl Error instance url. Integrated ServicePulse is preconfigured to connect to the ServiceControl installation it runs in. | ||
| - No need to upgrade ServicePulse. Each new version of ServiceControl includes the latest ServicePulse. Every time ServiceControl is upgraded, integrated ServicePulse is upgraded as well. | ||
|
|
||
| Drawbacks: | ||
| - Can not use built-in ServicePulse reverse proxy. Enable [security features of ServiceControl](/servicecontrol/security/) to secure access to ServiceControl data. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Might be worth adding something to this page about not having (or needing, really) the built-in reverse proxy if using integrated SP - https://docs.particular.net/servicepulse/containerization/#settings-enable-reverse-proxy |
||
| - Can not use a single ServicePulse instance to control multiple ServiceControl installations. Each ServiceControl Error instance can be configured with a dedicated integrated ServicePulse. | ||
|
|
||
| > [!NOTE] | ||
| > Standalone ServicePulse installations continue to function normally and can be used in conjunction with integrated ServicePulse. | ||
|
|
||
| ## Enable integrated ServicePulse | ||
|
|
||
| Integrated ServicePulse can be [enabled in the ServiceControl Error instance configuration](/servicecontrol/servicecontrol-instances/configuration.md#host-settings-servicecontrolenableintegratedservicepulse). | ||
|
|
||
| When upgrading an existing ServiceControl Error instance via ServiceControl Management, the user is prompted to enable integrated ServicePulse. | ||
|
|
||
|  | ||
|
|
||
| When upgrading an existing ServiceControl Error instance via Powershell or docker, update the configuration manually to enable integrated ServicePulse. | ||
|
|
||
| > [!NOTE] | ||
| > Once integrated ServicePulse is enabled, standalone ServicePulse installations are no longer needed and can be removed. | ||
|
|
||
| ## Configuring integrated ServicePulse | ||
|
|
||
| Integrated ServicePulse shares settings with the ServiceControl Error instance it is hosted by (the hosting instance). | ||
|
|
||
| - All host settings (such as [host name](/servicecontrol/servicecontrol-instances/configuration.md#host-settings-servicecontrolhostname) and [port number](/servicecontrol/servicecontrol-instances/configuration.md#host-settings-servicecontrolport)) are shared with the hosting instance. Integrated ServicePulse is available at the root url (`http://localhost:33333/` in a default installation). | ||
| - Most security settings are shared with the hosting instance. There is no need to enable [header forwarding](/servicepulse/security/configuration/forward-headers.md) for ServicePulse specifically, and [CORS](/servicecontrol/security/configuration/cors.md) is no longer required | ||
| - [ServicePulse specific authorization configuration](/servicecontrol/servicecontrol-instances/configuration.md#authentication-servicecontrolauthentication-servicepulse-clientid) is still required. | ||
| - Integrated ServicePulse is automatically configured to connect to the hosting instance. This configuration is read-only and cannot be changed. | ||
| - Connection to a ServiceControl Monitoring instance can be [configured via the ServicePulse UI](/servicepulse/host-config.md#configuring-connections-via-the-servicepulse-ui). | ||
mikeminutillo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## Upgrade integrated ServicePulse | ||
|
|
||
| There is no need to upgrade integrated ServicePulse separately. Each release of ServiceControl contains the latest version of ServicePulse, and each new release of ServicePulse will trigger a release of ServiceControl. Upgrading the ServiceControl Error instance will upgrade integrated ServicePulse automatically. | ||
Binary file added
BIN
+53.4 KB
servicecontrol/servicecontrol-instances/upgrade-enable-integrated-servicepulse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.