Gerenciamento de recursos JavaScript
A biblioteca de gerenciamento de recursos JavaScript fornece uma maneira de desenvolver e expor a funcionalidade do aplicativo com base em sinalizadores de recursos. Uma vez que um novo recurso é desenvolvido, muitos aplicativos têm requisitos especiais, como quando o recurso deve ser ativado e em que condições. Essa biblioteca fornece uma maneira de definir essas relações e também se integra a padrões de código JavaScript comuns para tornar possível a exposição desses recursos.
Os sinalizadores de recursos fornecem uma maneira para os aplicativos JavaScript ativarem ou desativarem recursos dinamicamente. Os desenvolvedores podem usar sinalizadores de recursos em casos de uso simples, como instruções condicionais.
Aqui estão alguns dos benefícios de usar a biblioteca de gerenciamento de recursos JavaScript:
- Uma convenção comum para o gerenciamento de recursos
- Baixa barreira à entrada
- Suporta objetos JSON e fontes de sinalizadores de recursos baseados em mapa
- Suporta o uso em ambientes Node.js e navegador
- Gerenciamento do tempo de vida do sinalizador de recurso com a Configuração do Aplicativo do Azure
- Os valores de configuração podem mudar em tempo real
- Cenários simples a complexos cobertos
- Ativar e desativar recursos por meio do arquivo de configuração declarativa
- Avalie dinamicamente o estado do recurso com base na chamada para o servidor
A biblioteca de gerenciamento de recursos JavaScript é de código aberto. Para obter mais informações, visite o repositório GitHub.
Nota
É recomendável usar a biblioteca de gerenciamento de recursos junto com a Configuração do Aplicativo do Azure. A Configuração de Aplicativo do Azure fornece uma solução para gerenciar centralmente as configurações do aplicativo e os sinalizadores de recursos. Para mais detalhes, consulte esta secção.
Marcas de funcionalidades
Os sinalizadores de recursos são compostos por duas partes, um nome e uma lista de filtros de recursos que são usados para ativar o recurso.
Filtros de recursos
Os filtros de recursos definem um cenário para quando um recurso deve ser habilitado. Quando um recurso é avaliado se está ativado ou desativado, sua lista de filtros de recursos é percorrida até que um dos filtros decida que o recurso deve ser habilitado. Neste ponto, o recurso é considerado habilitado e atravessa os filtros de recurso para. Se nenhum filtro de recurso indicar que o recurso deve ser habilitado, ele será considerado desativado.
Como exemplo, um filtro de recurso do navegador Microsoft Edge pode ser projetado. Esse filtro de recursos ativaria todos os recursos anexados a ele, desde que uma solicitação HTTP seja proveniente do Microsoft Edge.
Configuração do sinalizador de recursos
Em JavaScript, os desenvolvedores geralmente usam objetos ou mapas como as estruturas de dados primárias para representar configurações. A biblioteca de gerenciamento de recursos JavaScript suporta ambas as abordagens de configuração, fornecendo aos desenvolvedores a flexibilidade de escolher a opção que melhor atende às suas necessidades. O FeatureManager pode ler sinalizadores de recursos de diferentes tipos de configuração usando o built-in ConfigurationObjectFeatureFlagProvider e ConfigurationMapFeatureFlagProvider.
const config = new Map([
["feature_management", {
"feature_flags": [
{
"id": "FeatureT",
"enabled": true
},
{
"id": "FeatureU",
"enabled": false
}
]
}],
["some other configuration", " some value"]
]);
import { ConfigurationMapFeatureFlagProvider, FeatureManager } from "@microsoft/feature-management";
const featureProvider = new ConfigurationMapFeatureFlagProvider(config);
const featureManager = new FeatureManager(featureProvider);
Usar sinalizadores de recursos da Configuração do Aplicativo do Azure
Em vez de codificar os sinalizadores de recursos em seu aplicativo, recomendamos que você mantenha os sinalizadores de recursos fora do aplicativo e os gerencie separadamente. Isso permite que você modifique os estados de bandeira a qualquer momento e que essas alterações entrem em vigor no aplicativo imediatamente. O serviço de Configuração de Aplicativo do Azure fornece uma interface do usuário de portal dedicada para gerenciar todos os seus sinalizadores de recursos. Veja o tutorial.
O serviço de Configuração de Aplicativo do Azure também fornece os sinalizadores de recurso para seu aplicativo diretamente por meio de sua biblioteca de cliente JavaScript @azure/app-configuration-provider. O exemplo a seguir mostra como usar a biblioteca.
O provedor JavaScript de Configuração do Aplicativo fornece sinalizadores de recursos em um Map objeto. O built-in ConfigurationMapFeatureFlagProvider ajuda a carregar sinalizadores de recursos neste caso.
import { DefaultAzureCredential } from "@azure/identity";
import { load } from "@azure/app-configuration-provider";
import { ConfigurationMapFeatureFlagProvider, FeatureManager } from "@microsoft/feature-management";
const appConfig = await load("YOUR_APP-CONFIG-ENDPOINT",
new DefaultAzureCredential(), // For more information: https://learn.microsoft.com/javascript/api/overview/azure/identity-readme
{featureFlagOptions: { enabled: true }}); // load feature flags from Azure App Configuration service
const featureProvider = new ConfigurationMapFeatureFlagProvider(appConfig);
const featureManager = new FeatureManager(featureProvider);
Nota
Para obter mais informações sobre como usar a biblioteca de gerenciamento de recursos com a Configuração de Aplicativo do Azure, vá para o início rápido.
Declaração de sinalizador de recurso
O exemplo a seguir mostra o formato usado para configurar sinalizadores de recursos em um arquivo JSON.
{
"feature_management": {
"feature_flags": [
{
"id": "FeatureT",
"enabled": true
},
{
"id": "FeatureU",
"enabled": false
},
{
"id": "FeatureV",
"enabled": true,
"conditions": {
"client_filters": [
{
"name": "Microsoft.TimeWindow",
"parameters": {
"Start": "Wed, 01 May 2019 13:59:59 GMT",
"End": "Mon, 01 Jul 2019 00:00:00 GMT"
}
}
]
}
}
]
}
}
A feature_management seção é usada por convenção para carregar as configurações do sinalizador de recurso. A feature_flags seção é uma lista dos sinalizadores de recursos que são carregados na biblioteca. Na seção acima, vemos três características diferentes. Os recursos definem seus filtros de recursos usando a client_filters propriedade, dentro do conditions. Nos filtros de recurso para FeatureT, vemos enabled que está true sem filtros definidos, resultando em FeatureT sempre retornar true .
FeatureU é o mesmo que FeatureT mas com enabled está false resultando no recurso sempre retornando false.
FeatureV Especifica um filtro de recurso chamado Microsoft.TimeWindow.
FeatureV é um exemplo de um filtro de recurso configurável. Podemos ver no exemplo que o filtro tem uma parameters propriedade. A parameters propriedade é usada para configurar o filtro. Nesse caso, os horários de início e término para que o recurso esteja ativo são configurados.
O esquema detalhado da feature_management seção pode ser encontrado aqui.
Avançado: O uso de dois pontos ':' é proibido em nomes de sinalizadores de recursos.
Tipo de requisito
A requirement_type propriedade de um sinalizador de recurso é usada para determinar se os filtros devem usar Any ou All lógica ao avaliar o estado de um recurso. Se requirement_type não for especificado, o valor padrão será Any.
-
Anysignifica que apenas um filtro precisa ser avaliado como true para que o recurso seja habilitado. -
Allsignifica que cada filtro precisa ser avaliado como true para que o recurso seja habilitado.
A requirement_type de All muda a travessia. Primeiro, se não houver filtros, o recurso será desativado. Em seguida, os filtros de recurso são percorridos até que um dos filtros decida que o recurso deve ser desativado. Se nenhum filtro indicar que o recurso deve ser desativado, ele será considerado habilitado.
{
"feature_management": {
"feature_flags": [
{
"id": "FeatureW",
"enabled": true,
"conditions": {
"requirement_type": "All",
"client_filters": [
{
"name": "Microsoft.TimeWindow",
"parameters": {
"Start": "Wed, 01 May 2019 13:59:59 GMT",
"End": "Mon, 01 Jul 2019 00:00:00 GMT"
}
},
{
"name": "Percentage",
"parameters": {
"Value": "50"
}
}
]
}
},
]
}
}
No exemplo acima, FeatureW especifica a requirement_type de All, o que significa que todos os seus filtros devem ser avaliados como true para que o recurso seja habilitado. Nesse caso, o recurso é habilitado para 50% dos usuários durante a janela de tempo especificada.
Consumo
A forma básica de gerenciamento de recursos é verificar se um sinalizador de recurso está habilitado e, em seguida, executar ações com base no resultado. A verificação do estado de um sinalizador de recurso é feita através FeatureManagerdo isEnabled método .
import { ConfigurationMapFeatureFlagProvider, FeatureManager } from "@microsoft/feature-management";
const featureProvider = new ConfigurationMapFeatureFlagProvider(config);
const featureManager = new FeatureManager(featureProvider);
const isBetaEnabled = await featureManager.isEnabled("Beta");
if (isBetaEnabled) {
// Do something
}
Implementando um filtro de recursos
A criação de um filtro de recursos fornece uma maneira de habilitar recursos com base em critérios definidos por você. Para implementar um filtro de recursos, a IFeatureFilter interface deve ser implementada.
IFeatureFilter tem uma name propriedade e um método chamado evaluate. O name deve ser usado na configuração para fazer referência ao filtro de recurso dentro de um sinalizador de recurso. Quando um recurso especifica que pode ser habilitado para um filtro de recurso, o evaluate método é chamado. Se evaluate retornar true, significa que o recurso deve ser habilitado.
interface IFeatureFilter {
name: string;
evaluate(context: IFeatureFilterEvaluationContext, appContext?: unknown): boolean | Promise<boolean>;
}
O trecho a seguir demonstra como implementar um filtro de recurso personalizado com o nome MyCriteria.
class MyCriteriaFilter {
name = "MyCriteria";
evaluate(context, appContext) {
if (satisfyCriteria()) {
return true;
}
else {
return false;
}
}
}
Você precisa registrar o filtro personalizado ao criar o FeatureManager.
const featureManager = new FeatureManager(ffProvider, {customFilters: [new MyCriteriaFilter()]});
Filtros de recursos parametrizados
Alguns filtros de recursos exigem parâmetros para decidir se um recurso deve ser ativado ou não. Por exemplo, um filtro de recursos do navegador pode ativar um recurso para um determinado conjunto de navegadores. Pode ser desejado que os navegadores Edge e Chrome ativem um recurso, enquanto o Firefox não. Para fazer isso, um filtro de recurso pode ser projetado para esperar parâmetros. Esses parâmetros seriam especificados na configuração do recurso, e no código seria acessível através do IFeatureFilterEvaluationContext parâmetro de IFeatureFilter.Evaluate.
interface IFeatureFilterEvaluationContext {
featureName: string;
parameters?: unknown;
}
IFeatureFilterEvaluationContext tem uma propriedade chamada parameters. Esses parâmetros representam uma configuração bruta que o filtro de recursos pode usar para decidir como avaliar se o recurso deve ser habilitado ou não. Para usar o filtro de recursos do navegador como exemplo mais uma vez, o filtro poderia usar parameters para extrair um conjunto de navegadores permitidos que seriam especificados para o recurso e, em seguida, verificar se a solicitação está sendo enviada de um desses navegadores.
Usar o contexto do aplicativo para avaliação de recursos
Um filtro de recurso pode precisar do contexto do aplicativo de tempo de execução para avaliar um sinalizador de recurso. Você pode passar no contexto como um parâmetro ao chamar isEnabled.
featureManager.isEnabled("Beta", { userId : "Sam" })
O filtro de recursos pode aproveitar o contexto que é passado quando isEnabled é chamado. O contexto do aplicativo será passado como o segundo parâmetro do IFeatureFilter.Evaluate.
Filtros de recursos integrados
Há dois filtros de recursos que acompanham o FeatureManagement pacote: TimeWindowFilter, e TargetingFilter.
Cada um dos filtros de recursos internos tem seus próprios parâmetros. Aqui está a lista de filtros de recursos, juntamente com exemplos.
Microsoft.TimeWindow
Esse filtro fornece a capacidade de habilitar um recurso com base em uma janela de tempo. Se apenas End for especificado, o recurso será considerado ativado até esse momento. Se apenas Start for especificado, o recurso será considerado ativado em todos os pontos após esse período.
"client_filters": [
{
"name": "Microsoft.TimeWindow",
"parameters": {
"Start": "Wed, 01 May 2019 13:59:59 GMT",
"End": "Mon, 01 Jul 2019 00:00:00 GMT"
}
}
]
Microsoft.Targeting
Esse filtro fornece a capacidade de habilitar um recurso para um público-alvo. Uma explicação detalhada da segmentação é explicada na seção de segmentação abaixo. Os parâmetros de filtro incluem um Audience objeto que descreve usuários, grupos, usuários/grupos excluídos e uma porcentagem padrão da base de usuários que deve ter acesso ao recurso. Cada objeto de grupo listado Groups na seção também deve especificar qual porcentagem dos membros do grupo deve ter acesso. Se um usuário for especificado na Exclusion seção, diretamente ou se o usuário estiver em um grupo excluído, o recurso será desabilitado. Caso contrário, se um usuário for especificado na Users seção diretamente, ou se o usuário estiver na porcentagem incluída de qualquer uma das distribuições do grupo, ou se o usuário cair na porcentagem de distribuição padrão, esse usuário terá o recurso habilitado.
"client_filters": [
{
"name": "Microsoft.Targeting",
"parameters": {
"Audience": {
"Users": [
"Jeff",
"Alicia"
],
"Groups": [
{
"Name": "Ring0",
"RolloutPercentage": 100
},
{
"Name": "Ring1",
"RolloutPercentage": 50
}
],
"DefaultRolloutPercentage": 20,
"Exclusion": {
"Users": [
"Ross"
],
"Groups": [
"Ring2"
]
}
}
}
}
]
Seleção do destino
A segmentação é uma estratégia de gerenciamento de recursos que permite que os desenvolvedores implementem progressivamente novos recursos em sua base de usuários. A estratégia baseia-se no conceito de segmentação de um conjunto de utilizadores conhecido como público-alvo. Um público é composto por usuários específicos, grupos, usuários/grupos excluídos e uma porcentagem designada de toda a base de usuários. Os grupos que estão incluídos na audiência podem ser divididos em porcentagens de seus membros totais.
As etapas a seguir demonstram um exemplo de uma distribuição progressiva para um novo recurso 'Beta':
- Os usuários individuais Jeff e Alicia têm acesso ao Beta.
- Outro usuário, Mark, pede para aceitar e é incluído.
- Vinte por cento de um grupo conhecido como "Ring1" usuários estão incluídos no Beta.
- O número de usuários "Ring1" incluídos no Beta é aumentado para 100%.
- Cinco por cento da base de utilizadores está incluída na versão Beta.
- A porcentagem de lançamento é aumentada para 100% e o recurso é completamente implementado.
Essa estratégia para implantar um recurso é incorporada à biblioteca por meio do filtro de recursos Microsoft.Targeting incluído.
Segmentar um usuário com contexto de segmentação
O filtro de segmentação depende de um contexto de segmentação para avaliar se um recurso deve ser ativado. Esse contexto de segmentação contém informações como qual usuário está sendo avaliado no momento e em quais grupos o usuário está. O contexto de segmentação deve ser passado diretamente quando isEnabled é chamado.
featureManager.isEnabled("Beta", { userId: "Aiden", groups: ["Ring1"] })
Segmentação da exclusão
Ao definir uma audiência, os usuários e grupos podem ser excluídos da audiência. As exclusões são úteis para quando um recurso está sendo implementado para um grupo de usuários, mas alguns usuários ou grupos precisam ser excluídos da implantação. A exclusão é definida pela adição de uma lista de usuários e grupos à Exclusion propriedade da audiência.
"Audience": {
"Users": [
"Jeff",
"Alicia"
],
"Groups": [
{
"Name": "Ring0",
"RolloutPercentage": 100
}
],
"DefaultRolloutPercentage": 0,
"Exclusion": {
"Users": [
"Mark"
]
}
}
No exemplo acima, o recurso está habilitado para usuários chamados Jeff e Alicia. Ele também está habilitado para usuários no grupo chamado Ring0. No entanto, se o usuário for nomeado Mark, o recurso será desativado, independentemente de ele estar no grupo Ring0 ou não. As exclusões têm prioridade sobre o restante do filtro de segmentação.
Variantes
Quando novos recursos são adicionados a um aplicativo, pode chegar um momento em que um recurso tem várias opções de design propostas diferentes. Uma solução comum para decidir sobre um design é alguma forma de teste A/B, que envolve fornecer uma versão diferente do recurso para diferentes segmentos da base de usuários e escolher uma versão com base na interação do usuário. Nesta biblioteca, essa funcionalidade é habilitada representando diferentes configurações de um recurso com variantes.
As variantes permitem que um sinalizador de recurso se torne mais do que um simples sinalizador de ligar/desligar. Uma variante representa um valor de um sinalizador de recurso que pode ser uma cadeia de caracteres, um número, um booleano ou até mesmo um objeto de configuração. Um sinalizador de recurso que declara variantes deve definir em que circunstâncias cada variante deve ser usada, o que é abordado com mais detalhes na seção Alocação de variantes.
Obter uma variante com contexto de segmentação
Para cada recurso, uma variante pode ser recuperada usando o FeatureManagermétodo do getVariant . A atribuição de variante depende do usuário que está sendo avaliado no momento, e essas informações são obtidas a partir do contexto de segmentação transmitido.
const variant = await featureManager.getVariant("MyVariantFeatureFlag", { userId: "Sam" });
const variantName = variant.name;
const variantConfiguration = variant.configuration;
// Do something with the resulting variant and its configuration
Declaração de sinalizador de recurso variante
Em comparação com os sinalizadores de recursos normais, os sinalizadores de recursos variantes têm mais duas propriedades: variants e allocation. A variants propriedade é uma matriz que contém as variantes definidas para esse recurso. A allocation propriedade define como essas variantes devem ser alocadas para o recurso. Assim como declarar sinalizadores de recursos normais, você pode configurar sinalizadores de recursos variantes em um arquivo JSON. Aqui está um exemplo de um sinalizador de recurso variante.
{
"feature_management": {
"feature_flags": [
{
"id": "MyVariantFeatureFlag",
"enabled": true,
"allocation": {
"default_when_enabled": "Small",
"group": [
{
"variant": "Big",
"groups": [
"Ring1"
]
}
]
},
"variants": [
{
"name": "Big"
},
{
"name": "Small"
}
]
}
]
}
}
Definição de variantes
Cada variante tem duas propriedades: um nome e uma configuração. O nome é usado para se referir a uma variante específica, e a configuração é o valor dessa variante. A configuração pode ser definida usando configuration_value a propriedade.
configuration_value é uma configuração embutida que pode ser uma cadeia de caracteres, número, booleano ou objeto de configuração. Se configuration_value não for especificado, a propriedade da variante configuration retornada será undefined.
Uma lista de todas as variantes possíveis é definida para cada recurso sob a variants propriedade.
{
"feature_management": {
"feature_flags": [
{
"id": "MyVariantFeatureFlag",
"variants": [
{
"name": "Big",
"configuration_value": {
"Size": 500
}
},
{
"name": "Small",
"configuration_value": {
"Size": 300
}
}
]
}
]
}
}
Atribuição de variantes
O processo de alocação das variantes de um recurso é determinado pela allocation propriedade do recurso.
"allocation": {
"default_when_enabled": "Small",
"default_when_disabled": "Small",
"user": [
{
"variant": "Big",
"users": [
"Marsha"
]
}
],
"group": [
{
"variant": "Big",
"groups": [
"Ring1"
]
}
],
"percentile": [
{
"variant": "Big",
"from": 0,
"to": 10
}
],
"seed": "13973240"
},
"variants": [
{
"name": "Big",
"configuration_value": "500px"
},
{
"name": "Small",
"configuration_value": "300px"
}
]
A allocation configuração de um recurso tem as seguintes propriedades:
| Property | Description |
|---|---|
default_when_disabled |
Especifica qual variante deve ser usada quando uma variante é solicitada enquanto o recurso é considerado desativado. |
default_when_enabled |
Especifica qual variante deve ser usada quando uma variante é solicitada enquanto o recurso é considerado habilitado e nenhuma outra variante foi atribuída ao usuário. |
user |
Especifica uma variante e uma lista de usuários aos quais essa variante deve ser atribuída. |
group |
Especifica uma variante e uma lista de grupos. A variante é atribuída se o usuário estiver em pelo menos um dos grupos. |
percentile |
Especifica uma variante e um intervalo de porcentagem no qual a porcentagem calculada do usuário deve se encaixar para que essa variante seja atribuída. |
seed |
O valor em percentile que se baseiam os cálculos percentuais. O cálculo de porcentagem para um usuário específico será o mesmo em todos os recursos se o mesmo seed valor for usado. Se não seed for especificado, uma semente padrão será criada com base no nome do recurso. |
Se o recurso não estiver habilitado, o gerenciador de recursos atribuirá a variante marcada como default_when_disabled ao usuário atual, que é Small neste caso.
Se o recurso estiver habilitado, o gerenciador de recursos verificará o user, groupe as alocações nessa ordem para atribuir uma variante percentile . Para este exemplo em particular, se o usuário que está sendo avaliado for nomeado Marsha, no grupo chamado Ring1, ou se o usuário cair entre o percentil 0 e 10, a variante especificada será atribuída ao usuário. Nesse caso, todos os usuários atribuídos retornariam a Big variante. Se nenhuma dessas alocações corresponder, o usuário receberá a default_when_enabled variante, que é Small.
A lógica de alocação é semelhante ao filtro de recursos Microsoft.Targeting , mas há alguns parâmetros presentes na segmentação que não estão na alocação e vice-versa. Os resultados da segmentação e da alocação não estão relacionados.
Substituindo o estado habilitado por uma variante
Você pode usar variantes para substituir o estado ativado de um sinalizador de recurso. A substituição dá às variantes a oportunidade de estender a avaliação de um sinalizador de recurso. Ao chamar is_enabled um sinalizador com variantes, o gerenciador de recursos verificará se a variante atribuída ao usuário atual está configurada para substituir o resultado. A substituição é feita usando a propriedade status_overridevariant opcional. Por padrão, essa propriedade é definida como None, o que significa que a variante não afeta se o sinalizador é considerado habilitado ou desabilitado. Configuração status_override para Enabled permitir que a variante, quando escolhida, substitua um sinalizador a ser habilitado. Configuração status_override para Disabled fornecer a funcionalidade oposta, portanto, desativando o sinalizador quando a variante é escolhida. Um recurso com um enabled estado de não pode ser substituído false .
Se você estiver usando um sinalizador de recurso com variantes binárias, a status_override propriedade pode ser útil. Ele permite que você continue usando APIs como is_enabled em seu aplicativo, enquanto se beneficia dos novos recursos que vêm com variantes, como alocação de percentis e semente.
{
"id": "MyVariantFeatureFlag",
"enabled": true,
"allocation": {
"percentile": [
{
"variant": "On",
"from": 10,
"to": 20
}
],
"default_when_enabled": "Off",
"seed": "Enhanced-Feature-Group"
},
"variants": [
{
"name": "On"
},
{
"name": "Off",
"status_override": "Disabled"
}
]
}
No exemplo acima, o recurso está sempre ativado. Se o usuário atual estiver no intervalo de percentis calculado de 10 a 20, a On variante será retornada. Caso contrário, a Off variante é retornada e, como status_override é igual a Disabled, o recurso agora será considerado desativado.
Telemetria
Quando uma alteração de sinalizador de recurso é implantada, geralmente é importante analisar seu efeito em um aplicativo. Por exemplo, aqui estão algumas perguntas que podem surgir:
- Os meus sinalizadores estão ativados/desativados conforme esperado?
- Os usuários-alvo estão tendo acesso a um determinado recurso conforme o esperado?
- Qual variante um usuário específico está vendo?
Estes tipos de perguntas podem ser respondidas através da emissão e análise de eventos de avaliação de sinalizadores de funcionalidades.
Habilitando a telemetria
Por padrão, os sinalizadores de recursos não têm telemetria emitida. Para publicar telemetria para um determinado sinalizador de recurso, o sinalizador DEVE declarar que está habilitado para emissão de telemetria.
Para sinalizadores de recursos definidos em json, a habilitação é feita usando a telemetry propriedade.
{
"feature_management": {
"feature_flags": [
{
"id": "MyFeatureFlag",
"enabled": true,
"telemetry": {
"enabled": true
}
}
]
}
}
O trecho acima define um sinalizador de recurso chamado MyFeatureFlag que está habilitado para telemetria. A telemetry propriedade do enabled objeto é definida como true. O valor da enabled propriedade deve ser true publicar telemetria para o sinalizador.
A telemetry seção de um sinalizador de recurso tem as seguintes propriedades:
| Property | Description |
|---|---|
enabled |
Especifica se a telemetria deve ser publicada para o sinalizador de recurso. |
metadata |
Uma coleção de pares chave-valor, modelada como um dicionário, que pode ser usada para anexar metadados personalizados sobre o sinalizador de recurso a eventos de avaliação. |
Publicação de telemetria personalizada
Você pode registrar uma função de retorno de onFeatureEvaluated chamada ao criar FeatureManagero . Esse retorno de chamada é chamado sempre que um sinalizador de recurso é avaliado e a telemetria é habilitada para esse sinalizador. A função de retorno de chamada tomará o resultado da avaliação do recurso como parâmetro.
O exemplo a seguir mostra como implementar uma função de retorno de chamada personalizada para enviar telemetria com as informações extraídas do resultado da avaliação do recurso e registrá-lo no gerenciador de recursos.
const sendTelemetry = (evaluationResult) => {
const featureId = evaluationResult.feature.id;
const featureEnabled = evaluationResult.enabled;
const targetingId = evaluationResult.targetingId;
const variantName = evaluationResult.variant?.name;
const variantAssignmentReason = evaluationResult.variantAssignmentReason;
// custom code to send the telemetry
// ...
}
const featureManager = new FeatureManager(featureProvider, { onFeatureEvaluated : sendTelemtry});
Integração do Application Insights
A biblioteca de gerenciamento de recursos JavaScript fornece pacotes de extensão que se integram aos SDKs do Application Insights .
O Application Insights oferece diferentes SDKs para cenários da Web e Node.js . Selecione os pacotes de extensão corretos para o seu aplicativo.
Se o seu aplicativo for executado no navegador, instale o "@microsoft/feature-management-applicationinsights-browser" pacote. O exemplo a seguir mostra como você pode criar um editor de telemetria interno do Application Insights e registrá-lo no gerenciador de recursos.
import { ApplicationInsights } from "@microsoft/applicationinsights-web"
import { FeatureManager, ConfigurationObjectFeatureFlagProvider } from "@microsoft/feature-management";
import { createTelemetryPublisher, trackEvent } from "@microsoft/feature-management-applicationinsights-browser";
const appInsights = new ApplicationInsights({ config: {
connectionString: "<APPINSIGHTS_CONNECTION_STRING>"
}});
appInsights.loadAppInsights();
const publishTelemetry = createTelemetryPublisher(appInsights);
const provider = new ConfigurationObjectFeatureFlagProvider(jsonObject);
const featureManager = new FeatureManager(provider, {onFeatureEvaluated: publishTelemetry});
// FeatureEvaluation event will be emitted when a feature flag is evaluated
featureManager.getVariant("TestFeature", {userId : TARGETING_ID}).then((variant) => { /* do something*/ });
// Emit a custom event with targeting id attached.
trackEvent(appInsights, TARGETING_ID, {name: "TestEvent"}, {"Tag": "Some Value"});
O editor de telemetria envia FeatureEvaluation eventos personalizados para o Application Insights quando um sinalizador de recurso habilitado com telemetria é avaliado. O evento personalizado segue o esquema FeatureEvaluationEvent .
Próximos passos
Para saber como usar sinalizadores de recursos em seus aplicativos, continue para os seguintes inícios rápidos.
Para saber como usar filtros de recursos, continue para os tutoriais a seguir.