Skip to content

1.0.0-Beta6

Pre-release
Pre-release
Compare
Choose a tag to compare
@andreasohlund andreasohlund released this 30 Jan 19:57
1.0.0-Beta6
fe0a54c

Introduction

ServiceControl is an auditing and monitoring service for NServiceBus endpoints and applications.

It gathers the audited messages forwarded by NServiceBus endpoints to the configured Audit queue and it exposes HTTP API that provides data and functionality services for ServiceInsight and ServicePulse

Prerequisites

  • .NET Framework 4.5 or later
    • (Note that this is a change from previous beta releases of ServiceControl which depended on .NET 4.0)

Important Note for previous Beta users of ServiceControl:

  • If you installed a previous beta release of ServiceControl (beta 3 or earlier) you will need to remove the embedded RavenDB database by running the following commands:
net stop "Particular ServiceControl"
RD C:\programdata\particular\ServiceControl\localhost-33333 /S
net start "Particular ServiceControl"
  • (Note the above command assumes you have installed ServiceControl using the default port 33333)
    • Once started, the ServiceControl will re-create a new RavenDB embedded database

Installation

  1. Run the ServiceControl installer and leave the default parameters as-is
    • ServiceControlPort: 33333
      • This is the default IP port ServiceControl will use to expose its HTTP API
    • Transport Type: MSMQ
      • Currently, only MSMQ is available for automatic installation and configuration, although ServiceControl does support all NServiceBus supported transports
      • For guidance on configuring ServiceControl to use transports other than MSMQ, please contact us
    • Instance Name: {free text}
    • Instance Description: {free text}
  2. If you change the default ServiceControl port, please make a note of the custom port you define, since this will be required for connecting ServiceInsight and ServicePulse to the installed instance of ServiceControl
  3. After accepting the license terms and conditions, click "Install" (installer will require elevated privileges)
  4. The installation process performs the following actions:
    1. Installs the Windows Service "Particular ServiceControl"
    2. Expose HTTP API for use by ServiceInsight and ServicePulse (default URI: http://localhost:33333/api)

Troubleshooting:

  1. Port 33333 is already in use by another service
    1. This is most probably due to a previous install of ServiceControl beta (previously known as "Management API".
    2. Uninstall previous ServiceControl beta versions by following this process:
      • In the Windows Computer Management > Services check for the existence of a service named "Particular.Management"
      • If there is a service called "Particular.Management" uninstall previous versions of ServiceInsight beta (can be located and uninstalled in Control Panel > Programs as "Particular Software ServiceInsight"
      • If a version of NServiceBus 4.0 or later is already installed, Open its installer modification settings (in Control Panel > Programs select "Change" for the "Particular Software NServiceBus)
      • In the NServiceBus installer click "Modify"
      • Uncheck "Management API" in the list of components to be installed with NServiceBus
      • Click "Modify" to apply changed and re-run installation
  2. Unable to connect to ServiceControl from either ServiceInsight or ServicePulse
    1. In Computer Management > Services, check that the Windows Service "Particular ServiceControl" is running
    2. In any browser or HTTP client, enter a GET request for the ServiceControl HTTP API (default URI: http://localhost:33333/api.
      • You should get a valid response with JSON data containing ServiceControl default settings.
    3. Verify that firewall settings do not block access to the ServiceControl port (default: 33333) and that the default URI is accessible and responsive from a browser / HTTP client from the machine on which ServicePulse or ServiceInsight is trying to connect to ServiceControl
  3. Particular.ServiceControl windows service fails to start
    • There are various options that may cause this. To narrow down the possible causes, review the ServiceControl log file located in: C:\Windows\system32\config\systemprofile\AppData\Roaming\Particular\ServiceControl\logs
    • Most common cause is prerequisites installation and configuration issues (see above, in "Prerequisites" section)
    • Another common cause for the service failing to start is a permissions issue when ServiceControl attempts to access the Audit / Error or ServiceControl.* queues.
      • This may occur when one or more these queues was created manually, without setting the permissions in a way that allows ServiceControl to access these queues.
      • This issue will be indicated in the ServiceControl log
      • Deleting the queues and running the ServiceControl installer will resolve this issue
Assets 3
Loading