Habilitar telemetria para feature flags num aplicativo Node.js

Neste tutorial, você usa a telemetria em seu aplicativo Node.js para acompanhar avaliações de sinalizadores de recursos e eventos personalizados. A telemetria permite que você tome decisões informadas sobre sua estratégia de gerenciamento de recursos. Você utiliza o sinalizador de recurso com telemetria habilitada criado na visão geral para habilitar a telemetria para sinalizadores de recurso. Antes de continuar, certifique-se de criar um sinalizador de recurso chamado Saudação no repositório de configurações com a telemetria habilitada. Este tutorial se baseia no tutorial para usar sinalizadores de recursos variantes em um aplicativo Node.js.

Pré-requisitos

• O sinalizador de recurso variante com telemetria habilitada em Habilitar telemetria para sinalizadores de recurso.
• A aplicação da funcionalidade Usar variantes de flags numa aplicação Node.js.

Adicionar telemetria ao seu aplicativo Node.js

1. Instale os seguintes pacotes.

   npm install @microsoft/feature-management-applicationinsights-node
   

2. Abra server.js e adicione o código a seguir no início para se conectar ao Application Insights para publicar telemetria.

   const appInsightsConnectionString = process.env.APPLICATIONINSIGHTS_CONNECTION_STRING;
   const applicationInsights = require("applicationinsights");
   applicationInsights.setup(appInsightsConnectionString).start();
   
   const express = require("express");
   const server = express();
   // existing code ...
   

3. Adicione a seguinte importação.

   const { createTelemetryPublisher, trackEvent } = require("@microsoft/feature-management-applicationinsights-node");
   

4. Crie e registre o editor de telemetria ao inicializar o FeatureManager.

   // existing code ...
   const featureFlagProvider = new ConfigurationMapFeatureFlagProvider(appConfig);
   const publishTelemetry = createTelemetryPublisher(applicationInsights.defaultClient);
   featureManager = new FeatureManager(featureFlagProvider, {
       onFeatureEvaluated: publishTelemetry
   });
   // existing code ...
   

   O publishTelemetry retorno de chamada enviará dados de telemetria sempre que um sinalizador de recurso for avaliado.

5. Rastreie eventos personalizados para interações do usuário. Modifique o /api/like ponto de extremidade para enviar dados de telemetria para o Application Insights sempre que um usuário gostar de conteúdo. Isso ajuda a analisar quais variantes de recursos têm melhor desempenho.

   server.post("/api/like", (req, res) => {
       const { UserId } = req.body;
       if (UserId === undefined) {
           return res.status(400).send({ error: "UserId is required" });
       }
       trackEvent(applicationInsights.defaultClient, UserId, { name: "Liked" });
       res.status(200).send();
   });
   

Execute o aplicativo

1. O Application Insights requer uma cadeia de conexão para se conectar ao seu recurso do Application Insights. Defina a APPLICATIONINSIGHTS_CONNECTION_STRING variável de ambiente como a cadeia de conexão para seu recurso do Application Insights.

   setx APPLICATIONINSIGHTS_CONNECTION_STRING "applicationinsights-connection-string"
   

   Se você usar o PowerShell, execute o seguinte comando:

   $Env:APPLICATIONINSIGHTS_CONNECTION_STRING = "applicationinsights-connection-string"
   

   Se você usa macOS ou Linux, execute o seguinte comando:

   export APPLICATIONINSIGHTS_CONNECTION_STRING='applicationinsights-connection-string'
   

2. Execute o aplicativo, consulte a etapa 4 de Usar sinalizadores de recurso variante.

3. Crie 10 usuários diferentes e faça login no aplicativo. À medida que inicia sessão com cada utilizador, obtém uma variante de mensagem diferente para alguns deles. Cerca de 50% das vezes você não recebe mensagem nenhuma. 25% das vezes recebes a mensagem "Olá!" e 25% das vezes recebes "Espero que isso faça o teu dia!"

4. Alguns utilizadores clicam no botão Gosto para acionar o evento de telemetria.

   

5. Abra seu recurso do Application Insights no portal do Azure e selecione Logs em Monitoramento. Na janela de consulta, execute a seguinte consulta para ver os eventos de telemetria:

   // Step 1: Get distinct users and their Variant from FeatureEvaluation
   let evaluated_users =
       customEvents
       | where name == "FeatureEvaluation"
       | extend TargetingId = tostring(customDimensions.TargetingId),
               Variant = tostring(customDimensions.Variant)
       | summarize Variant = any(Variant) by TargetingId;
   
   // Step 2: Get distinct users who emitted a "Like"
   let liked_users =
       customEvents
       | where name == "Liked"
       | extend TargetingId = tostring(customDimensions.TargetingId)
       | summarize by TargetingId;
   
   // Step 3: Join them to get only the evaluated users who also liked
   let hearted_users =
       evaluated_users
       | join kind=inner (liked_users) on TargetingId
       | summarize HeartedUsers = dcount(TargetingId) by Variant;
   
   // Step 4: Total evaluated users per variant
   let total_users =
       evaluated_users
       | summarize TotalUsers = dcount(TargetingId) by Variant;
   
   // Step 5: Combine results
   let combined_data =
       total_users
       | join kind=leftouter (hearted_users) on Variant
       | extend HeartedUsers = coalesce(HeartedUsers, 0)
       | extend PercentageHearted = strcat(round(HeartedUsers * 100.0 / TotalUsers, 1), "%")
       | project Variant, TotalUsers, HeartedUsers, PercentageHearted;
   
   // Step 6: Add total row
   let total_sum =
       combined_data
       | summarize
           TotalUsers = sum(TotalUsers),
           HeartedUsers = sum(HeartedUsers)
       | extend
           Variant = "All",
           PercentageHearted = strcat(round(HeartedUsers * 100.0 / TotalUsers, 1), "%")
       | project Variant, TotalUsers, HeartedUsers, PercentageHearted;
   
   // Step 7: Output
   combined_data
   | union (total_sum)
   

   

   Você verá um evento "FeatureEvaluation" para cada vez que a página de cotação foi carregada e um evento "Liked" para cada vez que o botão like foi clicado. O evento "FeatureEvaluation" tem uma propriedade personalizada chamada FeatureName com o nome do sinalizador de recurso que foi avaliado. Ambos os eventos têm uma propriedade personalizada chamada TargetingId com o nome do usuário que gostou da citação.

   Para obter mais informações sobre o evento "FeatureEvaluation", vá para a referência de telemetria do sinalizador de recurso

Recursos adicionais

• Amostra de citação do dia

Próximos passos

Para obter o resumo completo dos recursos da biblioteca de gerenciamento de recursos JavaScript, consulte o documento a seguir.