Dimensionar o Serviço do SignalR com várias instâncias

Para ASP.NET Core

Adicionar vários pontos de extremidade da configuração

Configure com a chave Azure:SignalR:ConnectionString ou Azure:SignalR:ConnectionString: para a cadeia de conexão do Serviço SignalR.

Se a chave começar com Azure:SignalR:ConnectionString:, ela deverá estar no formato Azure:SignalR:ConnectionString:{Name}:{EndpointType}, onde Name e EndpointType são propriedades do objeto ServiceEndpoint e estão acessíveis a partir do código.

Você pode adicionar várias cadeias de conexão de instância usando os seguintes comandos dotnet:

dotnet user-secrets set Azure:SignalR:ConnectionString:east-region-a <ConnectionString1>
dotnet user-secrets set Azure:SignalR:ConnectionString:east-region-b:primary <ConnectionString2>
dotnet user-secrets set Azure:SignalR:ConnectionString:backup:secondary <ConnectionString3>

Adicionar vários pontos de extremidade do código

Uma classe ServiceEndpoint descreve as propriedades de um ponto de extremidade do Serviço do Azure SignalR. Você pode configurar vários pontos de extremidade de instância usando o SDK do Serviço do Azure SignalR por meio de:

services.AddSignalR()
        .AddAzureSignalR(options =>
        {
            options.Endpoints = new ServiceEndpoint[]
            {
                // Note: this is just a demonstration of how to set options.Endpoints
                // Having ConnectionStrings explicitly set inside the code is not encouraged
                // You can fetch it from a safe place such as Azure KeyVault
                new ServiceEndpoint("<ConnectionString0>"),
                new ServiceEndpoint("<ConnectionString1>", type: EndpointType.Primary, name: "east-region-a"),
                new ServiceEndpoint("<ConnectionString2>", type: EndpointType.Primary, name: "east-region-b"),
                new ServiceEndpoint("<ConnectionString3>", type: EndpointType.Secondary, name: "backup"),
            };
        });

Personalizar o roteador de ponto de extremidade

Por padrão, o SDK usa o DefaultEndpointRouter para escolher os pontos de extremidade.

Comportamento padrão

1. Roteamento de solicitação do cliente:

   Quando o cliente /negotiate com o servidor de aplicativos. Por padrão, o SDK seleciona aleatoriamente um ponto de extremidade do conjunto de pontos de extremidade de serviço disponíveis.

2. Roteamento de mensagens do servidor:

   Ao enviar uma mensagem para uma conexão específica com a conexão de destino roteada para o servidor atual, a mensagem vai diretamente para esse ponto de extremidade conectado. Caso contrário, as mensagens são transmitidas para todos os pontos de extremidade do Azure SignalR.

Personalizar o algoritmo de roteamento

Você pode criar seu próprio roteador se você tem um conhecimento especial para identificar para quais pontos de extremidade as mensagens devem ir.

O exemplo a seguir define um roteador personalizado que roteia mensagens com um grupo começando com east- para o ponto de extremidade chamado east:

private class CustomRouter : EndpointRouterDecorator
{
    public override IEnumerable<ServiceEndpoint> GetEndpointsForGroup(string groupName, IEnumerable<ServiceEndpoint> endpoints)
    {
        // Override the group broadcast behavior, if the group name starts with "east-", only send messages to endpoints inside east
        if (groupName.StartsWith("east-"))
        {
            return endpoints.Where(e => e.Name.StartsWith("east-"));
        }

        return base.GetEndpointsForGroup(groupName, endpoints);
    }
}

O exemplo a seguir substitui o comportamento de negociação padrão e seleciona o ponto de extremidade dependendo do local do servidor de aplicativos.

private class CustomRouter : EndpointRouterDecorator
{    public override ServiceEndpoint GetNegotiateEndpoint(HttpContext context, IEnumerable<ServiceEndpoint> endpoints)
    {
        // Override the negotiate behavior to get the endpoint from query string
        var endpointName = context.Request.Query["endpoint"];
        if (endpointName.Count == 0)
        {
            context.Response.StatusCode = 400;
            var response = Encoding.UTF8.GetBytes("Invalid request");
            context.Response.Body.Write(response, 0, response.Length);
            return null;
        }

        return endpoints.FirstOrDefault(s => s.Name == endpointName && s.Online) // Get the endpoint with name matching the incoming request
               ?? base.GetNegotiateEndpoint(context, endpoints); // Or fallback to the default behavior to randomly select one from primary endpoints, or fallback to secondary when no primary ones are online
    }
}

Não se esqueça de registrar o roteador para o contêiner DI usando:

services.AddSingleton(typeof(IEndpointRouter), typeof(CustomRouter));
services.AddSignalR()
        .AddAzureSignalR(
            options =>
            {
                options.Endpoints = new ServiceEndpoint[]
                {
                    new ServiceEndpoint(name: "east", connectionString: "<connectionString1>"),
                    new ServiceEndpoint(name: "west", connectionString: "<connectionString2>"),
                    new ServiceEndpoint("<connectionString3>")
                };
            });

Para ASP.NET

Adicionar vários pontos de extremidade da configuração

Configuração com chave Azure:SignalR:ConnectionString ou Azure:SignalR:ConnectionString: para a cadeia de conexão do Serviço SignalR.

Se a chave começar com Azure:SignalR:ConnectionString:, ela deverá estar no formato Azure:SignalR:ConnectionString:{Name}:{EndpointType}, em que Name e EndpointType são propriedades do objeto ServiceEndpoint e poderão ser acessadas do código.

Você pode adicionar várias cadeias de conexão de instância a web.config:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <connectionStrings>
    <add name="Azure:SignalR:ConnectionString" connectionString="<ConnectionString1>"/>
    <add name="Azure:SignalR:ConnectionString:en-us" connectionString="<ConnectionString2>"/>
    <add name="Azure:SignalR:ConnectionString:zh-cn:secondary" connectionString="<ConnectionString3>"/>
    <add name="Azure:SignalR:ConnectionString:Backup:secondary" connectionString="<ConnectionString4>"/>
  </connectionStrings>
  ...
</configuration>

Adicionar vários pontos de extremidade do código

Uma classe ServiceEndpoint descreve as propriedades de um ponto de extremidade do Serviço do Azure SignalR. Você pode configurar vários pontos de extremidade de instância usando o SDK do Serviço do Azure SignalR por meio de:

app.MapAzureSignalR(
    this.GetType().FullName,
    options => {
            options.Endpoints = new ServiceEndpoint[]
            {
                // Note: this is just a demonstration of how to set options. Endpoints
                // Having ConnectionStrings explicitly set inside the code is not encouraged.
                // You can fetch it from a safe place such as Azure KeyVault
                new ServiceEndpoint("<ConnectionString1>"),
                new ServiceEndpoint("<ConnectionString2>"),
                new ServiceEndpoint("<ConnectionString3>"),
            }
        });

Personalizar um roteador

A única diferença entre o SignalR do ASP.NET e o SignalR do ASP.NET Core é o tipo de contexto de http para GetNegotiateEndpoint. Para o SignalR do ASP.NET, o tipo é IOwinContext.

O código a seguir é um exemplo de negociação personalizado para SignalR do ASP.NET:

private class CustomRouter : EndpointRouterDecorator
{
    public override ServiceEndpoint GetNegotiateEndpoint(IOwinContext context, IEnumerable<ServiceEndpoint> endpoints)
    {
        // Override the negotiate behavior to get the endpoint from query string
        var endpointName = context.Request.Query["endpoint"];
        if (string.IsNullOrEmpty(endpointName))
        {
            context.Response.StatusCode = 400;
            context.Response.Write("Invalid request.");
            return null;
        }

        return endpoints.FirstOrDefault(s => s.Name == endpointName && s.Online) // Get the endpoint with name matching the incoming request
               ?? base.GetNegotiateEndpoint(context, endpoints); // Or fallback to the default behavior to randomly select one from primary endpoints, or fallback to secondary when no primary ones are online
    }
}

Não se esqueça de registrar o roteador para o contêiner DI usando:

var hub = new HubConfiguration();
var router = new CustomRouter();
hub.Resolver.Register(typeof(IEndpointRouter), () => router);
app.MapAzureSignalR(GetType().FullName, hub, options => {
    options.Endpoints = new ServiceEndpoint[]
                {
                    new ServiceEndpoint(name: "east", connectionString: "<connectionString1>"),
                    new ServiceEndpoint(name: "west", connectionString: "<connectionString2>"),
                    new ServiceEndpoint("<connectionString3>")
                };
});

Métricas do ponto de extremidade de serviço

Para habilitar um roteador avançado, o SDK do Servidor do SignalR fornece várias métricas para ajudar o servidor a tomar decisões inteligentes. As propriedades estão em ServiceEndpoint.EndpointMetrics.

O código a seguir é um exemplo de personalização de um roteador de acordo com ClientConnectionCount.

private class CustomRouter : EndpointRouterDecorator
{
    public override ServiceEndpoint GetNegotiateEndpoint(HttpContext context, IEnumerable<ServiceEndpoint> endpoints)
    {
        return endpoints.OrderBy(x => x.EndpointMetrics.ClientConnectionCount).FirstOrDefault(x => x.Online) // Get the available endpoint with minimal clients load
               ?? base.GetNegotiateEndpoint(context, endpoints); // Or fallback to the default behavior to randomly select one from primary endpoints, or fallback to secondary when no primary ones are online
    }
}

ServiceEndpoints de Escala Dinâmica

Do SDK versão 1.5.0, estamos habilitando primeiro ServiceEndpoints de escala dinâmica para a versão do ASP.NET Core. Portanto, você não precisa reiniciar o servidor de aplicativos quando precisar adicionar/remover um ServiceEndpoint. Como o ASP.NET Core é compatível com uma configuração padrão como appsettings.json com reloadOnChange: true, você não precisa alterar código e ele tem suporte por natureza. E se você quiser adicionar configurações personalizadas e trabalhar com a recarga dinâmica, confira Configuração no ASP.NET Core.

Para extensões do SignalR Functions

Configuração

Para habilitar várias instâncias do Serviço do SignalR, você deve:

1. Use o tipo de transporte Persistent.

   O tipo de transporte padrão é o modo Transient. Você deve adicionar a seguinte entrada ao seu arquivo local.settings.json ou à configuração do aplicativo no Azure.

   {
       "AzureSignalRServiceTransportType":"Persistent"
   }
   

   Observação

   Ao alternar do modo Transient para o modo Persistent, pode haver uma alteração de comportamento de serialização JSON, pois no modo Transient, a biblioteca Newtonsoft.Json é usada para serializar argumentos de métodos de hub, no entanto, no modo Persistent, a biblioteca System.Text.Json é usada como padrão. System.Text.Json tem algumas diferenças chave no comportamento padrão em relação a Newtonsoft.Json. Se você quiser usar Newtonsoft.Json no modo Persistent, você pode adicionar um item de configuração: "Azure:SignalR:HubProtocol":"NewtonsoftJson" no arquivo local.settings.json ou Azure__SignalR__HubProtocol=NewtonsoftJson no portal do Azure.

2. Configure várias entradas de pontos de extremidade do Serviço do SignalR em sua configuração.

   Usamos um objeto ServiceEndpoint para representar uma instância do Serviço do SignalR. Você pode definir um ponto de extremidade de serviço com seus <EndpointName> e <EndpointType> na chave de entrada e a cadeia de conexão no valor da entrada. As chaves estão no seguinte formato:

   Azure:SignalR:Endpoints:<EndpointName>:<EndpointType>
   

   <EndpointType> é opcional e o padrão é primary. Veja os exemplos abaixo:

   {
       "Azure:SignalR:Endpoints:EastUs":"<ConnectionString>",
   
       "Azure:SignalR:Endpoints:EastUs2:Secondary":"<ConnectionString>",
   
       "Azure:SignalR:Endpoints:WestUs:Primary":"<ConnectionString>"
   }
   

   Observação

   • Quando você configurar os pontos de extremidade do Azure SignalR no Serviço de Aplicativo no portal do Azure, não se esqueça de substituir ":" por "__", o sublinhado duplo nas chaves. Por motivos, consulte Variáveis de ambiente.

   • A cadeia de conexão configurada com a chave {ConnectionStringSetting} (o padrão é “AzureSignalRConnectionString”) também é reconhecida como um ponto de extremidade de serviço primário com nome vazio. Mas esse estilo de configuração não é recomendado para vários pontos de extremidade.

Roteamento

Comportamento padrão

Por padrão, a associação de funções usa o DefaultEndpointRouter para pegar os pontos de extremidade.

• Roteamento de cliente: Seleciona aleatoriamente um ponto de extremidade entre os pontos de extremidade primários online. Se todos os pontos de extremidade primários estiverem offline, selecione aleatoriamente um ponto de extremidade secundário online. Se a seleção falhar novamente, será lançada uma exceção.

• Roteamento de mensagens do servidor: Todos os pontos de extremidade de serviço são retornados.

Personalização

Modelo de C# em processo

Aqui estão as etapas para fazer isso:

1. Implemente um roteador personalizado. Você pode aproveitar as informações fornecidas por ServiceEndpoint para tomar decisões de roteamento. Veja o guia aqui: customize-route-algorithm. Observe que o gatilho Http é necessário na função de negociação quando você precisar de HttpContext no método de negociação personalizado.

2. Registre o roteador no contêiner de DI.

using Microsoft.Azure.Functions.Extensions.DependencyInjection;
using Microsoft.Azure.SignalR;
using Microsoft.Extensions.DependencyInjection;

[assembly: FunctionsStartup(typeof(SimpleChatV3.Startup))]
namespace SimpleChatV3
{
    public class Startup : FunctionsStartup
    {
        public override void Configure(IFunctionsHostBuilder builder)
        {
            builder.Services.AddSingleton<IEndpointRouter, CustomizedRouter>();
        }
    }
}

Modelo de processo isolado

Para funções executadas no modelo de processo isolado, oferecemos suporte à especificação de pontos de extremidade alvo em cada solicitação. Você usará novos tipos de associação para obter informações de ponto de extremidade.

Roteamento do cliente

A associação SignalRConnectionInfo seleciona um ponto de extremidade de acordo com a regra de roteamento padrão. Se você quiser personalizar a regra de roteamento, você deverá usar a associação SignalRNegotiation em vez da associação SignalRConnectionInfo.

As propriedades de configuração da associação SignalRNegotiation são as mesmas da SignalRConnectionInfo. Aqui está um exemplo de arquivo function.json:

{
    "type": "signalRNegotiation",
    "name": "negotiationContext",
    "hubName": "<HubName>",
    "direction": "in"
}

Você também pode adicionar outros dados de associação, como userId, idToken e claimTypeList, assim como SignalRConnectionInfo.

O objeto que você obtém da associação SignalRNegotiation tem o seguinte formato:

{
    "endpoints": [
        {
            "endpointType": "Primary",
            "name": "<EndpointName>",
            "endpoint": "https://****.service.signalr.net",
            "online": true,
            "connectionInfo": {
                "url": "<client-access-url>",
                "accessToken": "<client-access-token>"
            }
        },
        {
            "...": "..."
        }
    ]
}

Aqui está um exemplo de uso de associação SignalRNegotiation em JavaScript:

module.exports = function (context, req, negotiationContext) {
    var userId = req.query.userId;
    if (userId.startsWith("east-")) {
        //return the first endpoint whose name starts with "east-" and status is online.
        context.res.body = negotiationContext.endpoints.find(endpoint => endpoint.name.startsWith("east-") && endpoint.online).connectionInfo;
    }
    else {
        //return the first online endpoint
        context.res.body = negotiationContext.endpoints.filter(endpoint => endpoint.online)[0].connectionInfo;
    }
}

Roteamento de mensagens

O roteamento de mensagens ou ações precisa de dois tipos de associação para cooperar. Em geral, primeiro você precisa de um novo tipo de associação de entrada SignalREndpoints para obter todas as informações de ponto de extremidade disponíveis. Em seguida, você filtra os pontos de extremidade e obtém uma matriz contendo todos os pontos de extremidade para os quais você deseja enviar. Por fim, você especifica os pontos de extremidade de destino na associação de saída SignalR.

Aqui estão as propriedades de configuração da associação SignalREndpoints no arquivo functions.json:

{
      "type": "signalREndpoints",
      "direction": "in",
      "name": "endpoints",
      "hubName": "<HubName>"
}

O objeto que você obtém de SignalREndpoints é uma matriz de pontos de extremidade, cada um deles representado como um objeto JSON com o seguinte esquema:

{
    "endpointType": "<EndpointType>",
    "name": "<EndpointName>",
    "endpoint": "https://****.service.signalr.net",
    "online": true
}

Depois de você obter a matriz de ponto de extremidade de destino, adicione uma propriedade endpoints ao objeto de vinculação de saída. Este é um exemplo em JavaScript:

module.exports = function (context, req, endpoints) {
    var targetEndpoints = endpoints.filter(endpoint => endpoint.name.startsWith("east-"));
    context.bindings.signalRMessages = [{
        "target": "chat",
        "arguments": ["hello-world"],
        "endpoints": targetEndpoints,
    }];
    context.done();
}

Para SDK de Gerenciamento

Adicionar vários pontos de extremidade da configuração

Configure com a chave Azure:SignalR:Endpoints para a cadeia de conexão do Serviço do SignalR. A chave deve estar no formato Azure:SignalR:Endpoints:{Name}:{EndpointType}, em que Name e EndpointType são propriedades do objeto ServiceEndpoint e podem ser acessadas pelo código.

Você pode adicionar várias cadeias de conexão de instância usando os seguintes comandos dotnet:

dotnet user-secrets set Azure:SignalR:Endpoints:east-region-a <ConnectionString1>
dotnet user-secrets set Azure:SignalR:Endpoints:east-region-b:primary <ConnectionString2>
dotnet user-secrets set Azure:SignalR:Endpoints:backup:secondary <ConnectionString3>

Adicionar vários pontos de extremidade do código

Uma classe ServiceEndpoint descreve as propriedades de um ponto de extremidade do Serviço do Azure SignalR. Você pode configurar vários pontos de extremidade de instância ao usar o SDK de Gerenciamento do Azure SignalR por meio de:

var serviceManager = new ServiceManagerBuilder()
                    .WithOptions(option =>
                    {
                        options.Endpoints = new ServiceEndpoint[]
                        {
                            // Note: this is just a demonstration of how to set options.Endpoints
                            // Having ConnectionStrings explicitly set inside the code is not encouraged
                            // You can fetch it from a safe place such as Azure KeyVault
                            new ServiceEndpoint("<ConnectionString0>"),
                            new ServiceEndpoint("<ConnectionString1>", type: EndpointType.Primary, name: "east-region-a"),
                            new ServiceEndpoint("<ConnectionString2>", type: EndpointType.Primary, name: "east-region-b"),
                            new ServiceEndpoint("<ConnectionString3>", type: EndpointType.Secondary, name: "backup"),
                        };
                    })
                    .BuildServiceManager();

Personalizar o roteador de ponto de extremidade

Por padrão, o SDK usa o DefaultEndpointRouter para escolher os pontos de extremidade.

Comportamento padrão

• Roteamento de solicitação do cliente:

  Quando o cliente /negotiate com o servidor de aplicativos. Por padrão, o SDK seleciona aleatoriamente um ponto de extremidade do conjunto de pontos de extremidade de serviço disponíveis.

• Roteamento de mensagens do servidor:

  Ao enviar uma mensagem para uma conexão específica com a conexão de destino roteada para o servidor atual, a mensagem vai diretamente para esse ponto de extremidade conectado. Caso contrário, as mensagens são transmitidas para todos os pontos de extremidade do Azure SignalR.

Personalizar o algoritmo de roteamento

Você pode criar seu próprio roteador se você tem um conhecimento especial para identificar para quais pontos de extremidade as mensagens devem ir.

O exemplo a seguir define um roteador personalizado que roteia mensagens com um grupo começando com east- para o ponto de extremidade chamado east:

private class CustomRouter : EndpointRouterDecorator
{
    public override IEnumerable<ServiceEndpoint> GetEndpointsForGroup(string groupName, IEnumerable<ServiceEndpoint> endpoints)
    {
        // Override the group broadcast behavior, if the group name starts with "east-", only send messages to endpoints inside east
        if (groupName.StartsWith("east-"))
        {
            return endpoints.Where(e => e.Name.StartsWith("east-"));
        }

        return base.GetEndpointsForGroup(groupName, endpoints);
    }
}

O exemplo a seguir substitui o comportamento de negociação padrão e seleciona o ponto de extremidade dependendo do local do servidor de aplicativos.

private class CustomRouter : EndpointRouterDecorator
{    public override ServiceEndpoint GetNegotiateEndpoint(HttpContext context, IEnumerable<ServiceEndpoint> endpoints)
    {
        // Override the negotiate behavior to get the endpoint from query string
        var endpointName = context.Request.Query["endpoint"];
        if (endpointName.Count == 0)
        {
            context.Response.StatusCode = 400;
            var response = Encoding.UTF8.GetBytes("Invalid request");
            context.Response.Body.Write(response, 0, response.Length);
            return null;
        }

        return endpoints.FirstOrDefault(s => s.Name == endpointName && s.Online) // Get the endpoint with name matching the incoming request
               ?? base.GetNegotiateEndpoint(context, endpoints); // Or fallback to the default behavior to randomly select one from primary endpoints, or fallback to secondary when no primary ones are online
    }
}

Não se esqueça de registrar o roteador para o contêiner DI usando:

var serviceManager = new ServiceManagerBuilder()
                    .WithOptions(option =>
                    {
                        options.Endpoints = new ServiceEndpoint[]
                        {
                            // Note: this is just a demonstration of how to set options.Endpoints
                            // Having ConnectionStrings explicitly set inside the code is not encouraged
                            // You can fetch it from a safe place such as Azure KeyVault
                            new ServiceEndpoint("<ConnectionString0>"),
                            new ServiceEndpoint("<ConnectionString1>", type: EndpointType.Primary, name: "east-region-a"),
                            new ServiceEndpoint("<ConnectionString2>", type: EndpointType.Primary, name: "east-region-b"),
                            new ServiceEndpoint("<ConnectionString3>", type: EndpointType.Secondary, name: "backup"),
                        };
                    })
                    .WithRouter(new CustomRouter())
                    .BuildServiceManager();