Tags toevoegen aan orchestraties en activiteiten in Durable Task Scheduler

Tags zijn sleutel-waardeparen die je kunt koppelen aan orkestraties, activiteiten en sub-orkestraties om aangepaste metadata toe te voegen. Gebruik tags om werk te categoriseren en te correleren tijdens de uitvoering. Je kunt ook orkestratietags gebruiken om orchestratie-instanties te bevragen.

U kunt tags toevoegen aan:

• Orchestratie-instanties — wanneer u een nieuwe orchestratie vanuit de client start.
• Activiteiten : wanneer een orchestrator een activiteit plant.
• Suborchestraties — wanneer een orchestrator een onderliggende orchestratie plant.

SDK- en extensieondersteuning

Hoe tags werken

Wanneer je een orkestratie, activiteit of suborkestratie inplant, kun je een woordenboek met sleutel-waardeparen van tekenreeksen meegeven als tags. De Duurzame Taakplanner slaat en toont tags verschillend, afhankelijk van wat je tagt:

• Orkestratietags worden opgeslagen als metadata op de orkestratieinstantie. Tags die je meegeeft bij het aanroepen van een sub-orchestratie, worden als metadata toegevoegd aan de onderliggende orchestratie-instantie. Je kunt deze tags lezen en orkestratie-instanties filteren op tag.
• Activiteitstags worden opgeslagen bij de geplande gebeurtenis van de activiteit in de geschiedenis van de bovenliggende orkestratie. Je kunt ze inzien in de orkestratiegeschiedenis, maar ze zijn niet geïndexeerd of beschikbaar in orchestratietag-queries. Activiteitentags worden ook niet doorgegeven aan de activiteitsfunctie.

Stel tags in wanneer je de orkestratie, activiteit of suborkestratie plant. Je kunt de tags daarna niet meer veranderen.

Stel een aangepaste weergavenaam in

Gebruik de bekende durabletask.displayName tag om een orkestratie, suborkestratie of activiteit een naam te geven die bedoeld is voor mensen die een run bekijken. Wanneer deze tag een niet-lege waarde heeft, toont het dashboard van de Duurzame Taakplanner die waarde waar het anders de geregistreerde naam zou tonen, inclusief de orkestratielijst, flow- en sequentieweergaven en detailpanelen.

De geregistreerde naam wordt niet weggegooid of veranderd. Het blijft beschikbaar in de dashboardtooltip en details, en de aangepaste weergavenaam beïnvloedt niet welke code wordt uitgevoerd. Als de tag ontbreekt of leeg is, toont het dashboard de geregistreerde naam zoals gewoonlijk.

Tags toevoegen aan een orkestratie-instantie

var options = new StartOrchestrationOptions
{
    InstanceId = "order-12345",
    Tags = new Dictionary<string, string>
    {
        { "environment", "production" },
        { "tenant", "contoso" },
    },
};

string instanceId = await client.ScheduleNewOrchestrationInstanceAsync(
    "ProcessOrderOrchestration", input: order, options: options);

const instanceId = await client.scheduleNewOrchestration(
    "ProcessOrderOrchestration",
    order,
    {
        instanceId: "order-12345",
        tags: {
            environment: "production",
            tenant: "contoso",
        },
    }
);

instance_id = client.schedule_new_orchestration(
    "process_order_orchestration",
    input=order,
    instance_id="order-12345",
    tags={
        "environment": "production",
        "tenant": "contoso",
    },
)

NewOrchestrationInstanceOptions options = new NewOrchestrationInstanceOptions()
    .setInstanceId("order-12345")
    .setTags(Map.of(
        "environment", "production",
        "tenant", "contoso"
    ));

String instanceId = client.scheduleNewOrchestrationInstance(
    "ProcessOrderOrchestration", order, options);

Tags toevoegen aan een activiteit

var options = new TaskOptions(tags: new Dictionary<string, string>
{
    { "scheduleId", scheduleId },
});

await context.CallActivityAsync(nameof(CacheClearingActivity), options);

const result: string = yield ctx.callActivity(
    cacheClearingActivity,
    input,
    {
        tags: {
            scheduleId: scheduleId,
        },
    }
);

result = yield ctx.call_activity(
    "cache_clearing_activity",
    input=input_data,
    tags={
        "scheduleId": schedule_id,
    },
)

Tags toevoegen aan een suborchestratie

var options = new SubOrchestrationOptions
{
    Tags = new Dictionary<string, string>
    {
        { "workflowType", "order-processing" },
    },
};

await context.CallSubOrchestratorAsync(
    "ValidateOrderOrchestration", input: order, options: options);

const result = yield ctx.callSubOrchestrator(
    validateOrderOrchestration,
    order,
    {
        tags: {
            workflowType: "order-processing",
        },
    }
);

Lees orkestratietags

OrchestrationMetadata? instance = await client.GetInstanceAsync(instanceId);

if (instance is not null)
{
    foreach (KeyValuePair<string, string> tag in instance.Tags)
    {
        Console.WriteLine($"{tag.Key} = {tag.Value}");
    }
}

const state = await client.getOrchestrationState(instanceId);

if (state) {
    for (const [key, value] of Object.entries(state.tags)) {
        console.log(`${key} = ${value}`);
    }
}

OrchestrationMetadata metadata = client.getInstanceMetadata(instanceId, false);

if (metadata != null) {
    Map<String, String> tags = metadata.getTags();
    for (Map.Entry<String, String> tag : tags.entrySet()) {
        System.out.println(tag.getKey() + " = " + tag.getValue());
    }
}

Zoektags

Gebruik in het dashboard van de Duurzame Taakplanner het Tagfilter om orkestratie-instanties te filteren op orkestratietag. Het filter komt overeen met de tagsleutel of -waarde. De orkestratielijst toont ook orkestratietags als kolom.

Activiteitstags worden weergegeven in de geplande gebeurtenis van de activiteit in de geschiedenis van de orkestratie. Ze zijn niet opgenomen in het Tagfilter van de orkestratielijst.

Richtlijnen voor tags

• Gebruik consistente toetsen — Volg een naamgevingsconventie zodat je orkestratie-instanties betrouwbaar kunt filteren en activiteiten kunt corlateren.
• Houd tags zinvol : gebruik waarden die context bieden.
• Tekenreekswaarden gebruiken : sleutels en waarden zijn tekenreeksen.
• Mind-orkestratietaggrootte — Het complete JSON-geserialiseerde orkestratietagwoordenboek kan tot 1.000 bytes zijn. Deze limiet omvat alle sleutels en waarden, en UTF-8-tekens van meerdere bytes tellen voor elk meer dan één byte. Activiteitentags gebruiken deze limiet voor orkestratie-instantiemetadata niet, maar dragen wel bij aan de omvang van de orkestratiegeschiedenis.

Limitations

• Tags kunnen niet meer worden gewijzigd nadat de orkestratie, activiteit of sub-orkestratie is ingepland.
• Tagsleutels en -waarden zijn tekenreeksen.
• Je kunt activiteitstags inspecteren in de orkestratiegeschiedenis, maar je kunt ze niet opvragen. Je kunt ze ook niet doorgeven aan activiteitsfuncties.

Volgende stappen 

• Ontwikkelen met Durable Task Scheduler
• Orkestratiegegevens automatisch verwijderen
• Geschiedenis van orkestratie exporteren