servicepulse message details and menu organisation (#7098)

documentation for feature updates for ServicePulse 2.0.0

Author: PhilBastian

.vscode/settings.json

@@ -6,25 +6,5 @@
       "front_matter_title": ""
     }
   },
-  "dotnet.defaultSolution": "disable",
-  "workbench.colorCustomizations": {
-    "activityBar.activeBackground": "#3399ff",
-    "activityBar.background": "#3399ff",
-    "activityBar.foreground": "#15202b",
-    "activityBar.inactiveForeground": "#15202b99",
-    "activityBarBadge.background": "#bf0060",
-    "activityBarBadge.foreground": "#e7e7e7",
-    "commandCenter.border": "#e7e7e799",
-    "sash.hoverBorder": "#3399ff",
-    "statusBar.background": "#007fff",
-    "statusBar.foreground": "#e7e7e7",
-    "statusBarItem.hoverBackground": "#3399ff",
-    "statusBarItem.remoteBackground": "#007fff",
-    "statusBarItem.remoteForeground": "#e7e7e7",
-    "titleBar.activeBackground": "#007fff",
-    "titleBar.activeForeground": "#e7e7e7",
-    "titleBar.inactiveBackground": "#007fff99",
-    "titleBar.inactiveForeground": "#e7e7e799"
-  },
-  "peacock.color": "#007fff"
+  "dotnet.defaultSolution": "disable"
 }

architecture/observability.md

@@ -29,4 +29,4 @@ Video: [Message processing failed, but what’s the root cause?](https://www.you
 
 ## The Particular Service Platform
 
-The Particular Service Platform offers multiple capabilities that allow one to observe the message flows that are occurring in the system. ServiceInsight has an endpoint explorer view, allowing one to understand all components that are sending and receiving messages in the system. More importantly, ServiceInsight offers multiple views that offer insights into message and [saga flows](/architecture/workflows.md#orchestration-implementing-orchestrated-workflows), based on audit messages. These message-based conversations that are occurring in the systems, are visualized in [flow diagrams](/serviceinsight/#flow-diagram), [sequence diagrams](/serviceinsight/#sequence-diagram), and [saga views](/serviceinsight/#the-saga-view).
+The Particular Service Platform offers multiple capabilities that allow one to observe the message flows that are occurring in the system. ServiceInsight has an endpoint explorer view, allowing one to understand all components that are sending and receiving messages in the system. More importantly, ServiceInsight and ServicePulse have multiple views that offer insights into message and [saga flows](/architecture/workflows.md#orchestration-implementing-orchestrated-workflows), based on audit messages. These message-based conversations that are occurring in the systems, are visualized in [flow diagrams](/servicepulse/message-details.md#messages-with-audited-conversation-data-flow-diagram), [sequence diagrams](/servicepulse/message-details.md#messages-with-audited-conversation-data-sequence-diagram), and [saga views](/servicepulse/message-details.md#messages-with-audited-conversation-data-saga-diagram).

architecture/recoverability.md

@@ -23,7 +23,7 @@ Transient failures are temporary and are not caused by errors in business logic.
 > The Particular Platform simplifies the handling of transient errors:
 >
 > - NServiceBus has [built-in support for immediate and delayed retries](/nservicebus/recoverability/) for all supported messaging technologies. The automated retries behavior is highly customizable.
-> - ServicePulse shows [real-time metrics monitoring retries](/servicepulse/#real-time-monitoring) occuring in the system.
+> - ServicePulse shows [real-time metrics monitoring retries](/servicepulse/#servicepulse-views-monitoring) occurring in the system.
 
 
 ## Persistent errors

menu/menu.yaml

@@ -175,7 +175,6 @@
     - Url: nservicebus/azure
       Title: NServiceBus and Azure
 
-
   - Title: Support Policy
     Articles:
     - Url: nservicebus/upgrades/support-policy
@@ -614,7 +613,7 @@
       - Url: nservicebus/sagas/reply-replytooriginator-differences
         Title: Reply and ReplyToOriginator differences
       - Url: nservicebus/sagas/saga-audit
-        Title: Debugging sagas in ServiceInsight
+        Title: Debugging sagas in ServicePulse
       - Url: nservicebus/sagas/saga-finding
         Title: Complex finding logic
   - Title: Testing
@@ -1381,48 +1380,60 @@
 
 - Name: ServicePulse
   Topics:
-  - Title: Introduction
-    Articles:
-    - Url: servicepulse
-      Title: About ServicePulse
-    - Url: servicepulse/installation
-      Title: Installation
-    - Url: servicepulse/containerization
-      Title: Container deployment
-    - Url: servicepulse/intro-failed-messages
-      Title: Failed Messages
-    - Url: servicepulse/intro-failed-message-retries
-      Title: Retrying Failed Messages
-    - Url: servicepulse/intro-editing-messages
-      Title: Fixing malformed messages
-    - Url: servicepulse/intro-archived-messages
-      Title: Deleted Messages
-    - Url: servicepulse/intro-pending-retries
-      Title: Pending Retries
-    - Url: servicepulse/redirect
-      Title: Redirects
-    - Url: servicepulse/event-types
-      Title: Events
-    - Url: servicepulse/health-check-notifications
-      Title: Health check notifications
-    - Url: servicepulse/endpoint-connection
-      Title: Endpoint connection settings
-    - Url: servicepulse/support-policy
-      Title: Support Policy
-    - Url: servicepulse/usage
-      Title: Measuring system usage
-  - Title: Configuration
-    Articles:
-    - Url: servicepulse/host-config
-      Title: Hosting
-    - Url: servicepulse/how-to-configure-endpoints-for-monitoring
-      Title: Monitoring endpoints
-    - Url: servicepulse/usage-config
-      Title: Usage Setup
-    - Url: servicepulse/install-servicepulse-in-iis
-      Title: Install in IIS
-    - Url: servicepulse/troubleshooting
-      Title: Troubleshooting
+    - Title: Introduction
+      Articles:
+        - Url: servicepulse
+          Title: About ServicePulse
+        - Url: servicepulse/installation
+          Title: Installation
+        - Url: servicepulse/containerization
+          Title: Container deployment
+        - Url: servicepulse/support-policy
+          Title: Support Policy
+    - Title: Configuration
+      Articles:
+        - Url: servicepulse/host-config
+          Title: Hosting
+        - Url: servicepulse/how-to-configure-endpoints-for-monitoring
+          Title: Monitoring endpoints
+        - Url: servicepulse/usage-config
+          Title: Usage Setup
+        - Url: servicepulse/install-servicepulse-in-iis
+          Title: Install in IIS
+        - Url: servicepulse/troubleshooting
+          Title: Troubleshooting
+    - Title: Features
+      Articles:
+        - Url: servicepulse/all-messages
+          Title: All Messages
+        - Url: servicepulse/intro-failed-messages
+          Title: Failed Messages
+        - Url: servicepulse/message-details
+          Title: Message Details
+        - Url: servicepulse/flow-diagram
+          Title: Flow Diagram
+        - Url: servicepulse/sequence-diagram
+          Title: Sequence Diagram
+        - Url: servicepulse/saga-diagram
+          Title: Saga Diagram
+        - Url: servicepulse/intro-failed-message-retries
+          Title: Retrying Failed Messages
+        - Url: servicepulse/intro-editing-messages
+          Title: Fixing malformed messages
+        - Url: servicepulse/intro-archived-messages
+          Title: Deleted Messages
+        - Url: servicepulse/intro-pending-retries
+          Title: Pending Retries
+        - Url: servicepulse/redirect
+          Title: Redirects
+        - Url: servicepulse/event-types
+          Title: Events
+        - Url: servicepulse/health-check-notifications
+          Title: Health check notifications
+        - Url: servicepulse/endpoint-connection
+          Title: Endpoint connection settings
+        - Url: servicepulse/usage
+          Title: Measuring system usage
 
 - Name: ServiceControl
   Topics:

nservicebus/messaging/headers.md

@@ -119,7 +119,7 @@ Messages sent from a [saga](/nservicebus/sagas/) using the `ReplyToOriginator` m
 
 ### NServiceBus.ConversationId
 
-The identifier of the conversation that this message is part of. It enables the tracking of message flows that span more than one message exchange. `ConversationId`, `RelatedTo`, `OriginatingEndpoint`, and `ProcessingEndpoint` fields allow [ServiceInsight](/serviceinsight/#flow-diagram) to reconstruct the entire message flow.
+The identifier of the conversation that this message is part of. It enables the tracking of message flows that span more than one message exchange. `ConversationId`, `RelatedTo`, `OriginatingEndpoint`, and `ProcessingEndpoint` fields allow [ServicePulse](/servicepulse/message-details.md#messages-with-audited-conversation-data-flow-diagram) to reconstruct the entire message flow.
 
 The first message sent in a new flow is automatically assigned a unique `ConversationId` that gets propagated to all the messages that are sent afterward, forming a _conversation_. Each message sent within a conversation has a `RelatedTo` value that identifies the message that caused it to be sent.
 
@@ -333,7 +333,7 @@ The timestamp when the message should be delivered. Used for more accurate calcu
 The endpoint name the message was sent from.
 
 > [!NOTE]
-> Used for linking messages in ServiceInsight. See [NServiceBus.ConversationId](#messaging-interaction-headers-nservicebus-conversationid)
+> Used for linking messages in ServiceInsight and ServicePulse. See [NServiceBus.ConversationId](#messaging-interaction-headers-nservicebus-conversationid)
 
 ### NServiceBus.OriginatingMachine
 
@@ -364,7 +364,7 @@ The timestamp when the processing of a message ended.
 Name of the endpoint where the message was processed.
 
 > [!NOTE]
-> Used for linking messages in ServiceInsight. See [NServiceBus.ConversationId](#messaging-interaction-headers-nservicebus-conversationid)
+> Used for linking messages in ServiceInsight and ServicePulse. See [NServiceBus.ConversationId](#messaging-interaction-headers-nservicebus-conversationid)
 
 ### NServiceBus.ProcessingMachine
 

nservicebus/messaging/third-party-integration.md

@@ -19,7 +19,7 @@ The [RabbitMQ](/samples/rabbitmq/native-integration/), [SQL](/samples/sqltranspo
 
 ## Visualization
 
-To visualize messages from third-party systems correctly within ServiceInsight, additional headers are necessary
+To visualize messages from third-party systems correctly within ServicePulse, additional headers are necessary.
 
 - [`NServiceBus.ConversationId`](/nservicebus/messaging/headers.md#messaging-interaction-headers-nservicebus-conversationid) - used to show related messages in the Flow Diagram and Sequence Diagram. If this header is not provided, the message won't be included in the conversation it started, but a `ConversationId` will be generated for subsequent messages sent using NServiceBus.
 - [`NServiceBus.OriginatingEndpoint`](/nservicebus/messaging/headers.md#diagnostic-and-informational-headers-nservicebus-originatingendpoint) - used in all views, to show the logical endpoint that sent the message. This should be the name of the third-party endpoint sending the message. For example, _BizTalk.ProcessOrder_.

nservicebus/recoverability/configure-error-handling.md

@@ -44,7 +44,7 @@ snippet: ErrorHeadersCustomizations
 
 Administrators should monitor the error queue in order to detect when problems occur. The message in the error queue contains relevant information such as the endpoint that initially processed the message and exception details. This allows an administrator to investigate the problem.
 
-Monitoring and handling of failed messages with [ServicePulse](/servicepulse/) provides access to full exception details, including the stack-trace. [ServiceInsight](/serviceinsight/) provides advanced debugging capabilities by offering additional information, such as message flow visualization. Both ServiceInsight and ServicePulse provide message retry functionality, which sends a failed message back to the originating endpoint for reprocessing. For more details on how to retry a message using ServicePulse, see [Introduction to Failed Messages Monitoring in ServicePulse](/servicepulse/intro-failed-messages.md). To retry a message using ServiceInsight, see [Managing Errors and Retries in ServiceInsight](/serviceinsight/managing-errors-and-retries.md).
+Monitoring and handling of failed messages with [ServicePulse](/servicepulse/) provides access to full exception details, including the stack-trace. [ServiceInsight](/serviceinsight/) and ServicePulse offer advanced debugging capabilities, providing additional information like exception details as well as visualizing the flow of messages. They also provide `retry` functionality, which sends a failed message from the error queue back to the originating endpoint for re-processing. For more details on how to retry a message using ServicePulse, see [Introduction to Failed Messages Monitoring in ServicePulse](/servicepulse/intro-failed-messages.md). To retry a message using ServiceInsight, see [Managing Errors and Retries in ServiceInsight](/serviceinsight/managing-errors-and-retries.md).
 
 If ServicePulse and ServiceInsight are not available in the environment, the message retry functionality can be performed using the native management tools appropriate for the selected transport:
 

nservicebus/sagas/saga-audit.md

@@ -14,11 +14,11 @@ redirects:
 > [!WARNING]
 > This plugin will result in an increase in the load placed on ServiceControl and the endpoint it is installed in. Make sure the environment is prepared for the increased load. Consider [scaling out audit processing](/servicecontrol/servicecontrol-instances/remotes.md) if necessary.
 
-The SagaAudit plugin enables the [Saga View feature in ServiceInsight](/serviceinsight/#the-saga-view).
+The SagaAudit plugin enables the Saga View feature in [ServiceInsight](/serviceinsight/#the-saga-view) and [ServicePulse](/servicepulse/message-details.md#messages-with-audited-conversation-data-saga-diagram).
 
 ![SagaAudit View in ServiceInsight](saga-audit-screenshot.png)
 
-It is built specifically to help developers verify saga logic during development. It does this by capturing saga message behavior and changes in saga data/state as the saga is being processed. It then sends this information to a ServiceControl instance set up in the development environment. The information is available in the *Saga* view in ServiceInsight.
+It is built specifically to help developers verify saga logic during development. It does this by capturing saga message behavior and changes in saga data/state as the saga is being processed. It then sends this information to a ServiceControl instance set up in the development environment. The information is available in the *Saga* view in ServiceInsight and ServicePulse.
 
 
 > [!NOTE]

platform/index.md

@@ -15,28 +15,24 @@ The Particular Service Platform consists of [NServiceBus](/nservicebus), [Servic
 
 ![Particular Service Platform architecture](architecture-overview.png)
 
-The details of each component are discussed below. A Particular Service Platform-based system consists of several NServiceBus [endpoints](/nservicebus/endpoints/). Endpoints are logical entities that perform business operations. They communicate with each other using messages (via queues) and forward messages to ServiceControl for auditing. ServiceControl stores this audit trail and provides integration points for ServicePulse and ServiceInsight. ServicePulse provides monitoring and recoverability for production systems. ServiceInsight provides debugging and visualization of how the system works.
+The details of each component are discussed below. A Particular Service Platform-based system consists of several NServiceBus [endpoints](/nservicebus/endpoints/). Endpoints are logical entities that perform business operations. They communicate with each other using messages (via queues) and forward messages to ServiceControl for auditing. ServiceControl stores this audit trail and provides integration points for ServicePulse and ServiceInsight. ServicePulse provides monitoring and recoverability for production systems. ServiceInsight and ServicePulse provide debugging information and visualization of how the system works.
 
 ## [NServiceBus](/nservicebus) - where it all begins
 
 include: nservicebus
 
-
 ## [ServiceControl](/servicecontrol) - data collection
 
 include: servicecontrol
 
+## [ServicePulse](/servicepulse) - debug, retry and monitor
+
+include: servicepulse
 
 ## [ServiceInsight](/serviceinsight) - visualization
 
 include: serviceinsight
 
-
-## [ServicePulse](/servicepulse) - monitoring
-
-include: servicepulse
-
-
 ## Working with the platform
 
 ServiceControl and ServicePulse are server applications. They should be deployed in each environment, for example: test, QA, and production. ServiceInsight is a client application. It should be deployed on a workstation and connected to ServiceControl in the appropriate environment.

platform/nservicebus.include.md

@@ -72,11 +72,11 @@ The NServiceBus message processing and dispatching pipeline is modular and exten
 
 ## Particular Service Platform
 
-NServiceBus is designed to work with the rest of the Particular Service Platform. All messages are instrumented with additional [headers](/nservicebus/messaging/headers.md) detailing key information about the message and how it was processed. As each message is processed, it is forwarded to an [audit queue](/nservicebus/operations/auditing.md), where it is picked up by [ServiceControl](/servicecontrol/). [ServiceInsight](/serviceinsight/) connects to a ServiceControl instance to provide powerful visualizations of a running NServiceBus system, making it easy to understand message flows and timing.
+NServiceBus is designed to work with the rest of the Particular Service Platform. All messages are instrumented with additional [headers](/nservicebus/messaging/headers.md) detailing key information about the message and how it was processed. As each message is processed, it is forwarded to an [audit queue](/nservicebus/operations/auditing.md), where it is picked up by [ServiceControl](/servicecontrol/).
 
 When a message fails to be processed, even after a number of retry strategies have been attempted, NServiceBus will forward the message to an [error queue](/nservicebus/recoverability/configure-error-handling.md) for manual investigation. Messages sent to the error queue are instrumented with headers containing details about the failure including a full exception stack trace. ServiceControl picks up messages from the error queue and makes them available in [ServicePulse](/servicepulse/). Once the root cause of the failure has been found and corrected, all messages caused by the same problem can be retried at once.
 
-Additionally, each endpoint can send [heartbeat](/monitoring/heartbeats/), [health check](/monitoring/custom-checks/), and [performance metrics](/monitoring/metrics/) through the platform for visualization in ServicePulse, making it easy to see which endpoints are offline, which are ready to scale out, and which require manual intervention.
+Additionally, each endpoint can send [heartbeat](/monitoring/heartbeats/), [health check](/monitoring/custom-checks/), and [performance metrics](/monitoring/metrics/) through the platform for visualization in ServicePulse, making it easy to see which endpoints are offline, which are ready to scale out, and which require manual intervention. Message  visualizations available in [ServicePulse](/servicepulse/message-details.md#messages-with-audited-conversation-data) and [ServiceInsight](/serviceinsight/) make it easy to understand message flows and timing of a running NServiceBus system.
 
 The [real-time monitoring demo](https://particular.net/real-time-monitoring) provides the ability to experience the Service Platform in action. The [Platform Sample package](/platform/platform-sample-package.md) provides the ability to demonstrate the Service Platform from within any Visual Studio solution, without the need to install anything.