microsoft / microsoft/BotFramework-WebChat

Clean up after telemetry event "send-status:change"

Open
#4,638 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area-telemetry external-omnichannel feature-request
Dominant language
HTML
Stars
1.8k
Forks
1.6k
Avg merge
22h 58m
Merged PRs (30d)
2

Description

Is your feature request related to a problem?

After PR #4631 is merged, we have pending clean up things to do.

Describe the suggestion or request in detail

Exporting send-status:change typing

Export this typing out. Need some designs because currently, we don't export any telemetry typings.

type TelemetrySendStatusChangePayload = {
  clientActivityID?: string;
  hasAttachment?: 'true' | 'false';
  key: string;
  prevStatus?: 'sending' | 'send failed' | 'sent';
  status: 'sending' | 'send failed' | 'sent';
  type?: string;
};

Clean up TELEMETRY.md

Add a section to elaborate about the new send-status:change event.

Describe alternatives you have considered

No response

Additional context

Related to #4500 and #4631.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review related PRs #4631 and #4500 first, then locate where telemetry typings are defined and exported. Update the typing for send-status:change and add a dedicated section to TELEMETRY.md; done means the payload type is exported and the event is documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.