|
| 1 | +--- |
| 2 | +title: Azure Communication Services Closed Captions logs |
| 3 | +titleSuffix: An Azure Communication Services concept article |
| 4 | +description: Learn about logging for Azure Communication Services Closed captions. |
| 5 | +author: Kunaal |
| 6 | +services: azure-communication-services |
| 7 | +ms.author: kpunjabi |
| 8 | +ms.date: 02/06/2024 |
| 9 | +ms.topic: conceptual |
| 10 | +ms.service: azure-communication-services |
| 11 | +ms.subservice: data |
| 12 | +--- |
| 13 | + |
| 14 | +# Azure Communication Services Closed Captions logs |
| 15 | + |
| 16 | +Azure Communication Services offers logging capabilities that you can use to monitor and debug your Communication Services solution. You configure these capabilities through the Azure portal. |
| 17 | + |
| 18 | +The content in this article refers to logs enabled through [Azure Monitor](../../../../azure-monitor/overview.md) (see also [FAQ](../../../../azure-monitor/overview.md#frequently-asked-questions)). To enable these logs for Communication Services, see [Enable logging in diagnostic settings](../enable-logging.md). |
| 19 | + |
| 20 | +## Usage log schema |
| 21 | + |
| 22 | +| Property | Description | |
| 23 | +| --- | --- | |
| 24 | +| TimeGenerated | The timestamp (UTC) of when the log was generated. | |
| 25 | +| OperationName | The operation associated with log record. ClosedCaptionsSummary | |
| 26 | +| Type | The log category of the event. Logs with the same log category and resource type have the same property fields. ACSCallClosedCaptionsSummary | |
| 27 | +| Level | The severity level of the operation. Informational | |
| 28 | +| CorrelationId | The ID for correlated events. Can be used to identify correlated events between multiple tables. | |
| 29 | +| ResourceId | The ID of Azure ACS resource to which a call with closed captions belongs | |
| 30 | +| ResultType | The status of the operation. | |
| 31 | +| SpeechRecognitionSessionId | The ID given to the closed captions this log refers to. | |
| 32 | +| SpokenLanguage | The spoken language of the closed captions. | |
| 33 | +| EndReason | The reason why the closed captions ended. | |
| 34 | +| CancelReason | The reason why the closed captions cancelled. | |
| 35 | +| StartTime | The time that the closed captions started. | |
| 36 | +| Duration | Duration of the closed captions in seconds. | |
| 37 | + |
| 38 | +Here's an example of a closed caption summary log: |
| 39 | + |
| 40 | +```json |
| 41 | +{ |
| 42 | + "TimeGenerated": "2023-11-14T23:18:26.4332392Z", |
| 43 | + "OperationName": "ClosedCaptionsSummary", |
| 44 | + "Category": "ACSCallClosedCaptionsSummary", |
| 45 | + "Level": "Informational", |
| 46 | + "CorrelationId": "336a0049-d98f-48ca-8b21-d39244c34486", |
| 47 | + "ResourceId": "d2241234-bbbb-4321-b789-cfff3f4a6666", |
| 48 | + "ResultType": "Succeeded", |
| 49 | + "SpeechRecognitionSessionId": "eyJQbGF0Zm9ybUVuZHBvaW50SWQiOiI0MDFmNmUwMC01MWQyLTQ0YjAtODAyZi03N2RlNTA2YTI3NGYiLCJffffffXJjZVNwZWNpZmljSWQiOiIzOTc0NmE1Ny1lNzBkLTRhMTctYTI2Yi1hM2MzZTEwNTk0Mwwwww", |
| 50 | + "SpokenLanguage": "cn-zh", |
| 51 | + "EndReason": "Stopped", |
| 52 | + "CancelReason": "", |
| 53 | + "StartTime": "2023-11-14T03:04:05.123Z", |
| 54 | + "Duration": "666.66" |
| 55 | +} |
| 56 | +``` |
0 commit comments