File: README.md

package info (click to toggle)
python-azure 20230112%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 749,544 kB
  • sloc: python: 6,815,827; javascript: 287; makefile: 195; xml: 109; sh: 105
file content (53 lines) | stat: -rw-r--r-- 2,290 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# Monitor Ingestion performance tests

In order to run the performance tests, the `azure-devtools` package must be installed. This is done as part of the `dev_requirements`.
Start by creating a new virtual environment for your perf tests. This will need to be a Python 3 environment, preferably >=3.7.

### Setup for test resources

These tests will run against a pre-configured Log Analytics workspace. The `test-resources.json` file can be used to provision the needed resources. The following environment variables will need to be set for the tests to access the live resources:
```
AZURE_MONITOR_DCR_ID=<The ID of the data collection rule>
AZURE_MONITOR_DCE=<The data collection endpoint to upload logs to>
AZURE_MONITOR_STREAM_NAME=<The data collection stream name>
```

### Setup for perf test runs

```cmd
(env) ~/azure-monitor-ingestion> pip install -r dev_requirements.txt
(env) ~/azure-monitor-ingestion> pip install -e .
```

## Test commands

```cmd
(env) ~/azure-monitor-ingestion> perfstress
```

### Common perf command line options

These options are available for all perf tests:
- `--duration=10` Number of seconds to run as many operations (the "run" function) as possible. Default is 10.
- `--iterations=1` Number of test iterations to run. Default is 1.
- `--parallel=1` Number of tests to run in parallel. Default is 1.
- `--warm-up=5` Number of seconds to spend warming up the connection before measuring begins. Default is 5.
- `--sync` Whether to run the tests in sync or async. Default is False (async).
- `--no-cleanup` Whether to keep newly created resources after test run. Default is False (resources will be deleted).
- `--profile` Whether to run the perftest with cProfile. If enabled (default is False), the output file of a single iteration will be written to the current working directory in the format `"cProfile-<TestClassName>-<TestID>-<sync|async>.pstats"`.

### Ingestion test options

These options are available for all ingestion perf tests:
- `-n`, `--num-logs` Number of logs to be uploaded. Defaults to 100.

### Available tests

The tests currently written for the T2 SDK:
- `UploadLogsTest` Upload a collection of logs to Azure Monitor

## Example command

```cmd
(env) ~/azure-monitor-ingestion> perfstress UploadLogsTest --num-logs=1000
```