@microsoft/agents-copilotstudio-client/src/observability/metrics.ts

Microsoft Copilot Studio Client for JavaScript. Copilot Studio Client.

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

import { metric, MetricNames } from '@microsoft/agents-telemetry'

export const CopilotStudioClientMetrics = {
  // Counters
  activitiesReceivedCounter: metric.counter(MetricNames.CSC_ACTIVITIES_RECEIVED, {
    unit: 'activities',
    description: 'Total number of activities received by the Copilot Studio client'
  }),

  activitiesSentCounter: metric.counter(MetricNames.CSC_ACTIVITIES_SENT, {
    unit: 'activities',
    description: 'Total number of activities sent to Copilot Studio'
  }),

  conversationsStartedCounter: metric.counter(MetricNames.CSC_CONVERSATIONS_STARTED, {
    unit: 'conversations',
    description: 'Total number of conversations started with Copilot Studio'
  }),

  webchatConnectionsCounter: metric.counter(MetricNames.CSC_WEBCHAT_CONNECTIONS, {
    unit: 'connections',
    description: 'Total number of webchat connections created with Copilot Studio'
  }),

  requestsCounter: metric.counter(MetricNames.CSC_REQUEST_COUNT, {
    unit: 'requests',
    description: 'Total number of HTTP/SSE requests made to Copilot Studio'
  }),

  requestsErrorCounter: metric.counter(MetricNames.CSC_REQUEST_ERRORS, {
    unit: 'requests',
    description: 'Total number of failed requests to Copilot Studio'
  }),

  executeStreamingCounter: metric.counter(MetricNames.CSC_EXECUTE_STREAMING, {
    unit: 'operations',
    description: 'Total number of execute streaming operations'
  }),

  subscribeAsyncCounter: metric.counter(MetricNames.CSC_SUBSCRIBE_ASYNC, {
    unit: 'operations',
    description: 'Total number of subscribeAsync operations'
  }),

  subscribeEventCounter: metric.counter(MetricNames.CSC_SUBSCRIBE_EVENT, {
    unit: 'events',
    description: 'Total number of events received via subscribeAsync'
  }),

  // Duration Histograms
  streamDuration: metric.histogram(MetricNames.CSC_STREAM_DURATION, {
    unit: 'ms',
    description: 'Duration of SSE stream sessions in milliseconds'
  }),

  requestDuration: metric.histogram(MetricNames.CSC_REQUEST_DURATION, {
    unit: 'ms',
    description: 'Duration of requests to Copilot Studio in milliseconds'
  })
}