Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add readme about ApplicationInsights logging #3554

Merged
merged 3 commits into from
Jul 18, 2024
Merged

Add readme about ApplicationInsights logging #3554

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2152d9a
Add readme about logging
nick863 Jul 17, 2024
081a85b
Fixes
nick863 Jul 17, 2024
8670280
Merge branch 'main' of https://github.com/microsoft/promptflow into n…
nick863 Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions src/promptflow-evals/tests/evals/e2etests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# E2E tests logging to the application insights.
For the regression tracking we are recording test run times and estimate the installation times of promptflow-evals wheel with and without `azure` optional dependency. The table below summarizes the events we are logging.

## Events
| Event | Description | Logging value | Is recorded |
|-------|-------------|---------------|-------------|
| install_promptflow_no_extras | Installation time of the packages without Azure | The number of packages installed and installation time in seconds | N/A |
| install_promptflow_with_extras | Installation time of the packages with Azure | The number of packages installed and installation time in seconds | N/A |
nick863 marked this conversation as resolved.
Show resolved Hide resolved
| run_e2e_tests_local | Run time tests marked as `localtest`\*. Each test is being logged as `TestClass::test_name`. | The test run time in seconds | Yes |
| run_e2e_tests_azure | Run time tests marked as `azuretest`\*. Each test is being logged as `TestClass::test_name`. These tests write tracking information to Azure. | The test run time in seconds | Yes |
| performance_tests | Run tests marked as `performance_test` Each test is being logged as `TestClass::test_name`. These tests write tracking information to Azure. | The test run time in seconds | No |

\* `localtest` is used to mark the whole class, while `azuretest` can be used to only mark tests that need `promptflow-azure` package. `performance_test` tests can mark both class and the method of class. It is not excluive with `localtest` or `azuretest`.

## Sample query
The next query demonstrates the selection of installation times of promptflow-evals without additional dependencies for time after 2024-07-02 and plotting averges for different dates and operation systems. [Application insights, used for logging](https://ms.portal.azure.com/#@microsoft.onmicrosoft.com/resource/subscriptions/96aede12-2f73-41cb-b983-6d11a904839b/resourceGroups/promptflow-sdk/providers/microsoft.insights/components/promptflow-sdk/overview).

nick863 marked this conversation as resolved.
Show resolved Hide resolved
```
let date_of_run=datetime("2024-07-02");
let event='install_promptflow_no_extras';
customEvents
| where timestamp > date_of_run
| where name == event
| extend parsed = parse_json(customDimensions)
| project
name,
run_date=format_datetime(timestamp, 'yyyy-MM-dd'),
metric = parsed['activity_name'],
OS = strcat(parsed["OS"], "_", parsed["OS_release"]),
python_version = tostring(parsed['python_version']),
install_time_s=todecimal(parsed["install_time_s"])
| summarize install_time_s = avg(install_time_s) by run_date, OS //python_version, stdev=stdev(value)
nick863 marked this conversation as resolved.
Show resolved Hide resolved
| order by run_date asc
| render columnchart with(
kind=unstacked
)
```
Loading