Skip to content

Commit d708b0b

Browse files
authored
Merge pull request #198567 from Gemakk/patch-1
Update real-time-inspection.md
2 parents 7cae31f + 4ba0232 commit d708b0b

File tree

1 file changed

+36
-26
lines changed

1 file changed

+36
-26
lines changed

articles/communication-services/concepts/developer-tools/real-time-inspection.md

Lines changed: 36 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Developer Tools - Real-Time Inspection for Azure Communication Services
3-
description: Conceptual documentation outlining the capabilities provided by the Real-Time Inspection tool.
2+
title: Developer Tools - Azure Communication Services Communication Monitoring
3+
description: Conceptual documentation outlining the capabilities provided by the Communication Monitoring tool.
44
author: ddematheu2
55
manager: chpalm
66
services: azure-communication-services
@@ -11,18 +11,18 @@ ms.topic: conceptual
1111
ms.service: azure-communication-services
1212
---
1313

14-
# Real-time Inspection Tool for Azure Communication Services
14+
# Azure Communication Services communication monitoring
1515

1616
[!INCLUDE [Private Preview Disclaimer](../../includes/private-preview-include-section.md)]
1717

18-
The Real-time Inspection Tool enables Azure Communication Services developers to inspect the state of the `Call` to debug or monitor their solution. For developers building an Azure Communication Services solution, they might need visibility for debugging into general call information such as the `Call ID` or advanced states, such as did a user facing diagnostic fire. The Real-time Inspection Tool provides developers this information and more. It can be easily added to any JavaScript (Web) solution by downloading the npm package `azure/communication-tools`.
18+
The Azure Communication Services communication monitoring tool enables developers to inspect the state of the `Call` to debug or monitor their solution. For developers building an Azure Communication Services solution, they might need visibility for debugging into general call information such as the `Call ID` or advanced states, such as did a user facing diagnostic fire. The communication monitoring tool provides developers this information and more. It can be easily added to any JavaScript (Web) solution by downloading the npm package `@azure/communication-monitoring`.
1919

2020
>[!NOTE]
21-
>Find the open-source repository for the tool [here](https://github.com/Azure/communication-inspection).
21+
>Find the open-source repository for the tool [here](https://github.com/Azure/communication-monitoring).
2222
2323
## Capabilities
2424

25-
The Real-time Inspection Tool provides developers three categories of information that can be used for debugging purposes:
25+
The Communication Monitoring tool provides developers three categories of information that can be used for debugging purposes:
2626

2727
| Category | Descriptions |
2828
|--------------------------------|-----------------------------------|
@@ -32,62 +32,72 @@ The Real-time Inspection Tool provides developers three categories of informatio
3232

3333
Data collected by the tool is only kept locally and temporarily. It can be downloaded from within the interface.
3434

35-
Real-time Inspection Tool is compatible with the same browsers as the Calling SDK [here](../voice-video-calling/calling-sdk-features.md?msclkid=f9cf66e6a6de11ec977ae3f6d266ba8d#javascript-calling-sdk-support-by-os-and-browser).
35+
Communication Monitoring is compatible with the same browsers as the Calling SDK [here](../voice-video-calling/calling-sdk-features.md?msclkid=f9cf66e6a6de11ec977ae3f6d266ba8d#javascript-calling-sdk-support-by-os-and-browser).
3636

37-
## Get started with Real-time Inspection Tool
37+
## Get started with Communication Monitoring
3838

39-
The tool can be accessed through an npm package `azure/communication-inspection`. The package contains the `InspectionTool` object that can be attached to a `Call`. The Call Inspector requires an `HTMLDivElement` as part of its constructor on which it will be rendered. The `HTMLDivElement` will dictate the size of the Call Inspector.
39+
The tool can be accessed through an npm package `@azure/communication-monitoring`. The package contains the `CommunicationMonitoring` object that can be attached to a `Call`. The Call Inspector requires an `HTMLDivElement` as part of its constructor on which it will be rendered. The `HTMLDivElement` will dictate the size of the Call Inspector.
4040

41-
### Installing Real-time Inspection Tool
41+
### Installing Communication Monitoring
4242

4343
```bash
44-
npm i @azure/communication-inspection
44+
npm i @azure/communication-monitoring
4545
```
4646

47-
### Initialize Real-time Inspection Tool
47+
### Initialize Communication Monitoring
4848

4949
```javascript
50-
import { CallClient, CallAgent } from "@azure/communication-calling";
51-
import { InspectionTool } from "@azure/communication-tools";
50+
import { CallAgent, CallClient } from '@azure/communication-calling'
51+
import { CommunicationMonitoring } from '@azure/communication-monitoring'
5252

53-
const callClient = new callClient();
54-
const callAgent = await callClient.createCallAgent({INSERT TOKEN CREDENTIAL});
55-
const call = callAgent.startCall({INSERT CALL INFORMATION});
53+
interface Options {
54+
callClient: CallClient
55+
callAgent: CallAgent
56+
divElement: HTMLDivElement
57+
}
5658

57-
const inspectionTool = new InspectionTool(call, {HTMLDivElement});
59+
const selectedDiv = document.getElementById('selectedDiv')
60+
61+
const options = {
62+
callClient = this.callClient,
63+
callAgent = this.callAgent,
64+
divElement = selectedDiv,
65+
}
66+
67+
const communicationMonitoring = new CommunicationMonitoring(options)
5868

5969
```
6070
## Usage
6171

62-
`start`: enable the `InspectionTool` to start reading data from the call object and storing it locally for visualization.
72+
`start`: enable the `CommunicationMonitoring` instance to start reading data from the call object and storing it locally for visualization.
6373

6474
```javascript
6575

66-
inspectionTool.start()
76+
communicationMonitoring.start()
6777

6878
```
6979

70-
`stop`: disable the `InspectionTool` from reading data from the call object.
80+
`stop`: disable the `CommunicationMonitoring` instance from reading data from the call object.
7181

7282
```javascript
7383

74-
inspectionTool.stop()
84+
communicationMonitoring.stop()
7585

7686
```
7787

78-
`open`: Open the `InspectionTool` in the UI.
88+
`open`: Open the `CommunicationMonitoring` instance in the UI.
7989

8090
```javascript
8191

82-
inspectionTool.open()
92+
communicationMonitoring.open()
8393

8494
```
8595

86-
`close`: Dismiss the `InspectionTool` in the UI.
96+
`close`: Dismiss the `CommunicationMonitoring` instance in the UI.
8797

8898
```javascript
8999

90-
inspectionTool.close()
100+
communicationMonitoring.close()
91101

92102
```
93103

0 commit comments

Comments
 (0)