Releases · Particular/ServiceControl

This release patches a localization bug in the installer of v1.2 which prevented installation on Non-English versions of Windows. We've also changed ServiceControl to ensure different log folders and queues are used when running multiple instances on the same computer.

Improvements

#355 Log paths should be different per instance

If a user installs SC multiple times on the same machine with different hostname and/or port, the location for the log paths need to be different per instance.

At the moment is shared.

i would recommend using the same logic as the RavenDB path.

Bugs

#363 Localization error prevents SC 1.2 install on non-english OS

Adv Installler fails to install ServiceControl 1.2 due to localization of group names. This is almost identical to this issue in Particular/ServicePulse#150

#357 Queue names need to be different per instance

If a user installs SC multiple times on the same machine with different hostname and/or port, the queue names need to be different per instance.

At the moment they all share the same name "Particular.ServiceControl", we actually hard coding it, see https://github.com/Particular/ServiceControl/blob/25f51e76b1f9e4369420301b826d32e8d2c93d5b/src/ServiceControl/Bootstrapper.cs#L46

This causes issue because we have separate databases but the same queue.

Content changes

#356 Update installer license text

Where to get it

You can download this release from:

Our website
Or chocolatey

Assets 3

21 Aug 02:40

particularbot

1.2.0

25f51e7

1.2.0

As part of this release we had 5 issues closed.

Improvements

#317 Attempt to re-import previously failed messages

If a audit or error messages fails to be imported we do a few things:

Write to the event viewer
Write a text file to disk with the id of the failed message and the stacktrace
We add the messages to the database:

The last point is what this issue is about.
Currently we have bug in SC that fails to import SendOnly messages and those messages are being added to the database see point 3.

Once we release a fix we need a way to re-import those failed messages.
Content trimmed. See full issue

Bugs

#350 Call to /customchecks?status=fail returns passed custom checks

Calls to /customchecks?status=fail sometimes returns passed items. Appears to only happen just after the state is switched. This causes incorrect data to be displayed in Service Pulse under custom checks

#331 RegisterEndpointHandler assumes single match for Endpoint.Name and Endpoint.Host

So in RegisterEndpointHandler we have

knownEndpoint = session.Query<KnownEndpoint, KnownEndpointIndex>()
.SingleOrDefault(e => 
    e.EndpointDetails.Name == message.Endpoint.Name && 
    e.EndpointDetails.Host == message.Endpoint.Host);

But because multiple endpoints can be deployed to the same host there could be multiple KnownEndpoint with the same Endpoint.Name and EndpointDetails.Host. So the session.Query returns more than 1 and SingleOrDefault blows up

Content trimmed. See full issue

#324 Unable to start ServiceControl as a standard user

When attempting to run ServiceControl under a standard user by passing in install time parameters, the service does not start

Content trimmed. See full issue

Where to get it

You can download this release from:

Our website
Or chocolatey

Assets 3

25 May 01:36

johnsimons

1.1.0

ff91983

1.1.0

As part of this release we had 16 commits which resulted in 2 issues being closed.

Bugs

#326 Unable to get the message body when using Json Serialization for successfully processed messages

#313 SC failed to import failed message from Send-Only endpoint

Assets 3

16 Apr 06:08

andreasohlund

1.0.0

33bb355

1.0.0

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 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

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}
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
After accepting the license terms and conditions, click "Install" (installer will require elevated privileges)
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:

http://docs.particular.net/ServiceControl/troubleshooting

Assets 3

25 Mar 07:27

andreasohlund

1.0.0-Beta7

e18b9cf

1.0.0-Beta7 Pre-release

Pre-release

Introduction

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

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 6 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

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}
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
After accepting the license terms and conditions, click "Install" (installer will require elevated privileges)
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:

http://docs.particular.net/ServiceControl/troubleshooting

Issues fixed in this Beta

This release consist of these issues that were achieved through these commits.

Features

#230 Create a Chocolatey package

Dependency on Perf Counters package Particular/PlatformInstaller#19
Dependency on .net 4.5 http://chocolatey.org/packages/DotNet4.5
Since chocolatey packages are limited in size the large binary component will be stored in github releases
Host an icon online for the package. Particular/PlatformInstaller#27
Generate the version number here as part of a build
Support uninstall
Make Silent
Add logging http://www.advancedinstaller.com/user-guide/qa-log.html

Note this is not dependent on MSMQ or DTC since ServiceControl can target other transports

#229 Facilitate the viewing of the actual message data in Service Insight for the Saga View.

For the saga view feature of ServiceIsnight, ServiceControl needs to be able to provide the message data in addition to the saga state changes. Facilitate any API changes that are needed on SC so that this data can be displayed in SI.

Why?
The benefit of being able to see all of the message data is significant. For example:
From a debugging standpoint a developer that is looking at the SagaView could troubleshoot the saga by being able to see the actual message and its property and the saga states to help determine that the problem was with a certain message that left the saga went out with a wrong data in the message.

#180 Add "Hosting Process" data to Heartbeats

As Opie, I need to be able to uniquely identify the specific endpoint hosting process that sent a heartbeat.
This is especially true when more than one instance of the endpoints is located in the same machine (AKA "side by side") It also applies when the endpoint is hosted in IIS or other custom hosting.

Visualization

In SI, we will be including the "Hosting Process" information in endpoint properties / tooltip info.
In SP, it will be displayed in the Endpoints List (monitored only, since it relies on heartbeats).

Proposed Implementation

As discussed with @andreasohlund
Content trimmed. See full issue

#116 Support expiration of audit messages

Use the expiration bundle to have raven auto expire audit messages.

By default keep messages for 30 days
Add a setting in the SC config so that users can control the default
This overrides any expiry that the user might have set in NServiceBus https://github.com/Particular/NServiceBus/blob/develop/src/NServiceBus.Core/Config/UnicastBusConfig.cs#L80

Note: We're only expiring audit messages, not errors, heartbeats etc

Replaces Particular/ServicePulse#64

#106 Enrich audit messages returned with saga state information

To support data overlay for the message flow in ServiceInsight:

support multiple saga types per message
enrich initiating message with saga id + type (can be multiple sagas)
saga state change(s) caused by message (initiated/updated/complete)

Replaces: Particular/NServiceBus#1659

#105 Expose a http api to get saga state changes

Request:

GET /api/sagas/{saga-id}

Response

{
   "id":"93bfbbfe-f841-4ea5-a0fe-a2a800d8e08d",
   "saga_id":"93bfbbfe-f841-4ea5-a0fe-a2a800d8e08d",
   "saga_type":"MySaga",
   "changes":[
      {
         "start_time":"2014-01-03T12:09:37.5015257Z",
         "finish_time":"2014-01-03T12:09:37.5577757Z",
         "status":"new",
         "state_after_change":"[{\"$type\":\"MySagaData, ServiceControl.Sample\",\"Id\":\"93bfbbfe-f841-4ea5-a0fe-a2a800d8e08d\",\"Originator\":\"ServiceControl.Plugin.SagaAudit.Sample@ANDREAS\",\"OriginalMessageId\":\"124984c0-9742-460d-a6bc-a2a800d8ddd4\",\"SomeId\":\"00000000-0000-0000-0000-000000000000\"}]",
         "initiating_message":{
            "is_saga_timeout_message":false,
            "originating_endpoint":"ServiceControl.Plugin.SagaAudit.Sample",
            "originating_machine":"ANDREAS",
            "time_sent":"2014-01-03T12:09:35.284928Z",
            "message_type":"Message1"
         },
         "outgoing_messages":[
            {
               "destination":"ServiceC...

Assets 3

30 Jan 19:57

andreasohlund

1.0.0-Beta6

fe0a54c

1.0.0-Beta6 Pre-release

Pre-release

Introduction

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

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

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}
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
After accepting the license terms and conditions, click "Install" (installer will require elevated privileges)
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:

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
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
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

26 Nov 05:42

johnsimons

1.0.0-Beta5

09a7751

1.0.0-Beta5 Pre-release

Pre-release

Changes in this release

The only change is to ensure MSMQ is installed correctly on Windows 8.1

Particular/NServiceBus.PowerShell#1

Where to get it

You can download this release from:

Our website

Assets 2

Releases: Particular/ServiceControl

1.2.2

Bugs

Where to get it

Uh oh!

1.2.1

Improvements

Bugs

Content changes

Where to get it

Uh oh!

1.2.0

Improvements

Bugs

Where to get it

Uh oh!

1.1.0

Bugs

Uh oh!

1.0.0

Introduction

Prerequisites

Installation

Troubleshooting:

Uh oh!

1.0.0-Beta7

Introduction

Prerequisites

Installation

Troubleshooting:

Issues fixed in this Beta

Features

Visualization

Proposed Implementation

Request:

Response

Uh oh!

1.0.0-Beta6

Introduction

Prerequisites

Installation

Troubleshooting:

Uh oh!

1.0.0-Beta5

Changes in this release

Where to get it

Uh oh!