Skip to content

Releases: Particular/ServiceInsight

1.0.0

16 Apr 06:47
@andreasohlund andreasohlund
1.0.0
5597cad
Compare
Choose a tag to compare
1.0.0

Introduction

ServiceInsight provides debugging and analysis capabilities for your NServiceBus system.

I provides under-the-hood view of the your system's behaviour, clearly displayed and visualized, immediately available and up-to-date.

ServiceInsight features are valuable in development, testing and production environments

http://docs.particular.net/ServiceInsight/getting-started-overview

Prerequisites

  • Microsoft .NET Framework 4.5
  • ServiceControl
    • ServiceInsight connects to and relies on ServiceControl' audit database for its information and functionality
    • See ServiceControl releases for guidance on installation and configuration.
    • ServiceControl can be installed on the local machine or on a remote machine that is accessible (via HTTP) to ServiceInsight

Optional components

  • ServiceMatrix
    • ServiceMatrix enables you to generate a fully functional distributed application skeleton in a matter of minutes, dramatically reducing the learning curve, POC effort and time-to-market of distributed systems development with NServiceBus.
    • ServiceInsight integrates with ServiceMatrix during development and debugging, allowing you to quickly visualize the run-time behavior of your designed NServiceBus system, and quickly iterate from design to run-time views of your system.
  • ServicePulse
    • ServicePulse is a production monitoring tool that allows you to monitor and detect any issues with your NServiceBus endpoints and messages.
    • ServiceInsight integrates with ServicePulse, allowing you to access detailed failure information and context visualizations
    • See ServicePulse release notes for guidance on installation and configuration.

Installation

  1. Run the ServiceInsight installer
  2. By default, the installer will add desktop and programs shortcuts to ServiceInsight

Connecting to ServiceControl

  1. Following the installation, when first launching ServiceInsight, it will try to connect to a local ServiceControl instance (http://localhost:33333/api/)
  2. If there is no ServiceControl instance running on the local machine, you can use the ServiceInsight user interface to connect to any accessible ServiceControl URI, by clicking on the menu "Tools" > "Connect to ServiceControl" or clicking the "Connect" toolbar button
  3. The ServiceControl URI is comprised of the ServiceControl hostname and IP port. By default it is set to localhost with the default port 33333 (http://localhost:33333/api/). Both are configurable.

Troubleshooting:

  1. Unable to connect to ServiceControl URI
    • See ServiceControl Release Notes troubleshooting section
    • ServiceInsight connects to ServiceControl through HTTP
    • You can view the connection and requests logs in the "Logs" tab (at the bottom of the ServiceInsight screen).
      • The "Logs" window details every request made to ServiceControl, including its request parameters, headers and response headers (the request info detailed in the "Logs" window can be re-run through any HTTP / REST client application)
    • Make sure the ServiceControl URI is accessible from the calling machine, using a standard HTTP / REST client
    • Make sure that ServiceInsight is allowed (by firewall / security settings) to make HTTP requests to the ServiceControl URI
  2. ServiceInsight UI display is not responding
    • This may be due to changes in layout engine from beta preview versions of ServiceInsight
    • To resolve this issue, delete the layout settings file:
      1. Close ServiceInsight
      2. Navigate to C:\Users\{current-user}\AppData\Roaming\IsolatedStorage
      3. Inside the IsolatedStorage directory structure, locate the file ShellLayout.settings
      4. Delete ShellLayout.settings
      5. Start ServiceInsight (this will re-create ShellLayout.settings)

Logging

http://docs.particular.net/ServiceInsight/how-logging-works

Assets 3
Loading

1.0.0-Beta7

06 Apr 21:17
@indualagarsamy indualagarsamy
1.0.0-Beta7
ea6ac9f
Compare
Choose a tag to compare
1.0.0-Beta7 Pre-release
Pre-release

Introduction

ServiceInsight provides debugging and analysis capabilities for your NServiceBus system.

I provides under-the-hood view of the your system's behaviour, clearly displayed and visualized, immediately available and up-to-date.

ServiceInsight features are valuable in development, testing and production environments

http://docs.particular.net/ServiceInsight/getting-started-overview

Prerequisites

  • Microsoft .NET Framework 4.5
  • ServiceControl
    • ServiceInsight connects to and relies on ServiceControl' audit database for its information and functionality
    • See ServiceControl release notes for guidance on installation and configuration.
    • ServiceControl can be installed on the local machine or on a remote machine that is accessible (via HTTP) to ServiceInsight

Optional components

  • ServiceMatrix
    • ServiceMatrix enables you to generate a fully functional distributed application skeleton in a matter of minutes, dramatically reducing the learning curve, POC effort and time-to-market of distributed systems development with NServicebus.
    • ServiceInsight integrates with ServiceMatrix during development and debugging, allowing you to quickly visualize the run-time behavior of your designed NServiceBus system, and quickly iterate from design to run-time views of your system.
  • ServicePulse
    • ServicePulse is a production monitoring tool that allows you to monitor and detect any issues with your NServiceBus endpoints and messages.
    • ServiceInsight integrates with ServicePulse, allowing you to access detailed failure information and context visualizations
    • See ServicePulse release notes for guidance on installation and configuration.

Installation

  1. Run the ServiceInsight installer
  2. By default, the installer will add desktop and programs shortcuts to ServiceInsight

Connecting to ServiceControl

  1. Following the installation, when first launching ServiceInsight, it will try to connect to a local ServiceControl instance (http://localhost:33333/api/)
  2. If there is no ServiceControl instance running on the local machine, you can use the ServiceInsight user interface to connect to any accessible ServiceControl URI, by clicking on the menu "Tools" > "Connect to ServiceControl" or clicking the "Connect" toolbat button
  3. The ServiceControl URI is comprised of the ServiceControl hostname and IP port. By default it is set to localhost with the default port 33333 (http://localhost:33333/api/). Both are configurable.

Troubleshooting:

  1. Unable to connect to ServiceControl URI
    • See ServiceControl Release Notes troubleshooting section
    • ServiceInsight connects to ServiceControl through standard HTTP calls
    • You can view the connection and requests logs in the "Logs" tab (at the bottom of the ServiceInsight screen).
      • The "Logs" window details every request made to ServiceControl, including its request parameters, headers and response headers (the request info detailed in the "Logs" window can be re-run through any HTTP / REST client application)
    • Make sure the ServiceControl URI is accessible from the calling machine, using a standard HTTP / REST client
    • Make sure that ServiceInsight is allowed (by firewall / security settings) to make HTTP requests to the ServiceControl URI
  2. ServiceInsight UI display is not responding
    • This may be due to changes in layout engine from previous beta preview versions of ServiceInsight
    • To resolve this issue, delete the layout settings file:
      1. Close ServiceInsight
      2. Navigate to C:\Users{current-user}\AppData\Roaming\IsolatedStorage
      3. Inside the IsolatedStorage directory structure, locate the file ShellLayout.settings
      4. Delete ShellLayout.settings
      5. Start ServiceInsight (this will re-create ShellLayout.settings)

Logging

http://docs.particular.net/ServiceInsight/how-logging-works

Assets 3
Loading

1.0.0-Beta6

25 Mar 07:28
@andreasohlund andreasohlund
1.0.0-Beta6
4bea7a6
Compare
Choose a tag to compare
1.0.0-Beta6 Pre-release
Pre-release

Introduction

ServiceInsight provides debugging and analysis capabilities for your NServiceBus system.

I provides under-the-hood view of the your system's behaviour, clearly displayed and visualized, immediately available and up-to-date.

ServiceInsight features are valuable in development, testing and production environments

http://docs.particular.net/ServiceInsight/getting-started-overview

Prerequisites

  • Microsoft .NET Framework 4.5
  • ServiceControl
    • ServiceInsight connects to and relies on ServiceControl' audit database for its information and functionality
    • See ServiceControl release notes for guidance on installation and configuration.
    • ServiceControl can be installed on the local machine or on a remote machine that is accessible (via HTTP) to ServiceInsight

Optional components

  • ServiceMatrix
    • ServiceMatrix enables you to generate a fully functional distributed application skeleton in a matter of minutes, dramatically reducing the learning curve, POC effort and time-to-market of distributed systems development with NServicebus.
    • ServiceInsight integrates with ServiceMatrix during development and debugging, allowing you to quickly visualize the run-time behavior of your designed NServiceBus system, and quickly iterate from design to run-time views of your system.
  • ServicePulse
    • ServicePulse is a production monitoring tool that allows you to monitor and detect any issues with your NServiceBus endpoints and messages.
    • ServiceInsight integrates with ServicePulse, allowing you to access detailed failure information and context visualizations
    • See ServicePulse release notes for guidance on installation and configuration.

Installation

  1. Run the ServiceInsight installer
  2. By default, the installer will add desktop and programs shortcuts to ServiceInsight

Connecting to ServiceControl

  1. Following the installation, when first launching ServiceInsight, it will try to connect to a local ServiceControl instance (http://localhost:33333/api/)
  2. If there is no ServiceControl instance running on the local machine, you can use the ServiceInsight user interface to connect to any accessible ServiceControl URI, by clicking on the menu "Tools" > "Connect to ServiceControl" or clicking the "Connect" toolbat button
  3. The ServiceControl URI is comprised of the ServiceControl hostname and IP port. By default it is set to localhost with the default port 33333 (http://localhost:33333/api/). Both are configurable.

Troubleshooting:

  1. Unable to connect to ServiceControl URI
    • See ServiceControl Release Notes troubleshooting section
    • ServiceInsight connects to ServiceControl through standard HTTP calls
    • You can view the connection and requests logs in the "Logs" tab (at the bottom of the ServiceInsight screen).
      • The "Logs" window details every request made to ServiceControl, including its request parameters, headers and response headers (the request info detailed in the "Logs" window can be re-run through any HTTP / REST client application)
    • Make sure the ServiceControl URI is accessible from the calling machine, using a standard HTTP / REST client
    • Make sure that ServiceInsight is allowed (by firewall / security settings) to make HTTP requests to the ServiceControl URI
  2. ServiceInsight UI display is not responding
    • This may be due to changes in layout engine from previous beta preview versions of ServiceInsight
    • To resolve this issue, delete the layout settings file:
      1. Close ServiceInsight
      2. Navigate to C:\Users{current-user}\AppData\Roaming\IsolatedStorage
      3. Inside the IsolatedStorage directory structure, locate the file ShellLayout.settings
      4. Delete ShellLayout.settings
      5. Start ServiceInsight (this will re-create ShellLayout.settings)

Logging

http://docs.particular.net/ServiceInsight/how-logging-works

Changes from previous Beta releases

Issues fixed

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

Features

#240 Create a Chocolatey package

#74 Support Timeout Requested / Timeout Invoked links

  1. When a timeout is requested, the Saga information displays a title for "Timeout Requested" with the specified timeout timespan (see highlight in image below)
  2. If the timeout has not yet been invoked, the "Timeout Requested" is not a link
  3. If the timeout has been invoked, the "Timeout Requested" is a link to the message resulting from the timeout invocation.
  4. Clicking on the "Timeout Requested" link leads the user to focus on the "Timeout Invoked" message next to the relevant message processed after the timeout period (see highlight in image below)

image

image

#73 Support Endpoint toggling for messages in Saga View

Message Endpoint toggling is applicable for Incoming, Outgoing and Timeout messages.

image

Improvements

#239 Display the message schema in the SagaView

Currently the Saga State Change diagram, displays the incoming messages, the outgoing messages and how each message changes the Saga state.

Enhance the UI such that there is an option available to the user such that:

  • By a one click toggle, the user can choose to view the Saga state changes and the message schema for each message that participates in the saga.
  • The user can turn off this option so that the saga view defaults to not showing the schema for all the messages.

#232 Remove Loading banner when selecting messages

The following banner is displayed every time we select a different message, that actually prevents a user from interacting with the list for that duration:
image

I propose we:

  • Only show that loading when list is being populated
  • Add a new loading to the bottom screen widgets when message is selected (the ones that are actually doing the loading at that stage)

The loading of message details should not lock the list.

#226 Add support for "Archived" status indication

  1. See Particular/ServiceControl#211
  2. We need to add a status icon (to be displayed in the status column of Message list) for "Archived"
  3. "Archived" messages are failed messages that the user chose (through an explicit action in SP) to archive (i.e. remove from failed message list, since they are not longer retry-able, for various reasons). See Particular/ServicePulse#73
  4. "Archived" messages cannot be "retried"

#221 Timeout messages should have a dedicated icon

  1. Timeout messages (like "BuyersRemorseIsOver" in VideoStore) currently have a standard "Command" icons (see image below)
  2. It would be more accurate to provide them with a "timer" icon
  3. Tooltip should be changed to:
    • When hovering above message icon: "Saga Timeout Message"
    • When hovering above the connecting line from the message sending the Timeout message to the timeout message: "Requested Saga Timeout"
  4. Note this applies to all timeout message, also in Saga View (identified by the "IsSagaTimeoutMessage" = True)

image

// CC @sergioc , @HEskandari, @udidahan

#219 Information Icon design and implementation

  1. Need to design and update the information "i" icon
  2. See images below

image

This also applies to the re-design of the Options dialog. see #208

Raised by @HEskandari on #200

#212 Additional keyboard shortcuts for zooming

Zoom In - CTRL = +
Zoom out - CTRL -
Default Zoom (100%) - CTRL 0

[#211 Show Windows Move cursor when mouse pointer is on empty area of diagram canv...

Read more
Assets 3
Loading

1.0.0-Beta5

30 Jan 20:00
@andreasohlund andreasohlund
1.0.0-Beta5
cd08364
Compare
Choose a tag to compare
1.0.0-Beta5 Pre-release
Pre-release

Introduction

ServiceInsight provides debugging and analysis capabilities for your NServiceBus system.

I provides under-the-hood view of the your system's behavior, clearly displayed and visualized, immediately available and up-to-date.

ServiceInsight features are valuable in development, testing and production environments:

Prerequisites

  • Microsoft .NET Framework 4.5
  • ServiceControl
    • ServiceInsight connects to and relies on ServiceControl' audit database for its information and functionality
    • See ServiceControl release notes for guidance on installation and configuration.
    • ServiceControl can be installed on the local machine or on a remote machine that is accessible (via HTTP) to ServiceInsight

Optional components

  • ServiceMatrix
    • ServiceMatrix enables you to generate a fully functional distributed application skeleton in a matter of minutes, dramatically reducing the learning curve, POC effort and time-to-market of distributed systems development with NServicebus.
    • ServiceInsight integrates with ServiceMatrix during development and debugging, allowing you to quickly visualize the run-time behavior of your designed NServiceBus system, and quickly iterate from design to run-time views of your system.
  • ServicePulse
    • ServicePulse is a production monitoring tool that allows you to monitor and detect any issues with your NServiceBus endpoints and messages.
    • ServiceInsight integrates with ServicePulse, allowing you to access detailed failure information and context visualizations
    • See ServicePulse release notes for guidance on installation and configuration.

Installation

  1. Run the ServiceInsight installer
  2. By default, the installer will add desktop and programs shortcuts to ServiceInsight

Connecting to ServiceControl

  1. Following the installation, when first launching ServiceInsight, it will try to connect to a local ServiceControl instance (http://localhost:33333/api/)
  2. If there is no ServiceControl instance running on the local machine, you can use the ServiceInsight user interface to connect to any accessible ServiceControl URI, by clicking on the menu "Tools" > "Connect to ServiceControl" or clicking the "Connect" toolbat button
  3. The ServiceControl URI is comprised of the ServiceControl hostname and IP port. By default it is set to localhost with the default port 33333 (http://localhost:33333/api/). Both are configurable.

Troubleshooting:

  1. Unable to connect to ServiceControl URI
    • See ServiceControl Release Notes troubleshooting section
    • ServiceInsight connects to ServiceControl through standard HTTP calls
    • You can view the connection and requests logs in the "Logs" tab (at the bottom of the ServiceInsight screen).
      • The "Logs" window details every request made to ServiceControl, including its request parameters, headers and response headers (the request info detailed in the "Logs" window can be re-run through any HTTP / REST client application)
    • Make sure the ServiceControl URI is accessible from the calling machine, using a standard HTTP / REST client
    • Make sure that ServiceInsight is allowed (by firewall / security settings) to make HTTP requests to the ServiceControl URI
  2. ServiceInsight UI display is not responding
    • This may be due to changes in layout engine from previous beta preview versions of ServiceInsight
    • To resolve this issue, delete the layout settings file:
      1. Close ServiceInsight
      2. Navigate to C:\Users{current-user}\AppData\Roaming\IsolatedStorage
      3. Inside the IsolatedStorage directory structure, locate the file ShellLayout.settings
      4. Delete ShellLayout.settings
      5. Start ServiceInsight (this will re-create ShellLayout.settings)
  3. Adding detailed Logging to ServiceInsight
    • ServiceInsight uses Log4Net internally, and adding a Log4Net standard logging configuration file to the ServiceInsight installation directory will create a detailed log of all ServiceInsight activities (based on the Log4Net settings specified). The file name should be log4net.config and be beside the main executable.
    • Sample Log4Net file:
<?xml version="1.0" encoding="utf-8" ?>
<log4net>
<!--
  Uncomment the commented out section below to enable logging to log files.
  You might need to run the application in elevated mode to make the logging work.
-->
  <appender name="LogFileAppender" type="log4net.Appender.FileAppender">
    <file value="Logs\Particular.ServiceInsight.txt"/>

    <appendToFile value="true"/>
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%date - [%-5level] - %logger - %message%newline"/>
    </layout>
  </appender>

  <root>
    <level value="ALL"/>
    <appender-ref ref="LogFileAppender" />
  </root>

</log4net>

Changes from previous Beta releases

Assets 3
Loading