Skip to content

Commit

Permalink
Merge pull request #104 from xiaomi7732/dev/saars/2.2.0-beta2
Browse files Browse the repository at this point in the history 
Update documents for 2.2.0-beta2
  • Loading branch information
@xiaomi7732
xiaomi7732 authored Oct 13, 2020
2 parents 67f7cf5 + 0f1e8e3 commit 9370588
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 20 deletions.
29 changes: 15 additions & 14 deletions Configurations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,20 +50,21 @@ All other ways document here: [Configuration in ASP.NET Core](https://docs.micro

Here lists all supported configurations.

| Key | Value/Types | Default Value | Description | |
|-----------------------------------|-------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| BufferSizeInMB | Integer | 250 | Circular Buffer size. For 2 minutes session, it usually generates less than 200MB traces. Reduce the size for saving resources, increase the size for longer sessions. | |
| Duration | TimeSpan | 00:02:00 | The duration of a session. | |
| InitialDelay | TimeSpan | 00:00:00 | Delay before starting the very first session after the application starts up. | |
| ConfigurationUpdateFrequency | TimeSpan | 00:00:05 | The frequency for configuration updates for triggers or on demand profiling. This configuration decides how frequent the agent pulls configurations from the server. Optional, default value is 5 seconds | |
| ProvideAnonymousTelemetry | Boolean | true | Sends anonymous telemetry data to Microsoft to make the product better when sets to true. | |
| RandomProfilingOverhead | Float | 0.05 | The overhead for random profiling. The rate, in form of percentage, is used to calculate the time of profiling in average per hour. Basically, n = (60 * overhead rate) / profiling-duration. Default value is 0.05. | |
| IsDisabled | Boolean | false | Kill switch to turn off Profiler. | |
| IsSkipCompatibilityTest | Boolean | false | Bypass the check of platform compatibility testing to turn Profiler on by force. This is introduced mainly for internal use for evaluation and might cause unexpected result. | |
| SkipUpload | Boolean | false | Skip uploading the traces to the back-end. Notice: Skipping uploading will always preserve the trace file. | |
| PreserveTraceFile | Boolean | false | The trace file will be deleted once uploaded by default. Set this to true when you want to keep the local trace files. | |
| SkipEndpointCertificateValidation | Boolean | false | The value to skip the certificate validation to establish SSL communication with the Endpoint. It is **strongly recommended** to keep this the default value. | |
| LocalCacheFolder | String | User's temp folder. | Path to the folder for temporary working files, traces for example. The default value is the temp folder depends on the OS. `/tmp/` on linux for example, or `%UserProfile%\temp\` on Windows. Set the value to overwrite it if the default folder happens to be read-only. This setting only available for 2.1.0-beta6 or above. | |
| Key | Value/Types | Default Value | Description |
|-----------------------------------|-------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| BufferSizeInMB | Integer | 250 | Circular Buffer size. For 2 minutes session, it usually generates less than 200MB traces. Reduce the size for saving resources, increase the size for longer sessions. |
| Duration | TimeSpan | 00:02:00 | The duration of a session. |
| InitialDelay | TimeSpan | 00:00:00 | Delay before starting the very first session after the application starts up. |
| ConfigurationUpdateFrequency | TimeSpan | 00:00:05 | The frequency for configuration updates for triggers or on demand profiling. This configuration decides how frequent the agent pulls configurations from the server. Optional, default value is 5 seconds |
| ProvideAnonymousTelemetry | Boolean | true | Sends anonymous telemetry data to Microsoft to make the product better when sets to true. |
| RandomProfilingOverhead | Float | 0.05 | The overhead for random profiling. The rate, in form of percentage, is used to calculate the time of profiling in average per hour. Basically, n = (60 * overhead rate) / profiling-duration. Default value is 0.05. |
| LocalCacheFolder | String | User's temp folder. | Path to the folder for temporary working files, traces for example. The default value is the temp folder depends on the OS. `/tmp/` on linux for example, or `%UserProfile%\temp\` on Windows. Set the value to overwrite it if the default folder happens to be read-only. This setting only available for 2.1.0-beta6 or above. |
| UploadMode | Enum | OnSuccess | Valid values are: `Never`, `OnSuccess` or `Always`. Only set this value when you have a special need to either skip upload the trace or always upload the trace without trace validation. That is only intended to happen for debugging purpose. |
| SkipUpload | Boolean | false | Deprecated in v2.2.0-beta2. Please use `UploadMode` instead. Skip uploading the traces to the back-end. Notice: Skipping uploading will always preserve the trace file. |
| IsDisabled | Boolean | false | Kill switch to turn off Profiler. |
| IsSkipCompatibilityTest | Boolean | false | Bypass the check of platform compatibility testing to turn Profiler on by force. This is introduced mainly for internal use for evaluation and might cause unexpected result. |
| PreserveTraceFile | Boolean | false | The trace file will be deleted once uploaded by default. Set this to true when you want to keep the local trace files. |
| SkipEndpointCertificateValidation | Boolean | false | The value to skip the certificate validation to establish SSL communication with the Endpoint. It is **strongly recommended** to keep this the default value. |

## Sets the logging level for Profiler

Expand Down
11 changes: 6 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

## Announcement

* Profiler 2.2.0-beta1 is published. Please find the NuGet package here: [2.2.0-beta1](https://www.nuget.org/packages/Microsoft.ApplicationInsights.Profiler.AspNetCore/2.2.0-beta1).
* Fixed profiler failing for deploy to Azure WebSite on Windows due to permissions to fetch performance counters (#93).
* Switch to new API to control profiling start/stop.
* Profiler 2.2.0-beta2 is published. Please find the NuGet package here: [2.2.0-beta2](https://www.nuget.org/packages/Microsoft.ApplicationInsights.Profiler.AspNetCore/2.2.0-beta2).
* Fix the bug that blocks the Profiler to work with Microsoft.ApplicationInsights.AspNetCore 2.15.
* Some other small bug fixes.

## Previous announcements

* Profiler 2.1.0-beta5 is published. Please find the NuGet package here: [2.1.0-beta5](https://www.nuget.org/packages/Microsoft.ApplicationInsights.Profiler.AspNetCore/2.1.0-beta5).
* Allows overwrite for default working folder by setting `LocalCacheFolder`. Refer to [Configuration](./Configurations.md) for details.
* Profiler 2.2.0-beta1 is published. Please find the NuGet package here: [2.2.0-beta1](https://www.nuget.org/packages/Microsoft.ApplicationInsights.Profiler.AspNetCore/2.2.0-beta1).
* Fixed profiler failing for deploy to Azure WebSite on Windows due to permissions to fetch performance counters (#93).
* Switch to new API to control profiling start/stop.

## Description

Expand Down
17 changes: 16 additions & 1 deletion ReleaseNote.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,28 @@
# Release Note

## 2.2.0-beta2

* NuGet package: [2.2.0-beta2](https://www.nuget.org/packages/Microsoft.ApplicationInsights.Profiler.AspNetCore/2.2.0-beta2).
* Fix the bug that blocks the Profiler to work with Microsoft.ApplicationInsights.AspNetCore 2.15.
* Some other small bug fixes.

## 2.2.0-beta1

* NuGet package: [2.2.0-beta1](https://www.nuget.org/packages/Microsoft.ApplicationInsights.Profiler.AspNetCore/2.2.0-beta1).
* Fixed profiler failing for deploy to Azure WebSite on Windows due to permissions to fetch performance counters (#93).
* Switch to new API to control profiling start/stop.

## v1.0.0-beta1

Profiling the application and the services and monitoring the performance by using Application Insights Profiler. Beta1 is now available for testing on ASP.NET Core 2.0 Web Apps hosted in the Linux on Microsoft Azure App Services. Follow the `Get Started Guide [Coming soon]`, [Get the packages now](https://www.nuget.org/packages/Microsoft.ApplicationInsights.Profiler.AspNetCore/1.0.0-beta1) and start your performance improvement adventures!

### Features

* Profiling the performance of the ASP.NET Core 2.0 Web Application on Linux.
* Trace/calling tree analysis.

### Known issues

* Enable button in Profiler Configuration pane does not work

**If you host your app using App Services Linux, you do not need to enable Profiler again in the Performance pane in App Insights portal. Including NuGet package in project and setting App Insights iKey in App Settings are sufficient to enable Profiler**
Expand All @@ -15,5 +31,4 @@ We are working on resolving this issue in the enablement experience.

![You don't need to enable the Profiler again in performance pane to make profiler work on Linux App Services](https://raw.githubusercontent.com/Microsoft/ApplicationInsights-Profiler-AspNetCore/master/media/issue-enable-profiler.PNG)


**[Feedbacks are welcome!](https://github.com/Microsoft/ApplicationInsights-Profiler-AspNetCore/issues)**

0 comments on commit 9370588

Please sign in to comment.