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.

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

Smoothed Average View Documentation #999

Merged
merged 3 commits into from
Feb 12, 2021

Conversation

Patrick-Eichhorn
Copy link
Contributor

@Patrick-Eichhorn Patrick-Eichhorn commented Feb 10, 2021

This change is Reviewable

Copy link
Member

@mariusoe mariusoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 3 of 3 files at r1.
Reviewable status: all files reviewed, 7 unresolved discussions (waiting on @Patrick-Eichhorn)


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md, line 111 at r1 (raw file):

:::

In addition to the [Quantile View](../metrics/custom-metrics#quantile-views), which is already described in the inspectIT Ocelot Java agent configuration, the EUM Server provides a Smoothed Average View.

Normally, we put each sentence in a separate line because it doesn't make a difference for markdown but it is easier to read in the editor.


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md, line 118 at r1 (raw file):

configurations

..metric configuration..


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md, line 141 at r1 (raw file):

load_time/SMOOTHED_AVERAGE]

Can we use a different view name like load_time/smoothed? Imo naming it ..SMOOTHED_AVERAGE looks like that it has to be always named like this.


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md, line 148 at r1 (raw file):

The `loadtime/SMOOTHED_AVERAGE` view has the effect of ordering the

You mean that the smoothed average view type has the following effect, not the view itself, right?


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md, line 148 at r1 (raw file):

The loadtime/SMOOTHED_AVERAGE view has the effect of ordering the values in a 1-minute time window by size and dropping the upper 10 percent before calculating the average.

Can you move this sentence to the previous sentence As an example, the following... or explicitly say that it is related to the previous snipped/example.


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md, line 390 at r1 (raw file):

:::important
The resource timing processing is enabled by default and can be disabled by setting the property `inspectit-eum-server.resource-timing.enabled` to `false.`

Can we move this block right at the beginning of this section - after the "resource Timings" headline?


inspectit-ocelot-documentation/docs/instrumentation/rules.md, line 630 at r1 (raw file):

:::warning Experimental Feature
This feature is currently experimental and can potentially have a high performance impact. We do not recommend using it for production environments yet!

This note is already at the beginning of the section :)

Copy link
Contributor Author

@Patrick-Eichhorn Patrick-Eichhorn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: all files reviewed, 7 unresolved discussions (waiting on @mariusoe)


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md, line 111 at r1 (raw file):

Previously, mariusoe (Marius Oehler) wrote…

Normally, we put each sentence in a separate line because it doesn't make a difference for markdown but it is easier to read in the editor.

Done.


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md, line 118 at r1 (raw file):

Previously, mariusoe (Marius Oehler) wrote…
configurations

..metric configuration..

Done.


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md, line 141 at r1 (raw file):

Previously, mariusoe (Marius Oehler) wrote…
load_time/SMOOTHED_AVERAGE]

Can we use a different view name like load_time/smoothed? Imo naming it ..SMOOTHED_AVERAGE looks like that it has to be always named like this.

Done.


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md, line 148 at r1 (raw file):

Previously, mariusoe (Marius Oehler) wrote…
The `loadtime/SMOOTHED_AVERAGE` view has the effect of ordering the

You mean that the smoothed average view type has the following effect, not the view itself, right?

Done.


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md, line 148 at r1 (raw file):

Previously, mariusoe (Marius Oehler) wrote…

Can you move this sentence to the previous sentence As an example, the following... or explicitly say that it is related to the previous snipped/example.

Done.


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md, line 390 at r1 (raw file):

Previously, mariusoe (Marius Oehler) wrote…

Can we move this block right at the beginning of this section - after the "resource Timings" headline?

Done.


inspectit-ocelot-documentation/docs/instrumentation/rules.md, line 630 at r1 (raw file):

Previously, mariusoe (Marius Oehler) wrote…

This note is already at the beginning of the section :)

Done.

Copy link
Member

@mariusoe mariusoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 2 of 2 files at r2.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

@Patrick-Eichhorn Patrick-Eichhorn merged commit 9470f77 into inspectIT:master Feb 12, 2021
@Patrick-Eichhorn Patrick-Eichhorn deleted the docs/website branch February 12, 2021 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants