Como: criar um participante de acompanhamento personalizado

Artigo
04/07/2023

O rastreamento de fluxo de trabalho fornece a visibilidade ao status da execução do fluxo de trabalho. O runtime de fluxo de trabalho emite os registros de rastreamento que descrevem os eventos de ciclo de vida do fluxo de trabalho, os eventos de ciclo de vida da atividade, os reinícios do indicador e as falhas. Esses registros de rastreamento são consumidos pelos participantes. O WF (Windows Workflow Foundation) inclui um participante padrão de rastreamento que grava registros de rastreamento como eventos de ETW (Rastreamento de Eventos para Windows). Se isso não atender aos requisitos, você também poderá escrever um participante de rastreamento personalizado. Esta etapa do tutorial descreve como criar um participante de rastreamento personalizado e um perfil de rastreamento que captura a saída das atividades WriteLine de forma que elas possam ser exibidas para o usuário.

Para criar o participante de rastreamento personalizado

Clique com o botão direito em NumberGuessWorkflowHost no Gerenciador de Soluções e escolha Adicionar, Classe. Digite StatusTrackingParticipant na caixa Nome e clique em Adicionar.
Adicione as seguintes instruções using (ou Imports) na parte superior do arquivo com as outras instruções using (ou Imports).
```
Imports System.Activities.Tracking  
Imports System.IO  
```
```
using System.Activities.Tracking;  
using System.IO;  
```

Modifique a classe StatusTrackingParticipant de forma que ela herde de TrackingParticipant.

Public Class StatusTrackingParticipant  
    Inherits TrackingParticipant  

End Class

class StatusTrackingParticipant : TrackingParticipant  
{  
}

Adicione a substituição do método de Track a seguir. Há vários tipos diferentes de registros de rastreamento. Estamos interessados na saída das atividades de WriteLine, que estão contidas nos registros de rastreamento da atividade. Se o TrackingRecord for um ActivityTrackingRecord para uma atividade WriteLine, o Text de WriteLine será acrescentado a um arquivo com o nome da InstanceId do fluxo de trabalho. Neste tutorial, o arquivo é salvo na pasta atual do aplicativo host.

Protected Overrides Sub Track(record As TrackingRecord, timeout As TimeSpan)  
    Dim asr As ActivityStateRecord = TryCast(record, ActivityStateRecord)  

    If Not asr Is Nothing Then  
        If asr.State = ActivityStates.Executing And _  
        asr.Activity.TypeName = "System.Activities.Statements.WriteLine" Then  

            'Append the WriteLine output to the tracking  
            'file for this instance.  
            Using writer As StreamWriter = File.AppendText(record.InstanceId.ToString())  
                writer.WriteLine(asr.Arguments("Text"))  
                writer.Close()  
            End Using  
        End If  
    End If  
End Sub

protected override void Track(TrackingRecord record, TimeSpan timeout)  
{  
    ActivityStateRecord asr = record as ActivityStateRecord;  

    if (asr != null)  
    {  
        if (asr.State == ActivityStates.Executing &&  
            asr.Activity.TypeName == "System.Activities.Statements.WriteLine")  
        {  
            // Append the WriteLine output to the tracking  
            // file for this instance  
            using (StreamWriter writer = File.AppendText(record.InstanceId.ToString()))  
            {  
                writer.WriteLine(asr.Arguments["Text"]);  
                writer.Close();  
            }  
        }  
    }  
}

Quando nenhum perfil de rastreamento for especificado, o perfil padrão de rastreamento será usado. Quando o perfil padrão do rastreamento for usado, os registros de rastreamento serão emitidos para todos os ActivityStates. Como somente precisamos capturar o texto uma vez durante o ciclo de vida da atividade WriteLine, somente extraímos o texto do estado ActivityStates.Executing. Em Para criar o perfil de rastreamento e registrar o participante de rastreamento, é criado um perfil de rastreamento que especifica que somente os registros de rastreamento WriteLine ActivityStates.Executing são emitidos.

Para criar o perfil de rastreamento e registrar o participante do rastreamento

Clique com o botão direito em WorkflowHostForm no Gerenciador de Soluções e escolha Exibir código.
Adicione a seguinte instrução using (ou Imports) na parte superior do arquivo com as outras instruções using (ou Imports).
```
Imports System.Activities.Tracking  
```
```
using System.Activities.Tracking;  
```

Adicione o seguinte código ao ConfigureWorkflowApplication depois do código que adiciona o StringWriter às extensões de fluxo de trabalho e antes dos manipuladores de ciclo de vida de fluxo de trabalho.

'Add the custom tracking participant with a tracking profile  
'that only emits tracking records for WriteLine activities.  
Dim query As New ActivityStateQuery()  
query.ActivityName = "WriteLine"  
query.States.Add(ActivityStates.Executing)  
query.Arguments.Add("Text")  

Dim profile As New TrackingProfile()  
profile.Queries.Add(query)  

Dim stp As New StatusTrackingParticipant()  
stp.TrackingProfile = profile  

wfApp.Extensions.Add(stp)

// Add the custom tracking participant with a tracking profile  
// that only emits tracking records for WriteLine activities.  
StatusTrackingParticipant stp = new StatusTrackingParticipant  
{  
    TrackingProfile = new TrackingProfile  
    {  
        Queries =
        {  
            new ActivityStateQuery  
            {  
                ActivityName = "WriteLine",  
                States = { ActivityStates.Executing },  
                Arguments = { "Text" }  
            }  
        }  
    }  
};  

wfApp.Extensions.Add(stp);

Este perfil de rastreamento especifica que somente os registros de estado de atividade para atividades WriteLine no estado Executing são emitidos para o participante de rastreamento personalizado.

Depois de adicionar o código, o início de ConfigureWorkflowApplication se parecerá com o exemplo a seguir.

Private Sub ConfigureWorkflowApplication(wfApp As WorkflowApplication)  
    'Configure the persistence store.  
    wfApp.InstanceStore = store  

    'Add a StringWriter to the extensions. This captures the output  
    'from the WriteLine activities so we can display it in the form.  
    Dim sw As New StringWriter()  
    wfApp.Extensions.Add(sw)  

    'Add the custom tracking participant with a tracking profile  
    'that only emits tracking records for WriteLine activities.  
    Dim query As New ActivityStateQuery()  
    query.ActivityName = "WriteLine"  
    query.States.Add(ActivityStates.Executing)  
    query.Arguments.Add("Text")  

    Dim profile As New TrackingProfile()  
    profile.Queries.Add(query)  

    Dim stp As New StatusTrackingParticipant()  
    stp.TrackingProfile = profile  

    wfApp.Extensions.Add(stp)  

    'Workflow lifecycle handlers...

private void ConfigureWorkflowApplication(WorkflowApplication wfApp)  
{  
    // Configure the persistence store.  
    wfApp.InstanceStore = store;  

    // Add a StringWriter to the extensions. This captures the output  
    // from the WriteLine activities so we can display it in the form.  
    StringWriter sw = new StringWriter();  
    wfApp.Extensions.Add(sw);  

    // Add the custom tracking participant with a tracking profile  
    // that only emits tracking records for WriteLine activities.  
    StatusTrackingParticipant stp = new StatusTrackingParticipant  
    {  
        TrackingProfile = new TrackingProfile  
        {  
            Queries =
            {  
                new ActivityStateQuery  
                {  
                    ActivityName = "WriteLine",  
                    States = { ActivityStates.Executing },  
                    Arguments = { "Text" }  
                }  
            }  
        }  
    };  

    wfApp.Extensions.Add(stp);  

    // Workflow lifecycle handlers...

Para exibir as informações de rastreamento

Clique com o botão direito em WorkflowHostForm no Gerenciador de Soluções e escolha Exibir código.

No manipulador InstanceId_SelectedIndexChanged, adicione o seguinte código imediatamente depois do código que limpa a janela de status.

'If there is tracking data for this workflow, display it  
'in the status window.  
If File.Exists(WorkflowInstanceId.ToString()) Then  
    Dim status As String = File.ReadAllText(WorkflowInstanceId.ToString())  
    UpdateStatus(status)  
End If

// If there is tracking data for this workflow, display it  
// in the status window.  
if (File.Exists(WorkflowInstanceId.ToString()))  
{  
    string status = File.ReadAllText(WorkflowInstanceId.ToString());  
    UpdateStatus(status);  
}

Quando um novo fluxo de trabalho é selecionado na lista de fluxo de trabalho, os registros de rastreamento para esse fluxo de trabalho são carregados e exibidos na janela de status. O exemplo a seguir é o manipulador InstanceId_SelectedIndexChanged concluído.

Private Sub InstanceId_SelectedIndexChanged(sender As Object, e As EventArgs) Handles InstanceId.SelectedIndexChanged  
    If InstanceId.SelectedIndex = -1 Then  
        Return  
    End If  

    'Clear the status window.  
    WorkflowStatus.Clear()  

    'If there is tracking data for this workflow, display it  
    'in the status window.  
    If File.Exists(WorkflowInstanceId.ToString()) Then  
        Dim status As String = File.ReadAllText(WorkflowInstanceId.ToString())  
        UpdateStatus(status)  
    End If  

    'Get the workflow version and display it.  
    'If the workflow is just starting then this info will not  
    'be available in the persistence store so do not try and retrieve it.  
    If Not WorkflowStarting Then  
        Dim instance As WorkflowApplicationInstance = _  
            WorkflowApplication.GetInstance(WorkflowInstanceId, store)  

        WorkflowVersion.Text = _  
            WorkflowVersionMap.GetIdentityDescription(instance.DefinitionIdentity)  

        'Unload the instance.  
        instance.Abandon()  
    End If  
End Sub

private void InstanceId_SelectedIndexChanged(object sender, EventArgs e)  
{  
    if (InstanceId.SelectedIndex == -1)  
    {  
        return;  
    }  

    // Clear the status window.  
    WorkflowStatus.Clear();  

    // If there is tracking data for this workflow, display it  
    // in the status window.  
    if (File.Exists(WorkflowInstanceId.ToString()))  
    {  
        string status = File.ReadAllText(WorkflowInstanceId.ToString());  
        UpdateStatus(status);  
    }  

    // Get the workflow version and display it.  
    // If the workflow is just starting then this info will not  
    // be available in the persistence store so do not try and retrieve it.  
    if (!WorkflowStarting)  
    {  
        WorkflowApplicationInstance instance =  
            WorkflowApplication.GetInstance(this.WorkflowInstanceId, store);  

        WorkflowVersion.Text =  
            WorkflowVersionMap.GetIdentityDescription(instance.DefinitionIdentity);  

        // Unload the instance.  
        instance.Abandon();  
    }  
}

Para criar e executar o aplicativo

Pressione Ctrl+Shift+B para criar o aplicativo.
Pressione Ctrl+F5 para iniciar o aplicativo.
Selecione um intervalo para o palpite e o tipo de fluxo de trabalho para iniciar, e clique em Novo Jogo. Insira um palpite na caixa Dar Palpite e clique em Ir para enviar seu palpite. Observe que o status do fluxo de trabalho é exibido na janela de status. Essa saída é capturada das atividades WriteLine. Alterne para um fluxo de trabalho diferente selecionando um da caixa de combinação ID de Instância de Fluxo de Trabalho e observe que o status do fluxo de trabalho atual é removido. Alterne novamente para o fluxo de trabalho e observe que o status é restaurado, semelhante ao exemplo a seguir.

Observação

Se você alternar para um fluxo de trabalho que foi iniciado antes que o rastreamento foi habilitado, nenhum status será exibido. No entanto, se você fizer previsões adicionais, seu status será salvo porque o rastreamento agora estará habilitado.
```
Please enter a number between 1 and 10
Your guess is too high.
Please enter a number between 1 and 10
```
Observação

Essas informações são úteis para determinar o intervalo do número aleatório, mas ele não contém informações sobre os palpites que já foram feitos anteriormente. Essas informações estão na próxima etapa, Como hospedar várias versões de um fluxo de trabalho lado a lado.

Faça uma anotação da ID de instância de fluxo de trabalho e jogue até o final.
Abra o Windows Explorer e navegue até a pasta NumberGuessWorkflowHost\bin\debug (ou bin\release dependendo das configurações do projeto). Observe que, além dos arquivos executáveis de projeto, há arquivos com nomes de arquivo de GUID. Identifique o que corresponde à ID da instância do fluxo de trabalho concluído na etapa anterior e abra-o no Bloco De Notas. As informações de rastreamento contêm informações semelhantes ao seguinte.
```
Please enter a number between 1 and 10
Your guess is too high.
Please enter a number between 1 and 10
Your guess is too high.
Please enter a number between 1 and 10
```
Além da ausência de palpites do usuário, esses dados de rastreamento não contêm informações sobre o palpite final do fluxo de trabalho. Isso ocorre porque as informações de rastreamento consistem apenas na saída de WriteLine do fluxo de trabalho, e a mensagem final que é exibida é feita a partir do manipulador Completed depois que o fluxo de trabalho é concluído. Na próxima etapa do tutorial, Como hospedar várias versões de um fluxo de trabalho lado a lado, as atividades WriteLine existentes são alteradas para exibir as previsões do usuário e uma outra atividade WriteLine, que exibe os resultados finais, é adicionada. Depois que essas alterações são integradas, Como hospedar várias versões de um fluxo de trabalho lado a lado demonstra como hospedar várias versões de um fluxo de trabalho ao mesmo tempo.

Compartilhar via

Como: criar um participante de acompanhamento personalizado

Para criar o participante de rastreamento personalizado

Para criar o perfil de rastreamento e registrar o participante do rastreamento

Para exibir as informações de rastreamento

Para criar e executar o aplicativo

Recursos adicionais