Troubleshoot brokered services

Applies to: Visual Studio 2019 and later versions

This article introduces troubleshooting suggestions and possible solutions for several common problems that may occur when you try to get a brokered service in the Visual Studio SDK.

Brokered services may fail in various ways. A useful technique to start your investigation with is to check the Visual Studio Activity Log, which often logs errors or warnings when things go awry with brokered services.

Issues when requesting a service

Perhaps the most common challenge with brokered services is understanding the result or exception they get from a call to IServiceBroker.GetProxyAsync or IServiceBroker.GetPipeAsync. An IServiceBroker intentionally abstracts away concerns about where and how a brokered service may be activated. But when things go wrong it becomes necessary to drill deeper to diagnose and correct the problem.

No service

The result of a service request may be null when any of the following conditions are true:

• The requested service isn't registered. The brokered service author should register it with ProvideBrokeredServiceAttribute or a hand-authored .pkgdef file.
• The requested service is registered with configuration that doesn't expose the service to this client. The default scope is ServiceAudience.Process, which means the brokered service can only be activated when it's proffered from the same process as the client. If the client is in another process and the intent is for the brokered service to be available to it, change the service registration to expand its ServiceAudience.
• The requested service is registered with ServiceAudience.LiveShareGuest, a Live Share connection exists, but the host doesn't offer that brokered service or the ProvideBrokeredServiceAttribute.AllowTransitiveGuestClients property isn't set to true. When exposing a brokered service over Live Share, please review How to secure a brokered service.
• The requested service is registered but is missing information about which package to initialize so that its factory can be proffered. The ProvideBrokeredServiceAttribute attribute automatically generates registration that indicates the package the attribute was applied to so that Visual Studio can load that package as needed. If the attribute is applied to the wrong package or the .pkgdef file is hand-authored, this information may be missing or inaccurate.
• The Visual Studio package responsible for proffering the brokered service throws during initialization or otherwise fails to actually proffer that service factory. Check the Visual Studio Activity Log for evidence of a package load failure.
• The service factory itself returns null.

The service request throws an exception

A service request may throw a ServiceCompositionException when the service factory throws an exception. This means all the problems listed above that would lead to a null result don't apply. Look at the exception details (including inner exceptions) to understand what went wrong and make any necessary corrections to the client or the service factory.

You get a local service while a remote one was expected

A request may be fulfilled locally or remotely, depending on the service registration and the current state of Visual Studio. The default scope is ServiceAudience.Process, which means the brokered service can only be activated when it's proffered from the same process as the client.

When a brokered service should be exposed from a Live Share host to a connected guest but the ServiceAudience is limited to local scopes, a request from a Live Share guest will activate the brokered service from that same machine rather than the host. Update registration to include ServiceAudience.LiveShareGuest to expose your brokered services over Live Share. You may also need to set ProvideBrokeredServiceAttribute.AllowTransitiveGuestClients to true as well.

Issues when proffering a service

A brokered service must be proffered from an AsyncPackage class unless the brokered service is exported via MEF, as described in How to provide a brokered service.

An attempt to proffer a brokered service will throw an exception if any of these conditions are true:

• The moniker for the service being proffered doesn't exactly match (name and version) a service that has been registered.
• A factory has already been proffered for the same service moniker.

The result of a call to IBrokeredServiceContainer.Proffer is an IDisposable. A brokered service becomes unavailable to new requests after this value is disposed. When your brokered service has specific affinity to some context such as an open solution, it may be appropriate to only proffer the brokered service when that context is active. It isn't necessary to retain and dispose of this value when your package is disposed.

Tracing RPC between client and service

Once a connection between client and service is established, tracing their communication can be useful, particularly when they are in different processes.

By default, traces of communications between brokered services that span processes (such that RPC applies) are recorded in .svclog files found in the %TEMP%\VSLogs directory. These xml files are best viewed with the Service Trace Viewer. This tool can open many .svclog files at once and stitch them together to form a multi-party graph to make understanding the RPC between client and service much easier.

A brokered service itself can trace directly to add to these .svclog trace files, further aiding diagnostics of brokered service behavior. Any traces saved to %TEMP%\VSLogs might be collected when the "Report a Problem" command is invoked and the user elects to share logs.

To trace your own messages such that they can be easily discovered and combined with other .svclog traces, your code (whether a brokered service or not) can do something like this:

// Define your log's ID, a namespace-like fully qualified name.
// In general it is expected that you follow you team's assembly namespace.
// Also an optional parameter, the ServiceMoniker for your service
var myLogId = new LogId("Microsoft.SomeTeam.MyLogName", serviceId: null);

var requestedLevel = new LoggingLevelSettings(SourceLevels.Warning | SourceLevels.ActivityTracing);
var myLogOptions = new LoggerOptions(requestedLevel, PrivacyFlags.MayContainPrivateInformation);

TraceSource myTraceSource;
using (TraceConfiguration traceConfig = await TraceConfiguration.CreateTraceConfigurationInstanceAsync(serviceBroker, ownsServiceBroker: false, cancellationToken))
{
    myTraceSource = await traceConfig.RegisterLogSourceAsync(myLogId, myLogOptions, traceSource: null, cancellationToken);
}

The myTraceSource can now be used for tracing, as it has the appropriate listeners added to write your traces to a .svclog file. If you already have a TraceSource you wish to use, pass it to the RegisterLogSourceAsync method and discard the result as the listeners will be added to your existing TraceSource.

When tracing from a brokered service that serves a remote client, an activity is automatically assigned to the ExecutionContext that your code runs within that allows the svclog to be stitched together with the client's svclog in order to see a holistic view using the Service Trace Viewer.

References

• Using and Providing Brokered Services
• How to: Get a Brokered Service
• How to: Provide a Brokered Service
• Discovering Available Brokered Services