Skip to content

Commit 4973dbf

Browse files
authored
Update real-time-inspection.md
1 parent 0970f1a commit 4973dbf

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

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

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,89 +11,89 @@ ms.topic: conceptual
1111
ms.service: azure-communication-services
1212
---
1313

14-
# Communications Inspector
14+
# Real-time Inspection Tool for Azure Communication Services
1515

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

18-
The Communications Inspector enables Azure Communication Services developers to inspect the state of the `Call` to debug or monitor their solution. When building a solution, developers 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 Inspector 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 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`.
1919

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

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

2727
| Category | Descriptions |
2828
|--------------------------------|-----------------------------------|
2929
| General Call Information | Includes call id, participants, devices and user agent information (browser, version, etc.) |
30-
| Media Quality Stats | Metrics and statistics provided by [Media Quality APIs](../voice-video-calling/media-quality-sdk.md). Metrics are clickable for timeseries view.|
30+
| Media Quality Stats | Metrics and statistics provided by [Media Quality APIs](../voice-video-calling/media-quality-sdk.md). Metrics are clickable for time series view.|
3131
| User Facing Diagnostics | List of [user facing diagnostics](../voice-video-calling/user-facing-diagnostics.md).|
3232

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

35-
Communications Inspector 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+
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).
3636

37-
## Get started with Communications Inspector
37+
## Get started with Real-time Inspection Tool
3838

39-
The tool can be accessed through an npm package `azure/communication-tools`. There developers can find the `CommunicationsInspector` 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-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.
4040

41-
### Installing Communications Inspector
41+
### Installing Real-time Inspection Tool
4242

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

47-
### Initialize Communications Inspector
47+
### Initialize Real-time Inspection Tool
4848

4949
```javascript
5050
import { CallClient, CallAgent } from "@azure/communication-calling";
51-
import { CommunicationsInspector } from "@azure/communication-tools";
51+
import { InspectionTool } from "@azure/communication-tools";
5252

5353
const callClient = new callClient();
5454
const callAgent = await callClient.createCallAgent({INSERT TOKEN CREDENTIAL});
5555
const call = callAgent.startCall({INSERT CALL INFORMATION});
5656

57-
const communicationsInspector = new CommunicationsInspector(call, {HTMLDivElement});
57+
const inspectionTool = new InspectionTool(call, {HTMLDivElement});
5858

5959
```
6060
## Usage
6161

62-
`start`: enable the `CommunicationsInspector` to start reading data from the call object and storing it locally for visualization.
62+
`start`: enable the `InspectionTool` to start reading data from the call object and storing it locally for visualization.
6363

6464
```javascript
6565

66-
CommunicationsInspector.start()
66+
inspectionTool.start()
6767

6868
```
6969

70-
`stop`: disable the `CommunicationsInspector` from reading data from the call object.
70+
`stop`: disable the `InspectionTool` from reading data from the call object.
7171

7272
```javascript
7373

74-
CommunicationsInspector.stop()
74+
inspectionTool.stop()
7575

7676
```
7777

78-
`open`: Open the `CommunicationsInspector` in the UI.
78+
`open`: Open the `InspectionTool` in the UI.
7979

8080
```javascript
8181

82-
CommunicationsInspector.open()
82+
inspectionTool.open()
8383

8484
```
8585

86-
`close`: Dismiss the `CommunicationsInspector` in the UI.
86+
`close`: Dismiss the `InspectionTool` in the UI.
8787

8888
```javascript
8989

90-
CommunicationsInspector.close()
90+
inspectionTool.close()
9191

9292
```
9393

9494
## Next Steps
9595

9696
- [Explore User-Facing Diagnostic APIs](../voice-video-calling/user-facing-diagnostics.md)
9797
- [Enable Media Quality Statistics in your application](../voice-video-calling/media-quality-sdk.md)
98-
- [Levearge Network Diagnostic Tool](./network-diagnostic.md)
98+
- [Leverage Network Diagnostic Tool](./network-diagnostic.md)
9999
- [Consume call logs with Azure Monitor](../analytics/call-logs-azure-monitor.md)

0 commit comments

Comments
 (0)