Forge Home


The `nservicebusservicepulse` module installs and manages the NServiceBus Service Pulse on Windows systems.


180 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.3.0 (latest)
  • 0.2.0
  • 0.1.0
released Sep 8th 2023
This version is compatible with:
  • Puppet Enterprise 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 9.0.0

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'tragiccode-nservicebusservicepulse', '0.3.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add tragiccode-nservicebusservicepulse
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install tragiccode-nservicebusservicepulse --version 0.3.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.



tragiccode/nservicebusservicepulse — version 0.3.0 Sep 8th 2023


Puppet Forge Version Puppet Forge Downloads Puppet Forge Pdk Version

Table of Contents

  1. Description
  2. Setup requirements
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Contributing


The nservicebusservicepulse module installs and manages Service Pulse.

ServicePulse is a web application aimed mainly at administrators. It gives a clear, near real-time, high-level overview of how a system is functioning.

Setup Requirements

The nservicebusservicepulse module requires the following:

  • Puppet Agent 4.7.1 or later.
  • Access to the internet.
  • Chocolatey installed.
  • A Running instance of Service Control.
  • Windows Server 2012/2012R2/2016.

Beginning with nservicebusservicepulse

To get started with the nservicebusservicepulse module simply include the following in your manifest:

class { 'nservicebusservicepulse':
  package_ensure      => 'present',
  service_control_url => '',

This example downloads, installs, and configures the latest version of servicepulse and points it to an instance of service control on a remote machine. After running this you should be able to access servicepulse from http://localhost:9090.

NOTE: By default this module pulls the package from chocolatey (


All parameters for the nservicebusservicepulse module are contained within the main nservicebusservicepulse class, so for any function of the module, set the options you want. See the common usages below for examples.

Install a specific version of service pulse from chocolatey

class { 'nservicebusservicepulse':
  package_ensure      => '1.16.0',
  service_control_url => 'http://localhost:33333/api/',

NOTE: We recommend always specifying a specific version so that it's easily viewable and explicit in code. The default value is present which just grabs whatever version happens to be the latest at the time your first puppet run happened with this code

Change Service Pulse Port

The Default port for servicepulse is 9090 but can be customized as shown below if needed.

class { 'nservicebusservicepulse':
  package_ensure => 'present',
  port           => 9091,

Display of Real-time Monitoring

In order to consume real-time monitoring of logical endpoints by displaying various key metrics ( Critical Time, Processing Time, Throughput, Queue Length, etc.. ) simply point servicepulse to the url of your service control monitoring instance.

class { 'nservicebusservicepulse':
  package_ensure      => 'present',
  service_control_url => '',
  monitoring_url      => '',

Enable pending retries view

class { 'nservicebusservicepulse':
  package_ensure     => 'present',
  show_pending_retry => true,

NOTE: Failed messages that are currently in the pending status can be retried, however this feature should be used with care. Retrying pending messages can cause the same message to be processed multiple times. Do not retry a message if it has been processed by the endpoint. In this context "processed" includes both the successful handling of the message and the failure state of it being sent to the error queue




IIS Hosting Currently not implemented

Currently hosting service pulse within IIS is currently not implemented and the only supported configuration is hosting via a Windows Service.

This also means that the ability to have multiple instances of servicepulse on a single machine is also not possible.


  1. Fork it ( )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request